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

DAccEvents Interface Reference

Public Member Functions


Member Function Documentation

HRESULT DAccEvents::OnStateChange ( [in] IAccSession session,
[in] AccSessionState  state,
[in] AccResult  hr 
)

Session Called when the state of a session changes; "state" indicates the new state. "hr" indicates whether the state change was normal, or the result of an error.

HRESULT DAccEvents::OnSessionChange ( [in] IAccSession session,
[in] AccSessionProp  prop 
)

Called when a session property, other than state, changes. "prop" indicates the property that changed.

HRESULT DAccEvents::OnIdleStateChange ( [in] IAccSession session,
[in] xp_int  secondsSinceActivity 
)

Called when a session becomes idle, and when it returns from idle. (Idleness refers to user activity on the computer). When idleness occurs, "secondsSinceActivity" indicates how long it has been since the last user activity.

HRESULT DAccEvents::OnInstanceChange ( [in] IAccSession session,
[in] IAccInstance oldInstance,
[in] IAccInstance newInstance,
[in] AccInstanceProp  prop 
)

Called when a property of another AIM client instance changes. "oldInstance" is an object that represents the previous state of the other AIM instance. "newInstance" is an object that represents the current state of the other AIM instance; "prop" is the property that changed.

HRESULT DAccEvents::OnLookupUsersResult ( [in] IAccSession session,
[in] xp_kvariant  emails,
[in] AccTransId  transId,
[in] AccResult  hr,
[in] xp_kvariant  vUsers 
)

Called when IAccSession::LookupUsers() completes. "emails" is a SAFEARRAY containing string VARIANTS, which were passed into LookupUsers. "transId" is the transaction id returned from LookupUsers. "hr" is the result of the operation. "vUsers" is a SAFEARRAY containing IAccUser VARIANTs, or empty if a failure occurred.

HRESULT DAccEvents::OnSearchDirectoryResult ( [in] IAccSession session,
[in] AccTransId  transId,
[in] AccResult  hr,
[in] xp_kvariant  vResults 
)

Called when IAccSession::SearchDirectory() completes. "transId" is the transaction id returned from SearchDirectory. "hr" is the result of the operation. "vResults" is a SAFEARRAY containing VARIANTs of IDispatch, or empty if a failure occurred.

HRESULT DAccEvents::OnSendInviteMailResult ( [in] IAccSession session,
[in] AccTransId  transId,
[in] AccResult  hr 
)

Called when IAccSession::SendInviteMail() completes. "transId" is the transaction id returned from SendInviteMail. "hr" is the result of the operation.

HRESULT DAccEvents::OnRequestServiceResult ( [in] IAccSession session,
[in] AccTransId  transId,
[in] AccResult  hr,
[in] xp_kstr  host,
[in] xp_int  port,
[in] xp_kvariant  cookie 
)

Called when IAccSession::RequestService() completes. "transId" is the transaction id returned from RequestService. "hr" indicates if the request was successful or not. The contents of "host", "port", and "cookie" may depend on what type of service was requested. "host" may be the hostname of the service server, or an URL, or other useful data. "port" may be the TCP port that should be connected to for the service. "cookie" may be an IAccServiceTicket, or a byte SAFEARRAY containing authorization info for the service, or other useful data, or empty.

HRESULT DAccEvents::OnConfirmAccountResult ( [in] IAccSession session,
[in] AccTransId  transId,
[in] AccResult  hr 
)

Called when IAccSession::ConfirmAccount() completes. "transId" is the transaction id returned from ConfirmAccount. "hr" is the result of the operation.

HRESULT DAccEvents::OnReportUserResult ( [in] IAccSession session,
[in] IAccUser user,
[in] AccTransId  transId,
[in] AccResult  hr,
[in] xp_int  deltaApplied,
[in] xp_int  updatedValue 
)

Called when IAccUser::Report() completes. "user" is the user that was reported. "transId" is the transaction id returned from Report. "hr" is the result of the operation. "deltaApplied" is how much the target's warning level was affected. "updatedValue" is the new warning level of the target.

HRESULT DAccEvents::OnAlertReceived ( [in] IAccSession session,
[in] IAccAlert alert 
)

Called when an AIM alert is received. "alert" is the alert that was received.

HRESULT DAccEvents::OnPreferenceResult ( [in] IAccSession session,
[in] xp_kstr  specifier,
[in] AccTransId  transId,
[in] xp_kvariant  vValue,
[in] AccResult  hr 
)

Preferences Called when IAccPreferences::RequestValue() completes. "specifier" is the preference specifier queried "transId" is the transaction id returned from RequestValue. "vValue" contains the value of the preference requested, or empty if a failure occurred. "hr" is the result of the operation.

HRESULT DAccEvents::OnPreferenceChange ( [in] IAccSession session,
[in] xp_kstr  specifier,
[in] AccResult  hr 
)

Called when a preference changes. "specifier" is the preference specifier that has changed. "hr" is the reason for the change.

HRESULT DAccEvents::OnPreferenceInvalid ( [in] IAccSession session,
[in] xp_kstr  specifier,
[in] AccResult  hr 
)

Called when a preference is no longer valid. "specifier" is the preference specifier that is invalid. "hr" is the reason why the preference was invalid.

HRESULT DAccEvents::OnPluginChange ( [in] IAccSession session,
[in] IAccPluginInfo plugin,
[in] AccPluginInfoProp  property 
)

Plugins Called when a plugin is loaded or unloaded. "plugin" is the plugin that has changed "property" is the plugin property that changed.

HRESULT DAccEvents::OnBartItemRequestPropertyResult ( [in] IAccSession session,
[in] IAccBartItem bartItem,
[in] AccBartItemProp  property,
[in] AccTransId  transId,
[in] AccResult  hr,
[in] xp_kvariant  propertyValue 
)

RequestProperty() on various objects Called when IAccBartItem::RequestProperty() completes. "bartItem" is the bart item on which the request was made. "property" is the property that was requested. "transId" is the transaction id returned from RequestProperty. "hr" is the result of the operation. "propertyValue" contains the value of the specified property, or empty if an failure occurred.

HRESULT DAccEvents::OnUserRequestPropertyResult ( [in] IAccSession session,
[in] IAccUser user,
[in] AccUserProp  property,
[in] AccTransId  transId,
[in] AccResult  hr,
[in] xp_kvariant  propertyValue 
)

Called when IAccUser::RequestProperty() completes. "user" is the user on which the request was made. "property" is the property that was requested. "transId" is the transaction id returned from RequestProperty. "hr" is the result of the operation. "propertyValue" contains the value of the specified property, or empty if an failure occurred.

HRESULT DAccEvents::OnGroupAdded ( [in] IAccSession session,
[in] IAccGroup group,
[in] xp_int  position,
[in] AccResult  hr 
)

BuddyList Called when a group has been added to the Buddy List. "group" is the group object that was added. "position" is the new position of the added group "hr" is the reason why the add occurred.

HRESULT DAccEvents::OnGroupRemoved ( [in] IAccSession session,
[in] IAccGroup group,
[in] AccResult  hr 
)

Called when a group has been removed from the Buddy List. "group" is the group that was removed. "hr" is the reason why the remove occurred.

HRESULT DAccEvents::OnGroupMoved ( [in] IAccSession session,
[in] IAccGroup group,
[in] xp_int  fromPosition,
[in] xp_int  toPosition,
[in] AccResult  hr 
)

Called when a group has been moved from one position to another position in the Buddy List. "group" is the group that has been moved. "fromPosition" is the old position of the group. "toPosition" is the new position of the group. "hr" is the reason why the move occurred.

HRESULT DAccEvents::OnBuddyAdded ( [in] IAccSession session,
[in] IAccGroup group,
[in] IAccUser user,
[in] xp_int  position,
[in] AccResult  hr 
)

Called when a user has been added to the specified group in the Buddy List. "group" is the group to which the buddy was added. "user" is the user that was added. "position" is the new position of the user in the group. "hr" is the reason the add occurred.

HRESULT DAccEvents::OnBuddyRemoved ( [in] IAccSession session,
[in] IAccGroup group,
[in] IAccUser user,
[in] AccResult  hr 
)

Called when a user has been removed from the specified group in the Buddy List. "group" is the group from which the user was removed. "user" is the user that was removed. "hr" is the reason the remove occurred.

HRESULT DAccEvents::OnBuddyMoved ( [in] IAccSession session,
[in] IAccUser user,
[in] IAccGroup fromGroup,
[in] xp_int  fromPosition,
[in] IAccGroup toGroup,
[in] xp_int  toPosition,
[in] AccResult  hr 
)

Called when a user has been moved from one position to another position in the Buddy List "user" is the user that was moved. "fromGroup" is the group the user was in. "fromPosition" is the position of the user in the old group. "toGroup" is the new group for the user. "toPosition" is the position of the user in the new group. "hr" is the reason the move occurred.

HRESULT DAccEvents::OnBuddyListChange ( [in] IAccSession session,
[in] IAccBuddyList buddyList,
[in] AccBuddyListProp  property 
)

This indicates a property of the Buddy List has changed. "buddyList" is the buddy list that has changed. "property" is the property of the buddy list that has changed.

HRESULT DAccEvents::OnGroupChange ( [in] IAccSession session,
[in] IAccGroup group,
[in] AccGroupProp  property 
)

This indicates a property of a group has changed, e.g. name. "group" is the group that has changed "property" is the property of the group that has changed.

HRESULT DAccEvents::OnUserChange ( [in] IAccSession session,
[in] IAccUser oldUser,
[in] IAccUser newUser,
[in] AccUserProp  property,
[in] AccResult  hr 
)

This indicates a property of a buddy has changed, e.g. name reformatting, online status, warning percent, buddy icon, etc. "oldUser" is the snapshot of the user object before the change. "newUser" is the user object after the change. "property" is the property of the user that has changed. "hr" is the reason the change occurred.

HRESULT DAccEvents::OnChangesBegin ( [in] IAccSession session  ) 

Called when a series of OnBuddy/Group/User events are about to be fired. Clients may want to defer UI updates until the series ends.

HRESULT DAccEvents::OnChangesEnd ( [in] IAccSession session  ) 

Called when the series of events has completed.

HRESULT DAccEvents::OnNewSecondarySession ( [in] IAccSession session,
[in] IAccSecondarySession secondarySession,
[in] xp_int  serviceId 
)

Called when a secondary session is started by a remote user.

Secondary Sessions

HRESULT DAccEvents::OnSecondarySessionStateChange ( [in] IAccSession session,
[in] IAccSecondarySession secondarySession,
[in] AccSecondarySessionState  state,
[in] AccResult  hr 
)

Called when a secondary session state changes. "secondarySession" is the secondary session that changed. "state" is the new state of the secondary session. "hr" is the reason for the state change.

HRESULT DAccEvents::OnSecondarySessionChange ( [in] IAccSession session,
[in] IAccSecondarySession secondarySession,
[in] xp_int  property 
)

Called when a non-state secondary session property changes. "secondarySession" is the secondary session that has changed. "property" is the property of the session that has changed.

HRESULT DAccEvents::OnParticipantJoined ( [in] IAccSession session,
[in] IAccSecondarySession secondarySession,
[in] IAccParticipant participant 
)

Called when a remote user joins a secondary session. "secondarySession" is the secondary session that was joined. "participant" is the user that has joined the session.

HRESULT DAccEvents::OnParticipantChange ( [in] IAccSession session,
[in] IAccSecondarySession secondarySession,
[in] IAccParticipant oldPart,
[in] IAccParticipant newPart,
[in] AccParticipantProp  prop 
)

Called when a property of a participant changes. "secondarySession" is the secondary session that the user is in. "oldPart" is a snapshot of the user before the change. "newPart" is the user after the change. "prop" is the property of the participant that changed.

HRESULT DAccEvents::OnParticipantLeft ( [in] IAccSession session,
[in] IAccSecondarySession secondarySession,
[in] IAccParticipant participant,
[in] AccResult  method,
[in] xp_kstr  by,
[in] xp_kstr  reason 
)

Called when a remote user leaves a secondary session, and may provide information on why the user left. "secondarySession" is the secondary session that was left. "participant" is the user that left. "method" is the reason that the user left. "by" is the username who caused the user to leave, if applicable. "reason" is the text reason for why the participant was made to leave.

HRESULT DAccEvents::OnInviteResult ( [in] IAccSession session,
[in] IAccSecondarySession secondarySession,
[in] xp_kstr  userName,
[in] AccTransId  transId,
[in] AccResult  hr 
)

Called when an outgoing secondary session invitation is accepted, rejected, canceled, or times out. "secondarySession" is the secondary session for the invite. "userName" is the user to whom he invite was sent. "transId" is the transaction id returned from Invite. "hr" is the result of the operation.

HRESULT DAccEvents::OnEjectResult ( [in] IAccSession session,
[in] IAccSecondarySession secondarySession,
[in] xp_kstr  userName,
[in] AccTransId  transId,
[in] AccResult  hr 
)

Called when a request to eject a user from a secondary session completes. "secondarySession" is the secondary session for the eject. "userName" is the user that was to be ejected. "transId" is the transaction id returned from Eject. "hr" is the result of the operation.

HRESULT DAccEvents::BeforeImSend ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] IAccParticipant recipient,
[in] IAccIm im 
)

ImSession Called on the original IM that is about to be sent. Plugins can change the IM text or suppress the entire IM by setting the text to an empty string. "imSession" is the IM session. "recipient" is the user to whom the IM is being sent; NULL if it is being sent to the entire session. "im" is the actual IM being sent.

HRESULT DAccEvents::OnImSent ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] IAccParticipant recipient,
[in] IAccIm im 
)

Called when the IM is actually sent out (after BeforeImSend). "imSession" is the IM session. "recipient" is the user to whom the IM is was sent; NULL if it was sent to the entire session. "im" is the IM that was sent.

HRESULT DAccEvents::OnImSendResult ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] IAccParticipant recipient,
[in] IAccIm im,
[in] AccResult  hr 
)

Called when the the IM was acknowledged with an ack or an error. "imSession" is the IM session. "recipient" is the user to whom the IM is was sent; NULL if it was sent to the entire session. "im" is the IM that was sent. "hr" is the result of the operation.

HRESULT DAccEvents::BeforeImReceived ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] IAccParticipant sender,
[in] IAccIm im 
)

Called when an IM is received. Plugins can change the IM text or suppress the entire IM by changing the text to an empty string. "imSession" is the IM session. "sender" is the user from whom the IM was sent. "im" is the IM that was received.

HRESULT DAccEvents::OnImReceived ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] IAccParticipant sender,
[in] IAccIm im 
)

Called when an IM is received (after BeforeImReceived). "imSession" is the IM session. "sender" is the participant from whom the IM was sent. "im" is the IM that was received.

HRESULT DAccEvents::OnLocalImReceived ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] IAccIm im 
)

Called when a local "status message" IM is to be appended to IM session history. These IMs are typically sent by plugins, using AccImFlags_Local. "imSession" is the IM session. "im" is the IM to be appended.

HRESULT DAccEvents::OnInputStateChange ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] xp_kstr  userName,
[in] AccImInputState  state 
)

Called when the input state of the remote client changes (aka typing indicator). "imSession" is the IM session "userName" is the username whose input state changed. "state" is the new input state of the user.

HRESULT DAccEvents::OnEmbedDownloadProgress ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] IAccIm im,
[in] xp_kstr  embedId,
[in] IAccStream stream 
)

Called while downloading an embed from an IM. "imSession" is the IM session. "im" is the IM in which an embed is being received. "embedId" is the ID of the embed being received. "stream" is the stream that is receiving the embed.

HRESULT DAccEvents::OnEmbedDownloadComplete ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] IAccIm im 
)

Called when done downloading all embeds in an IM. Note: this event does not indicate that streams from this IM are done being read. "imSession" is the IM session. "im" is the IM for which all embeds have been received.

HRESULT DAccEvents::OnEmbedUploadProgress ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] IAccIm im,
[in] xp_kstr  embedId,
[in] IAccStream stream 
)

Called while uploading an embed in an IM. "imSession" is the IM session. "im" is the IM in which an embed is being sent. "embedId" is the ID of the embed being sent. "stream" is the stream that is sending the embed.

HRESULT DAccEvents::OnEmbedUploadComplete ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] IAccIm im 
)

Called when done uploading all embeds in a message. "imSession" is the IM session. "im" is the IM for which all embeds have been sent.

HRESULT DAccEvents::OnRateLimitStateChange ( [in] IAccSession session,
[in] IAccImSession imSession,
[in] AccRateState  state 
)

Called when the rate limit state changes. "imSession" is the IM session. "state" is the new ratelimit state for the IM session.

HRESULT DAccEvents::OnNewFileXfer ( [in] IAccSession session,
[in] IAccFileXferSession fileXferSession,
[in] IAccFileXfer fileXfer 
)

File Xfer Called when a file xfer is created (the actual xfer may not start immediately). "fileXferSession" is the file transfer session "fileXfer" is the file being transferred.

HRESULT DAccEvents::OnFileXferProgress ( [in] IAccSession session,
[in] IAccFileXferSession fileXferSession,
[in] IAccFileXfer fileXfer 
)

Called repeatedly as a file xfer progresses. "fileXferSession" is the file transfer session. "fileXfer" is the file being transferred.

HRESULT DAccEvents::OnFileXferCollision ( [in] IAccSession session,
[in] IAccFileXferSession fileXferSession,
[in] IAccFileXfer fileXfer 
)

Called when a potential file overwrite is encountered. Call IAccFileXferSession::ResolveCollision. "fileXferSession" is the file transfer session. "fileXfer" is the file being transferred.

HRESULT DAccEvents::OnFileXferComplete ( [in] IAccSession session,
[in] IAccFileXferSession fileXferSession,
[in] IAccFileXfer fileXfer,
[in] AccResult  hr 
)

Called when a file xfer completes. "fileXferSession" is the file transfer session. "fileXfer" is the that was transferred. "hr" is the result of the file transfer.

HRESULT DAccEvents::OnFileXferSessionComplete ( [in] IAccSession session,
[in] IAccFileXferSession fileXferSession,
[in] AccResult  hr 
)

Called when a file xfer session completes. "fileXferSession" is the file transfer session. "hr" is the overall result of the file transfer session.

HRESULT DAccEvents::OnFileSharingRequestListingResult ( [in] IAccSession session,
[in] IAccFileSharingSession fileSharingSession,
[in] IAccFileSharingItem parentItem,
[in] AccTransId  transId,
[in] AccResult  hr 
)

File Sharing Called when RequestListing completes. "fileSharingSession" is the file sharing session. "parentItem" is the item for which the listing was requested. "transId" is the transaction id returned from RequestListing. "hr" is the result of the operation.

HRESULT DAccEvents::OnFileSharingRequestXferResult ( [in] IAccSession session,
[in] IAccFileSharingSession fileSharingSession,
[in] IAccFileXferSession fileXferSession,
[in] AccTransId  transId,
[in] IAccFileXfer fileXfer 
)

Called when a file xfer is started via IAccFileSharingItem::RequestXfer. "fileSharingSession" is the file sharing session. "fileXferSession" is the file transfer session for the item. "transId" is the transaction id returned from RequestXfer. "fileXfer" is the file being transferred.

HRESULT DAccEvents::OnAvStreamStateChange ( [in] IAccSession session,
[in] IAccAvSession avSession,
[in] xp_kstr  userName,
[in] AccAvStreamType  stream,
[in] AccSecondarySessionState  state,
[in] AccResult  hr 
)

A/V Called when a stream in an A/V session changes state. "avSession" is the A/V session in which the change is occuring. "userName" is the user for whom the state change is occuring; NULL indicates the local user. "stream" indicates which stream is changing state. "state" is the new state for the stream. "hr" is the reason for the state change.

HRESULT DAccEvents::OnAvManagerChange ( [in] IAccSession session,
[in] IAccAvManager avManager,
[in] AccAvManagerProp  prop,
[in] AccResult  hr 
)

Called when an A/V manager prop changes. "avManager" is the A/V manager. "prop" is the A/V manager prop that changed "hr" is the reason for the state change.

HRESULT DAccEvents::OnAudioLevelChange ( [in] IAccSession session,
[in] IAccAvSession avSession,
[in] xp_kstr  userName,
[in] xp_int  level 
)

Called when an audio stream in an A/V session changes level. "avSession" is the A/V session in which the audio ;eve; change is occurring. "userName" is the user for whom the the audio level change is occuring; NULL indicates the local user. "level" is the new audio level (0-100).

HRESULT DAccEvents::OnSoundEffectReceived ( [in] IAccSession session,
[in] IAccAvSession avSession,
[in] xp_kstr  userName,
[in] xp_kstr  url 
)

Called when a user in an A/V session sends a sound effect. "avSession" is the A/V session in which the sound effect was received. "userName" is the user that sent the sound effect. "url" is the URL for the sound effect data.

HRESULT DAccEvents::OnCustomSendResult ( [in] IAccSession session,
[in] IAccCustomSession customSession,
[in] IAccParticipant recipient,
[in] IAccIm im,
[in] AccResult  hr 
)

Custom Session Called when a send of custom data is acknowledged. "customSession" is the custom session in which the data was sent. "recipient" is the user to whom the data is was sent; NULL if it was sent to the entire session. "data" is the data that was sent. "hr" is the result of the operation.

HRESULT DAccEvents::OnCustomDataReceived ( [in] IAccSession session,
[in] IAccCustomSession customSession,
[in] IAccParticipant sender,
[in] IAccIm data 
)

Called when custom data is received in a custom session. "customSession" is the custom session in which the data was received. "sender" is the participant who sent the data. "data" is the data that was sent.

HRESULT DAccEvents::OnRequestSummariesResult ( [in] IAccSession session,
[in] AccTransId  transId,
[in] AccResult  hr,
[in] xp_kvariant  imSummaries 
)

Stored IM Called when IAccStoredImManager::RequestSummaries() completes. "transId" is the transaction id returned from RequestSummaries(). "hr" is the result of the operation. "imSummaries" is a SAFEARRAY containing VARIANTs of IAccImSummary*, or empty if a failure occurred.

HRESULT DAccEvents::OnDeliverStoredImsResult ( [in] IAccSession session,
[in] AccTransId  transId,
[in] AccResult  hr 
)

Called when IAccStoredImManager::DeliverIms() completes. "transId" is the transaction id returned from DeliverIms(). "hr" is the result of the operation.

HRESULT DAccEvents::OnDeleteStoredImsResult ( [in] IAccSession session,
[in] AccTransId  transId,
[in] AccResult  hr 
)

Called when IAccStoredImManager::DeleteIms() completes. "transId" is the transaction id returned from DeleteIms(). "hr" is the result of the operation.


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.