The IAccIm interface represents an instant message.
By default IAccIms are of the text/x-aolrtf MIME type, and pass their
data unchanged to/from the application.
The IAccIm interface represents an instant message.
By default IAccIms are of the text/x-aolrtf MIME type, and pass their
data unchanged to/from the application.
The IAccUser interface provides the access to the information about an AIM user.
The data for some properties is not immediately available from get_Property
because the data must be asynchronously retrieved from the server.
For these properties, calling get_Property will return ACC_E_MUST_REQUEST_DATA
(unless the data is cached), indicating that you must use RequestProperty
In general, unless you know that the data is in cache, RequestProperty
should be used for the properties marked as "(request)".
The IAccUser interface provides the access to the information about an AIM user.
The data for some properties is not immediately available from get_Property
because the data must be asynchronously retrieved from the server.
For these properties, calling get_Property will return ACC_E_MUST_REQUEST_DATA
(unless the data is cached), indicating that you must use RequestProperty
In general, unless you know that the data is in cache, RequestProperty
should be used for the properties marked as "(request)".
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.
Returns a disassociated user (also see IAccGroup::InsertBuddy).
You will get presence updates for this user until it is destroyed.
Just like buddies, there is a maximum on the number of users you can
get presence for.
Imports certificates from a PKCS #12 file into the certificate store.
If successful, the imported certs are returned in "certs" as a list of
VARIANTs containing IAccCertificate.
Looks up user info for users by user name or email address.
'users' should be a SAFEARRAY of names/emails.
The result will be returned via DAccEvents::OnLookupUsersResult.
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).
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.
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.
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.
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.
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.
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.
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.
Called when IAccSession::ConfirmAccount() completes.
"transId" is the transaction id returned from ConfirmAccount.
"hr" is the result of the operation.
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.
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.
Called when IAccStoredImManager::DeleteIms() completes.
"transId" is the transaction id returned from DeleteIms().
"hr" is the result of the operation.
Called when IAccStoredImManager::DeliverIms() completes.
"transId" is the transaction id returned from DeliverIms().
"hr" is the result of the operation.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Called when IAccSession::SendInviteMail() completes.
"transId" is the transaction id returned from SendInviteMail.
"hr" is the result of the operation.
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.
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.
Indicates whether this command could be executed on certain user(s).
If an error is returned, or "enabled" is false, the command would
not be allowed, so it should be disabled in the user interface.
Called by the application when it wants to determine whether the plugin
can be invoked, given its current internal state and selected buddies
in the Buddy List.
Report this user to one of the backend systems.
If 'notify' is not set, this action will 'warn' the remote user;
his/her warning level will increase, he/she will be informed,
and the backend may start treating the user differently.
If 'notify' is set, this action will report the remote user to
AOL's investigative team, who may at a later date take action
against the offender's account.
Requests authenticated access to an external service, such as address book.
The result will be returned via DAccEvents::OnRequestServiceResult.
The details of how this function works, including the set of acceptable
serviceIds and the format of the returned result, are expected to change.
Searches the member directory.
'query' must be a string email address with prefix "userlookup:".
'query' string email address with prefix "odir:" and 'query' by
IAccDirEntry are DEPRECATED.
The result will be returned via DAccEvents::OnSearchDirectoryResult.
Propose sending the file or folder identified by "path",
to the remote user identified by "userName", with the invitation
message specified in "invitation".
Flags are from AccFileXferFlags.