Main Page | Class Hierarchy | Class Members | Global Enums and Constants | Global Entry Points | Related Pages

IAccUser Interface Reference


Detailed Description

The IAccUser interface provides the access to the information about an AIM user. The data for some properties is not immediately available from get_Property because the data must be asynchronously retrieved from the server. For these properties, calling get_Property will return ACC_E_MUST_REQUEST_DATA (unless the data is cached), indicating that you must use RequestProperty In general, unless you know that the data is in cache, RequestProperty should be used for the properties marked as "(request)".

Public Types

Public Member Functions

Properties


Member Typedef Documentation

typedef enum IAccUser::AccUserState IAccUser::AccUserState

Values for AccUserProp_State.

typedef enum IAccUser::AccUserFlags IAccUser::AccUserFlags

Values for AccUserProp_Flags.

typedef enum IAccUser::AccUserProp IAccUser::AccUserProp

Properties for the Property method.


Member Enumeration Documentation

enum IAccUser::AccUserState

Values for AccUserProp_State.

Enumerator:
AccUserState_Unknown 
AccUserState_Offline 
AccUserState_Online 
AccUserState_Idle 
AccUserState_Away 

enum IAccUser::AccUserFlags

Values for AccUserProp_Flags.

Enumerator:
AccUserFlags_Unconfirmed 
AccUserFlags_AOL 
AccUserFlags_InternetFree 
AccUserFlags_ICQ 
AccUserFlags_Wireless 
AccUserFlags_Internal 
AccUserFlags_ImForwarding 
AccUserFlags_Bot 
AccUserFlags_Beast 
AccUserFlags_OneWayForwarding 
AccUserFlags_Official 
AccUserFlags_BuddyMatchDirect 
AccUserFlags_BuddyMatchIndirect 

enum IAccUser::AccUserProp

Properties for the Property method.

Enumerator:
AccUserProp_Session  The IAccSession object for the user, if any [get] IAccSession**
AccUserProp_Name  The AIM name of the user [get] xp_str*
AccUserProp_FriendlyName  The friendly name of the user [get] xp_str* [put] xp_kstr
AccUserProp_State  The state of the user, from AccUserState [get] AccUserState*
AccUserProp_Flags  The flags associated with the user, from AccUserFlags [get] xp_u32*
AccUserProp_Blocked  Whether the user is blocked [get] xp_bool* [put] xp_bool
AccUserProp_Ignored  Whether the user is ignored [get] xp_bool* [put] xp_bool
AccUserProp_OnlineTime  The user's online time, in seconds [get] xp_s32*
AccUserProp_IdleTime  The user's idle time, in seconds [get] xp_s32*
AccUserProp_WarningPercent  The user's warning level [get] xp_s32*
AccUserProp_SmsChargeback  Whether or not sending a SMS message to the user will be charged [get] xp_bool*
AccUserProp_EmailAddress  The user's email address [get] xp_str* [put] xp_kstr
AccUserProp_Note  A locally specified note about the user [get] xp_str* [put] xp_kstr
AccUserProp_Frequency  The user's frequency score [get] xp_double*
AccUserProp_InBuddyList  Whether the user is in the buddy list [get] xp_bool*
AccUserProp_TrustedAsBuddy  Whether the user is a known buddy, i.e. not auto added [get] xp_bool*
AccUserProp_BuddyFeedUpdateTime  Time when user's buddy feed last updated [get] xp_date*
AccUserProp_BuddyFeedViewTime  Time when self last viewed user's buddy feed [get] xp_date* [put] xp_date
AccUserProp_BuddyFeedUrl  URL for displaying buddy feed [get] xp_str*
AccUserProp_Profile  The profile for the user (request) IAccIm**
AccUserProp_AwayMessage  The user's away message (request) IAccIm**
AccUserProp_Capabilities  The user's capabilities UUIDs xp_strs [get] xp_array**
AccUserProp_Certificate  The user's signing certificate (request) [get] IAccCertificate**
AccUserProp_HtmlInfo  The user's aggregated HTML info (request) IAccIm**
AccUserProp_DirEntry  DEPRECATED. The user's directory entry (request) IAccDirEntry**
AccUserProp_BartBase 
AccUserProp_SmallIcon  The user's small icon [get] IAccBartItem**
AccUserProp_BuddyIcon  The user's buddy icon [get] IAccBartItem**
AccUserProp_StatusText  The user's status text [get] IAccBartItem**
AccUserProp_ArriveSound  The user's arrive sound [get] IAccBartItem**
AccUserProp_RichName  The user's rich text name [get] IAccBartItem**
AccUserProp_SuperIcon  The user's super buddy icon [get] IAccBartItem**
AccUserProp_RadioStation  The user's current radio station [get] IAccBartItem**
AccUserProp_SuperIconTrigger  The user's super buddy icon trigger [get] IAccBartItem**
AccUserProp_StatusTextLink  The user's status text link [get] IAccBartItem**
AccUserProp_E911Location  The user's location for E911 support [get] IAccBartItem**
AccUserProp_Location  The user's geographic location [get] IAccBartItem**
AccUserProp_BigIcon  The user's big icon. Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF [get] IAccBartItem**
AccUserProp_StatusTextTimestamp  The unix time when AccUserProp_StatusText last changed. [get] IAccBartItem**
AccUserProp_AvTrack  The user's current A/V track [get] IAccBartItem**
AccUserProp_DepartSound  The user's depart sound [get] IAccBartItem**
AccUserProp_Wallpaper  The user's wallpaper [get] IAccBartItem**
AccUserProp_Badge  The user's badge [get] IAccBartItem**
AccUserProp_FlashWallpaper  AccUserProp_BadgeUrl = AccUserProp_BartBase + 133, The user's flash wallpaper [get] IAccBartItem**
AccUserProp_ImmersiveWallpaper  The user's immersive expression [get] IAccBartItem**
AccUserProp_BartMax 
AccUserProp_MaxFriendlyNameLength  Maximum friendly name length [get] xp_s32*
AccUserProp_MaxEmailAddressLength  Maximum email address length [get] xp_s32*
AccUserProp_MaxNoteLength  Maximum user note length [get] xp_s32*


Member Function Documentation

HRESULT IAccUser::RequestProperty ( [in] AccUserProp  property,
[out, retval] AccTransId pTransId 
)

Generic API to request a specific property of the user. The value is pulled from the local cache, or from the AIM server if necessary. The result will be dispatched through DAccEvents::OnUserRequestPropertyResult.

HRESULT IAccUser::Report ( [in, defaultvalue(0)] xp_vbool  notify,
[in, defaultvalue("")] xp_kstr  reason,
[out, retval] AccTransId pTransId 
)

Report this user to one of the backend systems. If 'notify' is not set, this action will 'warn' the remote user; his/her warning level will increase, he/she will be informed, and the backend may start treating the user differently. If 'notify' is set, this action will report the remote user to AOL's investigative team, who may at a later date take action against the offender's account. A text reason may be included as part of such reports. Only AOL accounts can 'notify'. The result is returned via DAccEvents::OnReportUserResult.


Property Documentation

xp_str IAccUser::Name [get]

Get the name for this user.

xp_variant IAccUser::Groups [get]

Return a list of groups the user is in, if any, as an array of IAccGroups.

xp_variant IAccUser::Property( [in] AccUserProp property) ( [in] AccUserProp  property  )  [get]

Get a specific property of the user.

xp_kvariant IAccUser::Property( [in] AccUserProp property) ( [in] AccUserProp  property  )  [set]

Set a specific property of the user.


Questions? Stop by the AIM SDK Developer Forum
Created Mon Oct 15 18:06:40 2007 for AIM: Developer SDK
© 2007 AOL LLC. All Rights Reserved.