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

IAccImSession Interface Reference

Inherits IAccSecondarySession.


Detailed Description

IAccImSession is used for controlling (D)IM/Chat conversations, for sending messages, and for typing indication.

Public Types

Public Member Functions

Properties


Member Typedef Documentation

typedef enum IAccImSession::AccImSessionType IAccImSession::AccImSessionType

Values for AccImSessionProp_SessionType, SessionTypeProposed.

typedef enum IAccImSession::AccImInputState IAccImSession::AccImInputState

typedef enum IAccImSession::AccRateState IAccImSession::AccRateState

typedef enum IAccImSession::AccImExchange IAccImSession::AccImExchange

typedef enum IAccImSession::AccImSessionProp IAccImSession::AccImSessionProp

Properties for the Property method.


Member Enumeration Documentation

enum IAccImSession::AccImSessionType

Values for AccImSessionProp_SessionType, SessionTypeProposed.

Enumerator:
AccImSessionType_Im 
AccImSessionType_DirectIm 
AccImSessionType_Chat 

enum IAccImSession::AccImInputState

Enumerator:
AccImInputState_None 
AccImInputState_NotEmpty 
AccImInputState_Typing 
AccImInputState_Recording 

enum IAccImSession::AccRateState

Enumerator:
AccRateState_Unknown 
AccRateState_Limit 
AccRateState_Alert 
AccRateState_Clear 

enum IAccImSession::AccImExchange

Enumerator:
AccImExchange_PrivateAutomatic 
AccImExchange_PrivateSecure 
AccImExchange_PrivateNonSecure 

enum IAccImSession::AccImSessionProp

Properties for the Property method.

Enumerator:
AccImSessionProp_SessionType  The type of session (e.g. DIM, Chat) [get] AccImSessionType*
AccImSessionProp_SessionTypeProposed  The new proposed session type [get] AccImSessionType*
AccImSessionProp_ChatExchange  If a chat room session, the exchange value of the chat room (see AccImExchange) [get] xp_s32*
AccImSessionProp_ChatRoomName  If a chat room session, the chat room name [get] xp_str*
AccImSessionProp_ChatRoomFullyQualifiedName  If a chat room session, the chat room name with path, if any [get] xp_str*
AccImSessionProp_ChatInstance  If a chat room session, the particular instance of a given chat room [get] xp_s32*
AccImSessionProp_CanStop  Whether embedded data sent in this session can be stopped cleanly [get] xp_bool*
AccImSessionProp_OutgoingPersonality  The outgoing personality name to be used for the session [get] xp_str* [put] xp_kstr
AccImSessionProp_MaxImLength  Maximum length of IM content, including embedded data and hidden markup [get] xp_s64*
AccImSessionProp_MaxVisibleImLength  Maximum length of IM text, excluding markup [get] xp_s32*
AccImSessionProp_RateState  The rate limit state of a session [get] AccRateState*
AccImSessionProp_PromoteCentralized  Whether a session should move to a server or P2P when Invite is called [get] xp_bool* [put] xp_bool


Member Function Documentation

HRESULT IAccImSession::SendIm ( [in] IAccIm im  ) 

Send an IM to the other attendee(s) in the session. If your app supports "sender-pays" SMS, call SegmentIm first.

HRESULT IAccImSession::SegmentIm ( [in] IAccIm im  ) 

It may be necessary to segment the IM (e.g. for "sender-pays" SMS). After calling SegmentIm(), you can examine AccImProp_Segments and AccImProp_SegmentCharsRemaining to inform the user how much sending this IM will cost them. Do not call this method if you do not plan to display this info to the user, or else the user may not be aware he/she is being charged for sending messages. Note that if segmentation is necessary, your message will result in an error if you did not call this method.

HRESULT IAccImSession::ProposeChange ( [in] AccImSessionType  sessionType  ) 

Propose a session type transition to the other attendees in this session. Note that not all session types support transition at this time.

HRESULT IAccImSession::StopRecv (  ) 

Stop receiving embedded data in the current IM.

HRESULT IAccImSession::StopSend (  ) 

Stop sending embedded data in the current IM.


Property Documentation

xp_variant IAccImSession::Property_( [in] AccImSessionProp property) ( [in] AccImSessionProp  property  )  [get]

DEPRECATED. Use IAccSecondarySession::Property instead. Get a specific property of the session.

xp_kvariant IAccImSession::Property_( [in] AccImSessionProp property) ( [in] AccImSessionProp  property  )  [set]

DEPRECATED. Use IAccSecondarySession::Property instead. Set a specific property of the session.

AccImInputState IAccImSession::InputState [set]

Set the current text input state.


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.