|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectcom.aol.acc.AccBase
com.aol.acc.AccSession
public class AccSession
AccSession is the main interface to access AIM functionalities.
| Constructor Summary | |
|---|---|
AccSession()
|
|
| Method Summary | |
|---|---|
void |
addCapabilities(java.lang.String[] caps)
Assert the specified custom capabilities with the host. |
void |
cancelEvent()
Stop the current event fired from DAccEvents from being sent to any more event sinks. |
int |
confirmAccount()
Confirm this account, meaning verify its associated email address. If the account is unconfirmed, email will be sent to the email address on file. |
AccBartItem |
createBartItem(AccBartItemType type,
java.lang.String id)
Creates an IAccBartItem. |
AccImSession |
createChatSession(java.lang.String roomName,
AccImExchange exchange,
int instance)
Creates a new IM session with given chat room name. |
AccCustomSession |
createCustomSession(java.lang.String uuid)
Creates a new custom session. |
AccDirEntry |
createDirEntry()
DEPRECATED. |
AccGroup |
createGroup(java.lang.String name)
Returns a disassociated group (also see IAccBuddyList::InsertGroup). |
AccIm |
createIm(java.lang.String text,
java.lang.String type)
Creates an IM with the specified text and MIME type. If type is NULL, text/x-aolrtf is used by default. |
AccImSession |
createImSession(java.lang.String userName,
AccImSessionType sessionType)
Creates an IM session of the specified type with the given user. If such a session already exists, you will get the existing session. |
AccStream |
createStream(java.lang.String specifier)
Creates a stream on a path or URL. |
AccUser |
createUser(java.lang.String name)
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. |
boolean |
getAppearOffline()
Whether the session is invisible |
AccBartItem |
getArriveSound()
The session's arrive sound |
AccAvManager |
getAudioVideoManager()
Returns an AudioVideo manager. |
AccBartItem |
getAvTrack()
The session's current A/V track |
AccIm |
getAwayMessage()
The session's away message |
AccBartItem |
getBadge()
The session's badge |
AccUpgradeInfo |
getBetaUpgradeInfo()
Information about an newer available "beta" client |
AccBartItem |
getBigIcon()
Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF |
AccBartItem |
getBuddyIcon()
The session's buddy icon |
AccBuddyList |
getBuddyList()
Returns the buddylist object for this session. |
java.lang.String[] |
getCapabilities()
The capabilities of the session |
java.lang.String |
getChangePasswordUrl()
The URL for users to change their password |
AccClientInfo |
getClientInfo()
Get the client info object, which must be set up prior to signon. |
AccBartItem |
getDepartSound()
The session's depart sound |
AccBartItem |
getE911Location()
The session's location for E911 support |
AccFileSharingManager |
getFileSharingManager()
Returns a FileSharing manager. |
AccFileXferManager |
getFileXferManager()
Returns a FileXfer manager. |
AccBartItem |
getFlashWallpaper()
The session's flash wallpaper |
java.util.Date |
getHostTime()
Current time, according to the AIM server |
java.lang.String |
getIdentity()
Returns the identity (username) associated with this session. |
boolean |
getImForwardingActive()
Force IMs to be forwarded to the configured mobile device |
boolean |
getImForwardingCapable()
Whether the session is capable of IM forwarding |
AccBartItem |
getImmersiveWallpaper()
The session's immersive expression |
int |
getInstanceFlags()
Flags for the instance associated with the session, from AccUserFlags |
int |
getInstanceId()
The instance ID of the session |
java.lang.String |
getIpAddress()
The IP address of the session, as seen by the AIM server |
java.lang.String[] |
getLinkedIdentities()
List of identities that are linked to this identity |
AccSession |
getLinkedMasterSession()
The master session of linked accounts |
java.lang.String |
getLocalIpAddress()
The network interface used to connect to the AIM network |
AccBartItem |
getLocation()
The session's geographic location |
int |
getMaxAwayMessageLength()
Maximum length of an away message |
int |
getMaxChatRoomNameLength()
Maximum length of a chat room name |
int |
getMaxChatSessionCount()
Maximum number of open chat sessions for a session |
int |
getMaxChatSessions()
To be deprecated |
int |
getMaxDeniedUserCount()
Maximum number of users in aimcc.privacy.deniedUsers |
int |
getMaxFavoriteLocationCount()
Maximum number of locations in aimcc.location.favorites |
int |
getMaxInvitationLength()
Maximum length of an invitation message |
int |
getMaxLookupUserCount()
Maximum number of users that can be queried for in LookupUsers |
int |
getMaxPermittedUserCount()
Maximum number of users in aimcc.privacy.permittedUsers |
int |
getMaxProfileLength()
Maximum length of the profile |
int |
getMaxUserLookups()
To be deprecated |
static long |
getMsgQueue()
|
int |
getOnlineTime()
The session's online time, in seconds |
AccInstance[] |
getOtherInstances()
Returns other online sessions for this identity, as a list of IAccInstances. |
int |
getParentalControls()
Session's parental controls, from AccParentalControlFlags |
java.lang.String |
getPhoneNumber()
The AIM Phoneline phone number, if you have one. |
AccPluginManager |
getPluginManager()
Returns the plugin manager object. |
AccPluginInfo[] |
getPlugins()
List of plugins to load at signon. |
int |
getPort()
The port of the session, as seen by the AIM server |
AccPreferences |
getPrefs()
Returns the preferences object. |
AccIm |
getProfile()
The session's profile |
AccVariant |
getProperty(AccSessionProp property)
Get a specific property of the session object. |
AccBartItem |
getRadioStation()
The session's current radio station |
AccBartItem |
getRichName()
The session's rich text name |
AccVariant |
getSecondaryManager(AccSecondarySessionServiceId serviceId)
Returns a secondary manager object for the specified serviceId. |
AccSecondarySession[] |
getSecondarySessions(AccSecondarySessionServiceId serviceId)
Returns all the secondary sessions of the given type. See AccSecondarySessionServiceId for values, or pass 0 to get all. |
int |
getSecondsOfInactivityBeforeIdleState()
The seconds before the session goes to the idle state |
int |
getSecondsRemainingUntilIdleState()
The seconds remaining before a session goes idle |
int |
getSecondsSinceUserActivity()
Seconds since the session was last active |
AccSecurityManager |
getSecurityManager()
Returns the security manager object for this session. |
AccShareBuddiesManager |
getShareBuddiesManager()
Returns a ShareBuddies manager. |
AccBartItem |
getSmallIcon()
The session's small icon |
AccSessionState |
getState()
Gets the service's current state (offline, connecting, online). |
AccBartItem |
getStatusText()
The session's status text |
AccBartItem |
getStatusTextLink()
The session's status text link |
AccBartItem |
getStatusTextTimestamp()
The unix time when AccSessionProp_StatusText last changed. |
AccStoredImManager |
getStoredImManager()
Get the IAccStoredImManager. |
int |
getSubscriptions()
The sessions's subscription flags, from AccSubscriptionFlags |
AccBartItem |
getSuperIcon()
The session's super buddy icon |
AccBartItem |
getSuperIconTrigger()
The session's super buddy icon trigger |
int |
getUiFlags()
Flags for displaying certain features via a UI, from AccSessionUiFlags |
AccUpgradeInfo |
getUpgradeInfo()
Information about a newer available client |
boolean |
getUpgradeRecommended()
Whether upgrade is recommended |
boolean |
getUserIdle()
Whether user is idle |
AccBartItem |
getWallpaper()
The session's wallpaper |
int |
lookupUsers(java.lang.String[] users)
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. |
static void |
pump(int i)
|
void |
removeCapabilities(java.lang.String[] caps)
Unassert the specified custom capabilities with the host. |
void |
removeEventListener()
|
int |
requestService(java.lang.String serviceId,
AccVariant qualifiers)
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. |
int |
searchDirectory(AccVariant query)
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. |
int |
sendInviteMail(java.lang.String email,
java.lang.String message)
Sends an invite to the specified email address to sign up for AIM. The result will be returned via DAccEvents::OnSendInviteMailResult. |
void |
setAppearOffline(boolean AppearOffline)
Whether the session is invisible |
void |
setArriveSound(AccBartItem ArriveSound)
The session's arrive sound |
void |
setAvTrack(AccBartItem AvTrack)
The session's current A/V track |
void |
setAwayMessage(AccIm AwayMessage)
The session's away message |
void |
setBadge(AccBartItem Badge)
The session's badge |
void |
setBigIcon(AccBartItem BigIcon)
Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF |
void |
setBuddyIcon(AccBartItem BuddyIcon)
The session's buddy icon |
void |
setDepartSound(AccBartItem DepartSound)
The session's depart sound |
void |
setE911Location(AccBartItem E911Location)
The session's location for E911 support |
void |
setEventListener(AccEvents eh)
|
void |
setFlashWallpaper(AccBartItem FlashWallpaper)
The session's flash wallpaper |
void |
setIdentity(java.lang.String identity)
Sets the identity for a session, which must be done prior to signon. |
void |
setImForwardingActive(boolean ImForwardingActive)
Force IMs to be forwarded to the configured mobile device |
void |
setImmersiveWallpaper(AccBartItem ImmersiveWallpaper)
The session's immersive expression |
void |
setLinkedMasterSession(AccSession LinkedMasterSession)
The master session of linked accounts |
void |
setLocation(AccBartItem Location)
The session's geographic location |
void |
setPause(boolean Pause)
Signoff from host but keep credentials and other settings |
void |
setPlugins(AccPluginInfo[] Plugins)
List of plugins to load at signon. |
void |
setPrefsHook(AccPreferencesHook piAccPrefsHook)
Sets the application's preferences hook, which should be set up prior to signon. |
void |
setProfile(AccIm Profile)
The session's profile |
void |
setProperty(AccSessionProp property,
AccVariant value)
Set a specific property of the session object. |
void |
setRadioStation(AccBartItem RadioStation)
The session's current radio station |
void |
setRichName(AccBartItem RichName)
The session's rich text name |
void |
setSecondsOfInactivityBeforeIdleState(int SecondsOfInactivityBeforeIdleState)
The seconds before the session goes to the idle state |
void |
setSecondsRemainingUntilIdleState(int SecondsRemainingUntilIdleState)
The seconds remaining before a session goes idle |
void |
setSecondsSinceUserActivity(int SecondsSinceUserActivity)
Seconds since the session was last active |
void |
setSecurIdKey(java.lang.String key)
If the session state is AccSessionState_SecurId or AccSessionState_SecurIdNextKey, call this to continue signing on. |
void |
setSmallIcon(AccBartItem SmallIcon)
The session's small icon |
void |
setStatusText(AccBartItem StatusText)
The session's status text |
void |
setStatusTextLink(AccBartItem StatusTextLink)
The session's status text link |
void |
setSuperIcon(AccBartItem SuperIcon)
The session's super buddy icon |
void |
setSuperIconTrigger(AccBartItem SuperIconTrigger)
The session's super buddy icon trigger |
void |
setWallpaper(AccBartItem Wallpaper)
The session's wallpaper |
void |
signOff()
Signoff the current user from the AIM service. |
void |
signOn(java.lang.String password)
Signon the current user to the AIM service. If password is NULL, will try to get stored password from prefs hook. |
| Methods inherited from class com.aol.acc.AccBase |
|---|
compareHandle, equals |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AccSession()
| Method Detail |
|---|
public static void pump(int i)
public static long getMsgQueue()
public void setEventListener(AccEvents eh)
public void removeEventListener()
public AccClientInfo getClientInfo()
throws AccException
AccException
public void setPrefsHook(AccPreferencesHook piAccPrefsHook)
throws AccException
AccException
public void setIdentity(java.lang.String identity)
throws AccException
AccException
public void signOn(java.lang.String password)
throws AccException
AccException
public void setSecurIdKey(java.lang.String key)
throws AccException
AccException
public void signOff()
throws AccException
AccException
public AccSessionState getState()
throws AccException
AccException
public java.lang.String getIdentity()
throws AccException
AccException
public AccInstance[] getOtherInstances()
throws AccException
AccException
public AccBuddyList getBuddyList()
throws AccException
AccException
public AccSecurityManager getSecurityManager()
throws AccException
AccException
public AccPluginManager getPluginManager()
throws AccException
AccException
public AccPreferences getPrefs()
throws AccException
AccException
public AccVariant getProperty(AccSessionProp property)
throws AccException
AccException
public void setProperty(AccSessionProp property,
AccVariant value)
throws AccException
AccException
public AccVariant getSecondaryManager(AccSecondarySessionServiceId serviceId)
throws AccException
AccException
public AccAvManager getAudioVideoManager()
throws AccException
AccException
public AccFileSharingManager getFileSharingManager()
throws AccException
AccException
public AccFileXferManager getFileXferManager()
throws AccException
AccException
public AccShareBuddiesManager getShareBuddiesManager()
throws AccException
AccException
public AccSecondarySession[] getSecondarySessions(AccSecondarySessionServiceId serviceId)
throws AccException
AccException
public AccGroup createGroup(java.lang.String name)
throws AccException
AccException
public AccUser createUser(java.lang.String name)
throws AccException
AccException
public AccImSession createImSession(java.lang.String userName,
AccImSessionType sessionType)
throws AccException
AccException
public AccImSession createChatSession(java.lang.String roomName,
AccImExchange exchange,
int instance)
throws AccException
AccException
public AccCustomSession createCustomSession(java.lang.String uuid)
throws AccException
AccException
public AccIm createIm(java.lang.String text,
java.lang.String type)
throws AccException
AccException
public AccBartItem createBartItem(AccBartItemType type,
java.lang.String id)
throws AccException
AccException
public AccDirEntry createDirEntry()
throws AccException
AccException
public AccStream createStream(java.lang.String specifier)
throws AccException
AccException
public int lookupUsers(java.lang.String[] users)
throws AccException
AccException
public int searchDirectory(AccVariant query)
throws AccException
AccException
public int sendInviteMail(java.lang.String email,
java.lang.String message)
throws AccException
AccException
public int requestService(java.lang.String serviceId,
AccVariant qualifiers)
throws AccException
AccException
public int confirmAccount()
throws AccException
AccException
public void cancelEvent()
throws AccException
AccException
public void addCapabilities(java.lang.String[] caps)
throws AccException
AccException
public void removeCapabilities(java.lang.String[] caps)
throws AccException
AccException
public java.lang.String[] getLinkedIdentities()
throws AccException
AccException
public int getInstanceId()
throws AccException
AccException
public int getOnlineTime()
throws AccException
AccException
public java.lang.String getIpAddress()
throws AccException
AccException
public int getPort()
throws AccException
AccException
public AccIm getProfile()
throws AccException
AccException
public void setProfile(AccIm Profile)
throws AccException
AccException
public AccIm getAwayMessage()
throws AccException
AccException
public void setAwayMessage(AccIm AwayMessage)
throws AccException
AccException
public java.lang.String[] getCapabilities()
throws AccException
AccException
public boolean getAppearOffline()
throws AccException
AccException
public void setAppearOffline(boolean AppearOffline)
throws AccException
AccException
public boolean getImForwardingCapable()
throws AccException
AccException
public boolean getImForwardingActive()
throws AccException
AccException
public void setImForwardingActive(boolean ImForwardingActive)
throws AccException
AccException
public int getSecondsOfInactivityBeforeIdleState()
throws AccException
AccException
public void setSecondsOfInactivityBeforeIdleState(int SecondsOfInactivityBeforeIdleState)
throws AccException
AccException
public int getSecondsSinceUserActivity()
throws AccException
AccException
public void setSecondsSinceUserActivity(int SecondsSinceUserActivity)
throws AccException
AccException
public int getSecondsRemainingUntilIdleState()
throws AccException
AccException
public void setSecondsRemainingUntilIdleState(int SecondsRemainingUntilIdleState)
throws AccException
AccException
public boolean getUserIdle()
throws AccException
AccException
public AccUpgradeInfo getBetaUpgradeInfo()
throws AccException
AccException
public AccUpgradeInfo getUpgradeInfo()
throws AccException
AccException
public boolean getUpgradeRecommended()
throws AccException
AccException
public java.util.Date getHostTime()
throws AccException
AccException
public java.lang.String getChangePasswordUrl()
throws AccException
AccException
public int getUiFlags()
throws AccException
AccException
public int getInstanceFlags()
throws AccException
AccException
public int getParentalControls()
throws AccException
AccException
public int getSubscriptions()
throws AccException
AccException
public int getMaxProfileLength()
throws AccException
AccException
public int getMaxAwayMessageLength()
throws AccException
AccException
public int getMaxChatRoomNameLength()
throws AccException
AccException
public int getMaxInvitationLength()
throws AccException
AccException
public int getMaxLookupUserCount()
throws AccException
AccException
public int getMaxUserLookups()
throws AccException
AccException
public AccSession getLinkedMasterSession()
throws AccException
AccException
public void setLinkedMasterSession(AccSession LinkedMasterSession)
throws AccException
AccException
public int getMaxChatSessionCount()
throws AccException
AccException
public int getMaxChatSessions()
throws AccException
AccException
public int getMaxPermittedUserCount()
throws AccException
AccException
public int getMaxDeniedUserCount()
throws AccException
AccException
public java.lang.String getLocalIpAddress()
throws AccException
AccException
public int getMaxFavoriteLocationCount()
throws AccException
AccException
public AccPluginInfo[] getPlugins()
throws AccException
AccException
public void setPlugins(AccPluginInfo[] Plugins)
throws AccException
AccException
public AccStoredImManager getStoredImManager()
throws AccException
AccException
public java.lang.String getPhoneNumber()
throws AccException
AccException
public void setPause(boolean Pause)
throws AccException
AccException
public AccBartItem getSmallIcon()
throws AccException
AccException
public void setSmallIcon(AccBartItem SmallIcon)
throws AccException
AccException
public AccBartItem getBuddyIcon()
throws AccException
AccException
public void setBuddyIcon(AccBartItem BuddyIcon)
throws AccException
AccException
public AccBartItem getStatusText()
throws AccException
AccException
public void setStatusText(AccBartItem StatusText)
throws AccException
AccException
public AccBartItem getArriveSound()
throws AccException
AccException
public void setArriveSound(AccBartItem ArriveSound)
throws AccException
AccException
public AccBartItem getRichName()
throws AccException
AccException
public void setRichName(AccBartItem RichName)
throws AccException
AccException
public AccBartItem getSuperIcon()
throws AccException
AccException
public void setSuperIcon(AccBartItem SuperIcon)
throws AccException
AccException
public AccBartItem getRadioStation()
throws AccException
AccException
public void setRadioStation(AccBartItem RadioStation)
throws AccException
AccException
public AccBartItem getSuperIconTrigger()
throws AccException
AccException
public void setSuperIconTrigger(AccBartItem SuperIconTrigger)
throws AccException
AccException
public AccBartItem getStatusTextLink()
throws AccException
AccException
public void setStatusTextLink(AccBartItem StatusTextLink)
throws AccException
AccException
public AccBartItem getE911Location()
throws AccException
AccException
public void setE911Location(AccBartItem E911Location)
throws AccException
AccException
public AccBartItem getLocation()
throws AccException
AccException
public void setLocation(AccBartItem Location)
throws AccException
AccException
public AccBartItem getBigIcon()
throws AccException
AccException
public void setBigIcon(AccBartItem BigIcon)
throws AccException
AccException
public AccBartItem getStatusTextTimestamp()
throws AccException
AccException
public AccBartItem getAvTrack()
throws AccException
AccException
public void setAvTrack(AccBartItem AvTrack)
throws AccException
AccException
public AccBartItem getDepartSound()
throws AccException
AccException
public void setDepartSound(AccBartItem DepartSound)
throws AccException
AccException
public AccBartItem getWallpaper()
throws AccException
AccException
public void setWallpaper(AccBartItem Wallpaper)
throws AccException
AccException
public AccBartItem getBadge()
throws AccException
AccException
public void setBadge(AccBartItem Badge)
throws AccException
AccException
public AccBartItem getFlashWallpaper()
throws AccException
AccException
public void setFlashWallpaper(AccBartItem FlashWallpaper)
throws AccException
AccException
public AccBartItem getImmersiveWallpaper()
throws AccException
AccException
public void setImmersiveWallpaper(AccBartItem ImmersiveWallpaper)
throws AccException
AccException
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||