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

IAccGroup Interface Reference


Detailed Description

The IAccGroup interface represents a group of buddies.

Public Types

Public Member Functions

Properties


Member Typedef Documentation

typedef enum IAccGroup::AccGroupProp IAccGroup::AccGroupProp

Properties for the Property method.


Member Enumeration Documentation

enum IAccGroup::AccGroupProp

Properties for the Property method.

Enumerator:
AccGroupProp_Session  The IAccSession associated with the IAccGroup [get] IAccSession**
AccGroupProp_Name  The name of the group [get] xp_str* [put] xp_kstr
AccGroupProp_OnlineCount  The number of online buddies in the group [get] xp_s32*
AccGroupProp_Collapsed  Whether the group is collapsed [get] xp_bool* [put] bool
AccGroupProp_Shared  Whether the group is "shared" [get] xp_bool*
AccGroupProp_RecentBuddies  Whether the group is the "recent buddies" group [get] xp_bool*
AccGroupProp_Smart  Whether the group is a smart group [get] xp_bool*
AccGroupProp_ReadOnly  Whether the group is read-only [get] xp_bool*
AccGroupProp_SynchronizedStorageType  If synched with a database, the storage type [get] xp_str* [put] xp_kstr
AccGroupProp_SynchronizedStorageName  If synched with a database, the storage name [get] xp_str* [put] xp_kstr
AccGroupProp_Offline  Whether the group is the offline buddies group [get] xp_bool*


Member Function Documentation

HRESULT IAccGroup::GetBuddyByIndex ( [in] xp_int  position,
[out, retval] IAccUser **  user 
)

Retrieves a specific user by position in the group.

HRESULT IAccGroup::GetBuddyPosition ( [in] IAccUser user,
[out, retval] xp_int position 
)

Get the user position given a user object.

HRESULT IAccGroup::InsertBuddy ( [in] xp_kvariant  user,
[in, defaultvalue(-1)] xp_int  position,
[out, retval, defaultvalue(0)] IAccUser **  userRetval 
)

Inserts a new user in the group. Specify -1 for position to add to the end of the group.

HRESULT IAccGroup::RemoveBuddy ( [in] xp_int  position  ) 

Removes a user from the group.

HRESULT IAccGroup::MoveBuddy ( [in] xp_int  fromPosition,
[in] xp_int  toPosition 
)

Move user from one position in the group to another position.

HRESULT IAccGroup::GetBuddyByName ( [in] xp_kstr  name,
[out, retval] IAccUser **  user 
)

Finds a user by name in the group.


Property Documentation

xp_str IAccGroup::Name [get]

Gets the name of the group.

xp_kstr IAccGroup::Name [set]

Sets the name of the group.

xp_variant IAccGroup::Property( [in] AccGroupProp property) ( [in] AccGroupProp  property  )  [get]

Get a specific property of the group.

xp_kvariant IAccGroup::Property( [in] AccGroupProp property) ( [in] AccGroupProp  property  )  [set]

Set a specific property of the group.

xp_int IAccGroup::BuddyCount [get]

Gets the number of users in the group.


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.