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

IAccBuddyList Interface Reference


Detailed Description

IAccBuddyList maintains the Buddy List information.

Public Types

Public Member Functions

Properties


Member Typedef Documentation

typedef enum IAccBuddyList::AccBuddyListProp IAccBuddyList::AccBuddyListProp

Properties for the Property method.


Member Enumeration Documentation

enum IAccBuddyList::AccBuddyListProp

Properties for the Property method.

Enumerator:
AccBuddyListProp_Session  The IAccSession associated with this buddy list [get] IAccSession**
AccBuddyListProp_MaxGroupCount  The maximum number of groups allowed on the buddy list [get] xp_s32*
AccBuddyListProp_MaxBuddyCount  The maximum number of buddies allowed on the buddy list [get] xp_s32*
AccBuddyListProp_MaxGroupNameLength  The maximum length a group name can be [get] xp_s32*
AccBuddyListProp_MaxBuddyNameLength  The maximum length a buddy name can be [get] xp_s32*
AccBuddyListProp_MaxBuddyCountPerGroup  The maximum number of buddies that can be in a group [get] xp_s32*
AccBuddyListProp_Ready  Determines if state information has been received for all buddies on the buddy list [get] xp_bool*


Member Function Documentation

HRESULT IAccBuddyList::GetGroupByIndex ( [in] xp_int  position,
[out, retval] IAccGroup **  group 
)

Retrieves a specific group by its position in the list.

HRESULT IAccBuddyList::GetGroupPosition ( [in] IAccGroup group,
[out, retval] xp_int position 
)

Get the group position given a group object.

HRESULT IAccBuddyList::InsertGroup ( [in] xp_kvariant  group,
[in, defaultvalue(-1)] xp_int  position,
[out, retval, defaultvalue(0)] IAccGroup **  groupRetval 
)

Inserts a new group to the Buddy List in the given position. Specify -1 for position to add to the end of the list.

HRESULT IAccBuddyList::RemoveGroup ( [in] xp_int  position  ) 

Removes the given group from the Buddy List.

HRESULT IAccBuddyList::MoveGroup ( [in] xp_int  fromPosition,
[in] xp_int  toPosition 
)

Moves the position of the given group in the Buddy List.

HRESULT IAccBuddyList::MoveBuddy ( [in] xp_int  fromGroup,
[in] xp_int  fromPosition,
[in] xp_int  toGroup,
[in] xp_int  toPosition 
)

Moves the position of the given buddy in the Buddy List.

HRESULT IAccBuddyList::GetGroupByName ( [in] xp_kstr  name,
[out, retval] IAccGroup **  group 
)

Finds the group in the Buddy List.

HRESULT IAccBuddyList::GetBuddyByName ( [in] xp_kstr  name,
[out, retval] IAccUser **  buddy 
)

Finds the buddy in the Buddy List.

HRESULT IAccBuddyList::GetFrequentBuddies ( [in, defaultvalue(0)] xp_int  num,
[out, retval] xp_variant sortedBuddies 
)

Gets the "num" most frequent-accessed users, as a list of IAccUsers. If num is 0, a system default is used.


Property Documentation

xp_int IAccBuddyList::GroupCount [get]

Get the number of groups in the buddy list.

xp_variant IAccBuddyList::Property( [in] AccBuddyListProp property) ( [in] AccBuddyListProp  property  )  [get]

Get a specific property of the Buddy List.

xp_kvariant IAccBuddyList::Property( [in] AccBuddyListProp property) ( [in] AccBuddyListProp  property  )  [set]

Set a specific property of the Buddy List.


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