| typedef enum IAccSession::AccSessionState IAccSession::AccSessionState |
Values for the State property.
Values for the ParentalControls property.
Values for the Subscriptions property.
Values for the UiFlags property.
| typedef enum IAccSession::AccSessionProp IAccSession::AccSessionProp |
Properties for the Property method.
Values for the State property.
Values for the ParentalControls property.
Properties for the Property method.
| AccSessionProp_Identity | The identity (AIM name) of the session [get] xp_str* |
| AccSessionProp_LinkedIdentities | List of identities that are linked to this identity xp_strs [get] xp_array** |
| AccSessionProp_InstanceId | The instance ID of the session [get] xp_s32* |
| AccSessionProp_OnlineTime | The session's online time, in seconds [get] xp_s32* |
| AccSessionProp_IpAddress | The IP address of the session, as seen by the AIM server [get] xp_str* |
| AccSessionProp_Port | The port of the session, as seen by the AIM server [get] xp_s32* |
| AccSessionProp_Profile | The session's profile [get] IAccIm** [put] IAccIm* |
| AccSessionProp_AwayMessage | The session's away message [get] IAccIm** [put] IAccIm* |
| AccSessionProp_Capabilities | The capabilities of the session xp_strs [get] xp_array** |
| AccSessionProp_AppearOffline | Whether the session is invisible [get] xp_bool* [put] xp_bool |
| AccSessionProp_ImForwardingCapable | Whether the session is capable of IM forwarding [get] xp_bool* |
| AccSessionProp_ImForwardingActive | Force IMs to be forwarded to the configured mobile device [get] xp_bool* [put] xp_bool |
| AccSessionProp_SecondsOfInactivityBeforeIdleState | The seconds before the session goes to the idle state [get] xp_s32* [put] xp_s32 |
| AccSessionProp_SecondsSinceUserActivity | Seconds since the session was last active [get] xp_s32* [put] xp_s32 |
| AccSessionProp_SecondsSinceKeyboardActivity | Not implemented. |
| AccSessionProp_SecondsRemainingUntilIdleState | The seconds remaining before a session goes idle [get] xp_s32* [put] xp_s32 |
| AccSessionProp_UserIdle | Whether user is idle [get] xp_bool* |
| AccSessionProp_BetaUpgradeInfo | Information about an newer available "beta" client [get] IAccUpgradeInfo** |
| AccSessionProp_UpgradeInfo | Information about a newer available client [get] IAccUpgradeInfo** |
| AccSessionProp_UpgradeRecommended | Whether upgrade is recommended [get] xp_bool* |
| AccSessionProp_HostTime | Current time, according to the AIM server [get] xp_date* |
| AccSessionProp_ChangePasswordUrl | The URL for users to change their password [get] xp_str* |
| AccSessionProp_UiFlags | Flags for displaying certain features via a UI, from AccSessionUiFlags [get] xp_u32* |
| AccSessionProp_InstanceFlags | Flags for the instance associated with the session, from AccUserFlags [get] xp_u32* |
| AccSessionProp_ParentalControls | Session's parental controls, from AccParentalControlFlags [get] xp_u32* |
| AccSessionProp_Subscriptions | The sessions's subscription flags, from AccSubscriptionFlags [get] xp_u32* |
| AccSessionProp_MaxProfileLength | Maximum length of the profile [get] xp_s32* |
| AccSessionProp_MaxAwayMessageLength | Maximum length of an away message [get] xp_s32* |
| AccSessionProp_MaxChatRoomNameLength | Maximum length of a chat room name [get] xp_s32* |
| AccSessionProp_MaxInvitationLength | Maximum length of an invitation message [get] xp_s32* |
| AccSessionProp_MaxLookupUserCount | Maximum number of users that can be queried for in LookupUsers [get] xp_s32* |
| AccSessionProp_MaxUserLookups | To be deprecated [get] xp_s32* |
| AccSessionProp_LinkedMasterSession | The master session of linked accounts [get] IAccSession** [put] IAccSession* |
| AccSessionProp_MaxChatSessionCount | Maximum number of open chat sessions for a session [get] xp_s32* |
| AccSessionProp_MaxChatSessions | To be deprecated [get] xp_s32* |
| AccSessionProp_MaxPermittedUserCount | Maximum number of users in aimcc.privacy.permittedUsers [get] xp_s32* |
| AccSessionProp_MaxDeniedUserCount | Maximum number of users in aimcc.privacy.deniedUsers [get] xp_s32* |
| AccSessionProp_LocalIpAddress | The network interface used to connect to the AIM network [get] xp_str* |
| AccSessionProp_MaxFavoriteLocationCount | Maximum number of locations in aimcc.location.favorites [get] xp_s32* |
| AccSessionProp_Plugins | List of plugins to load at signon. Read from registry by default. IAccPluginInfos [get] xp_array** [put] xp_array* |
| AccSessionProp_StoredImManager | Get the IAccStoredImManager. [get] IAccStoredImManager** |
| AccSessionProp_PhoneNumber | The AIM Phoneline phone number, if you have one. [get] xp_str* |
| AccSessionProp_Pause | Sign-off from host but keep credentials and other settings [put] xp_bool |
| AccSessionProp_Credentials | Subsequent SignOn will present this, in lieu of password [put] xp_kvariant |
| AccSessionProp_BartCacheManager | Get the IAccBartCacheManager. [get] IAccBartCacheManager** |
| AccSessionProp_BuddyFeedManager | Get the IAccBuddyFeedManager. [get] IAccBuddyFeedManager** |
| AccSessionProp_MaxTempBuddyCount | Maximum number of tempBuddies that can be created (a tempBuddy is an IAccUser not associated with a buddy list) [get] xp_s32* |
| AccSessionProp_BartBase | |
| AccSessionProp_SmallIcon | The session's small icon [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_BuddyIcon | The session's buddy icon [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_StatusText | The session's status text [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_ArriveSound | The session's arrive sound [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_RichName | The session's rich text name [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_SuperIcon | The session's super buddy icon [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_RadioStation | The session's current radio station [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_SuperIconTrigger | The session's super buddy icon trigger [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_StatusTextLink | The session's status text link [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_E911Location | The session's location for E911 support [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_Location | The session's geographic location [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_BigIcon | The session's big icon. Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_StatusTextTimestamp | The unix time when AccSessionProp_StatusText last changed. [get] IAccBartItem** |
| AccSessionProp_AvTrack | The session's current A/V track [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_DepartSound | The session's depart sound [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_Wallpaper | The session's wallpaper [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_Badge | The session's badge [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_FlashWallpaper | The session's flash wallpaper [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_ImmersiveWallpaper | The session's immersive expression [get] IAccBartItem** [put] IAccBartItem* |
| AccSessionProp_BartMax |
| HRESULT IAccSession::ClientInfo | ( | [out, retval] IAccClientInfo ** | ppiAccClientInfo | ) | [get] |
Get the client info object, which must be set up prior to signon.
| HRESULT IAccSession::PrefsHook | ( | [in] IAccPreferencesHook * | piAccPrefsHook | ) | [set] |
Sets the application's preferences hook, which should be set up prior to signon.
| HRESULT IAccSession::Identity | ( | [in] xp_kstr | identity | ) | [set] |
Sets the identity for a session, which must be done prior to signon.
| HRESULT IAccSession::SignOn | ( | [in] xp_kstr | password | ) |
Signon the current user to the AIM service. If password is NULL, will try to get stored password from prefs hook.
| HRESULT IAccSession::SetSecurIdKey | ( | [in] xp_kstr | key | ) |
If the session state is AccSessionState_SecurId or AccSessionState_SecurIdNextKey, call this to continue signing on.
| HRESULT IAccSession::SignOff | ( | ) |
Sign-off the current user from the AIM service.
| HRESULT IAccSession::State | ( | [out, retval] AccSessionState * | pState | ) | [get] |
------------------------------------------------------------------------
Gets the service's current state (offline, connecting, online).
| HRESULT IAccSession::Identity | ( | [out, retval] xp_str * | pIdentity | ) | [get] |
Returns the identity (username) associated with this session.
| HRESULT IAccSession::OtherInstances | ( | [out, retval] xp_variant * | pInstances | ) | [get] |
Returns other online sessions for this identity, as a list of IAccInstances.
| HRESULT IAccSession::BuddyList | ( | [out, retval] IAccBuddyList ** | ppiBuddies | ) | [get] |
Returns the buddylist object for this session.
| HRESULT IAccSession::SecurityManager | ( | [out, retval] IAccSecurityManager ** | ppiSecurityManager | ) | [get] |
Returns the security manager object for this session. This object is used for management of certificates.
| HRESULT IAccSession::PluginManager | ( | [out, retval] IAccPluginManager ** | ppiPluginManager | ) | [get] |
Returns the plugin manager object. This object is used for interacting with AIMcc plugins.
| HRESULT IAccSession::Prefs | ( | [out, retval] IAccPreferences ** | prefs | ) | [get] |
Returns the preferences object. This object is used for getting and setting preference values.
| HRESULT IAccSession::Property | ( | [in] AccSessionProp | property, | |
| [out, retval] xp_variant * | value | |||
| ) | [get] |
Get a specific property of the session object.
| HRESULT IAccSession::Property | ( | [in] AccSessionProp | property, | |
| [in] xp_kvariant | value | |||
| ) | [set] |
Set a specific property of the session object.
| HRESULT IAccSession::GetSecondaryManager | ( | [in] xp_int | serviceId, | |
| [out, retval] IDispatch ** | ppiManager | |||
| ) |
Returns a secondary manager object for the specified serviceId. See AccSecondarySessionServiceId for values.
| HRESULT IAccSession::GetSecondarySessions | ( | [in] xp_int | serviceId, | |
| [out, retval] xp_variant * | pSessions | |||
| ) |
Returns all the secondary sessions of the given type. See AccSecondarySessionServiceId for values, or pass 0 to get all.
Returns a disassociated group (also see IAccBuddyList::InsertGroup).
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. Pass NULL or "" to get the IAccUser* associated with the session's identity.
| HRESULT IAccSession::CreateImSession | ( | [in] xp_kstr | userName, | |
| [in, defaultvalue(0)] AccImSessionType | sessionType, | |||
| [out, retval] IAccImSession ** | imSession | |||
| ) |
Creates an IM session of the specified type with the given user. If such a session already exists, you will get the existing session.
| HRESULT IAccSession::CreateChatSession | ( | [in, defaultvalue("")] xp_kstr | roomName, | |
| [in, defaultvalue(0)] xp_int | exchange, | |||
| [in, defaultvalue(0)] xp_int | instance, | |||
| [out, retval] IAccImSession ** | imSession | |||
| ) |
Creates a new IM session with given chat room name. The "exchange" and "instance" parameters can be specified if you want to join a specific chat room.
| HRESULT IAccSession::CreateCustomSession | ( | [in] xp_kstr | uuid, | |
| [out, retval] IAccCustomSession ** | customSession | |||
| ) |
Creates a new custom session.
| HRESULT IAccSession::CreateIm | ( | [in, defaultvalue("")] xp_kstr | text, | |
| [in, defaultvalue("")] xp_kstr | type, | |||
| [out, retval] IAccIm ** | ppiIm | |||
| ) |
Creates an IM with the specified text and MIME type. If type is NULL, text/x-aolrtf is used by default.
| HRESULT IAccSession::CreateBartItem | ( | [in] AccBartItemType | type, | |
| [in] xp_kstr | id, | |||
| [out, retval] IAccBartItem ** | ppiAccBartItem | |||
| ) |
Creates an IAccBartItem. This can be used for setting your buddy icon, or other personalization data.
| HRESULT IAccSession::CreateDirEntry | ( | [out, retval] IAccDirEntry ** | ppiAccDirEntry | ) |
DEPRECATED. Creates an IAccDirEntry. This is used in SearchDirectory, and also for setting your own directory info via preferences.
| HRESULT IAccSession::CreateStream | ( | [in] xp_kstr | specifier, | |
| [out, retval] IAccStream ** | ppiStream | |||
| ) |
Creates a stream on a path or URL. Currently only file:// URLs are supported.
| HRESULT IAccSession::LookupUsers | ( | [in] xp_kvariant | users, | |
| [out, retval] AccTransId * | pTransId | |||
| ) |
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.
| HRESULT IAccSession::SearchDirectory | ( | [in] xp_kvariant | query, | |
| [out, retval] AccTransId * | pTransId | |||
| ) |
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.
| HRESULT IAccSession::SendInviteMail | ( | [in] xp_kstr | email, | |
| [in, defaultvalue("")] xp_kstr | message, | |||
| [out, retval] AccTransId * | pTransId | |||
| ) |
Sends an invite to the specified email address to sign up for AIM. The result will be returned via DAccEvents::OnSendInviteMailResult.
| HRESULT IAccSession::RequestService | ( | [in] xp_kstr | serviceId, | |
| [in] xp_kvariant | qualifiers, | |||
| [out, retval] AccTransId * | pTransId | |||
| ) |
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.
| HRESULT IAccSession::ConfirmAccount | ( | [out, retval] AccTransId * | pTransId | ) |
Confirm this account, meaning verify its associated email address. If the account is unconfirmed, email will be sent to the email address on file. Also see AccUserFlags_Unconfirmed. The result will be returned via DAccEvents::OnConfirmAccountResult.
| HRESULT IAccSession::CancelEvent | ( | ) |
Stop the current event fired from DAccEvents from being sent to any more event sinks. Useful if you want to "eat" an event.
| HRESULT IAccSession::AddCapabilities | ( | [in] xp_kvariant | caps | ) |
Assert the specified custom capabilities with the host.
| HRESULT IAccSession::RemoveCapabilities | ( | [in] xp_kvariant | caps | ) |
Unassert the specified custom capabilities with the host.
Verify user password.