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

IAccSecondarySession Interface Reference

Inherited by IAccAvSession, IAccCustomSession, IAccFileSharingSession, IAccFileXferSession, IAccImSession, and IAccShareBuddiesSession.


Detailed Description

IAccSecondarySession is an abstract class for secondary (Rendezvous) sessions. Interfaces such as IAccImSession, IAccAvSession, etc. inherit from this interface.

Public Types

Public Member Functions

Properties


Member Typedef Documentation

typedef enum IAccSecondarySession::AccSecondarySessionServiceId IAccSecondarySession::AccSecondarySessionServiceId

typedef enum IAccSecondarySession::AccSecondarySessionState IAccSecondarySession::AccSecondarySessionState

typedef enum IAccSecondarySession::AccSecondarySessionProp IAccSecondarySession::AccSecondarySessionProp

Properties for the Property method.


Member Enumeration Documentation

enum IAccSecondarySession::AccSecondarySessionServiceId

Enumerator:
AccSecondarySessionServiceId_Im 
AccSecondarySessionServiceId_AudioVideo 
AccSecondarySessionServiceId_FileXfer 
AccSecondarySessionServiceId_FileSharing 
AccSecondarySessionServiceId_ShareBuddies 
AccSecondarySessionServiceId_Custom 

enum IAccSecondarySession::AccSecondarySessionState

Enumerator:
AccSecondarySessionState_Offline 
AccSecondarySessionState_ReceivedProposal 
AccSecondarySessionState_SentProposal 
AccSecondarySessionState_Connecting 
AccSecondarySessionState_Online 
AccSecondarySessionState_Paused 

enum IAccSecondarySession::AccSecondarySessionProp

Properties for the Property method.

Enumerator:
AccSecondarySessionProp_Session  The IAccSession associated with the SecondarySession [get] IAccSession**
AccSecondarySessionProp_ServiceId  The type of secondary session [get] AccSecondarySessionServiceId*
AccSecondarySessionProp_State  The state of the secondary session [get] AccSecondarySessionState*
AccSecondarySessionProp_SessionState  Alias for AccSecondarySessionProp_State [get] AccSecondarySessionState*
AccSecondarySessionProp_Invitation  The invitation associated with the secondary session [get] xp_str*
AccSecondarySessionProp_Secure  Whether this secondary session is secure [get] xp_bool*
AccSecondarySessionProp_RemoteUserName  The remote user name, if any, of the secondary session [get] xp_str*
AccSecondarySessionProp_Participants  The list of participants in the secondary session IAccParticipants [get] xp_array**
AccSecondarySessionProp_MaxParticipantCount  The maximum number of participants in the secondary session [get] xp_s32*
AccSecondarySessionProp_Invitees  The currently pending invitees to the secondary session xp_strs [get] xp_array**
AccSecondarySessionProp_Name  The name, if any, for the secondary session [get] xp_str*
AccSecondarySessionProp_CreationTime  The creation time of the SecondarySession [get] xp_date*
AccSecondarySessionProp_OnlineTime  The online time of the secondary session, in seconds [get] xp_s32*
AccSecondarySessionProp_RemainingTime  The time remaining before this secondary session ends, in seconds [get] xp_s32*
AccSecondarySessionProp_Id  The unique id assigned to this secondary session; not yet implemented.
AccSecondarySessionProp_LinkedSessions  DEPRECATED IAccSecondarySessions [get] xp_array** [put] xp_array*
AccSecondarySessionProp_Max 


Member Function Documentation

HRESULT IAccSecondarySession::Accept (  ) 

Accept this session proposed by another user.

HRESULT IAccSecondarySession::Reject ( [in, defaultvalue(ACC_E_USER_REJECTED)] xp_int  reason  ) 

Reject this session proposed by another user. "reason" should be an ACC_E_ HRESULT, or omitted.

HRESULT IAccSecondarySession::Invite ( [in] xp_kstr  invitee,
[in] xp_kstr  invitation,
[out, retval] AccTransId pTransId 
)

Invite a user to the session, changing the session type if needed. The result is communicated asynchronously via DAccEvents::OnInviteResult.

HRESULT IAccSecondarySession::CancelProposal ( [in] xp_kstr  invitee  ) 

Withdraw a proposal you sent. For multi-party sessions, if an invitee is not specified, all outgoing proposals for the session are canceled. For peer-to-peer sessions, invitee is ignored.

HRESULT IAccSecondarySession::Eject ( [in] xp_kstr  userName,
[in, defaultvalue("")] xp_kstr  reason,
[out, retval] AccTransId pTransId 
)

Eject the specified user from the session, for the specified reason. "reason" may not be supported in all session types. The result is communicated asynchronously via DAccEvents::OnEjectResult.

HRESULT IAccSecondarySession::EndSession (  ) 

End the current session.


Property Documentation

AccSecondarySessionServiceId IAccSecondarySession::ServiceId [get]

Get the service id of the session.

xp_variant IAccSecondarySession::Property( [in] xp_int property) ( [in] xp_int  property  )  [get]

Get a specific property of the session. "property" can be a AccSecondarySessionProp, or an enum from a child interface.

xp_kvariant IAccSecondarySession::Property( [in] xp_int property) ( [in] xp_int  property  )  [set]

Set a specific property of the session. "property" can be a AccSecondarySessionProp, or an enum from a child interface.


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.