|
||||||||
| 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.AccUser
public class AccUser
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)".
| Method Summary | |
|---|---|
AccBartItem |
getArriveSound()
The user's arrive sound |
AccBartItem |
getAvTrack()
The user's current A/V track |
AccBartItem |
getBadge()
The user's badge |
AccBartItem |
getBigIcon()
Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF |
boolean |
getBlocked()
Whether the user is blocked |
java.util.Date |
getBuddyFeedUpdateTime()
Time when user's buddy feed last updated |
java.lang.String |
getBuddyFeedUrl()
URL for displaying buddy feed |
java.util.Date |
getBuddyFeedViewTime()
Time when self last viewed user's buddy feed |
AccBartItem |
getBuddyIcon()
The user's buddy icon |
java.lang.String[] |
getCapabilities()
The user's capabilities UUIDs |
AccCertificate |
getCertificate()
The user's signing certificate |
AccBartItem |
getDepartSound()
The user's depart sound |
AccBartItem |
getE911Location()
The user's location for E911 support |
java.lang.String |
getEmailAddress()
The user's email address |
int |
getFlags()
The flags associated with the user, from AccUserFlags |
AccBartItem |
getFlashWallpaper()
The user's flash wallpaper |
double |
getFrequency()
The user's frequency score |
java.lang.String |
getFriendlyName()
The friendly name of the user |
AccGroup[] |
getGroups()
Return a list of groups the user is in, if any, as an array of IAccGroups. |
int |
getIdleTime()
The user's idle time, in seconds |
boolean |
getIgnored()
Whether the user is ignored |
AccBartItem |
getImmersiveWallpaper()
The user's immersive expression |
boolean |
getInBuddyList()
Whether the user is in the buddy list |
AccBartItem |
getLocation()
The user's geographic location |
int |
getMaxEmailAddressLength()
Maximum email address length |
int |
getMaxFriendlyNameLength()
Maximum friendly name length |
int |
getMaxNoteLength()
Maximum user note length |
java.lang.String |
getName()
Get the name for this user. |
java.lang.String |
getNote()
A locally specified note about the user |
int |
getOnlineTime()
The user's online time, in seconds |
AccBartItem |
getRadioStation()
The user's current radio station |
AccBartItem |
getRichName()
The user's rich text name |
AccSession |
getSession()
The IAccSession object for the user, if any |
AccBartItem |
getSmallIcon()
The user's small icon |
boolean |
getSmsChargeback()
Whether or not sending a SMS message to the user will be charged |
AccUserState |
getState()
The state of the user, from AccUserState |
AccBartItem |
getStatusText()
The user's status text |
AccBartItem |
getStatusTextLink()
The user's status text link |
AccBartItem |
getStatusTextTimestamp()
The unix time when AccUserProp_StatusText last changed. |
AccBartItem |
getSuperIcon()
The user's super buddy icon |
AccBartItem |
getSuperIconTrigger()
The user's super buddy icon trigger |
boolean |
getTrustedAsBuddy()
Whether the user is a known buddy, i.e. |
AccBartItem |
getWallpaper()
The user's wallpaper |
int |
getWarningPercent()
The user's warning level |
int |
report(boolean notify,
java.lang.String reason)
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. |
int |
requestProperty(AccUserProp property)
Generic API to request a specific property of the user. The value is pulled from the local cache, or from the AIM server if necessary. |
void |
setBlocked(boolean Blocked)
Whether the user is blocked |
void |
setBuddyFeedViewTime(java.util.Date BuddyFeedViewTime)
Time when self last viewed user's buddy feed |
void |
setEmailAddress(java.lang.String EmailAddress)
The user's email address |
void |
setFriendlyName(java.lang.String FriendlyName)
The friendly name of the user |
void |
setIgnored(boolean Ignored)
Whether the user is ignored |
void |
setNote(java.lang.String Note)
A locally specified note about the user |
| 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 |
| Method Detail |
|---|
public java.lang.String getName()
throws AccException
AccException
public AccGroup[] getGroups()
throws AccException
AccException
public int requestProperty(AccUserProp property)
throws AccException
AccException
public int report(boolean notify,
java.lang.String reason)
throws AccException
AccException
public AccSession getSession()
throws AccException
AccException
public java.lang.String getFriendlyName()
throws AccException
AccException
public void setFriendlyName(java.lang.String FriendlyName)
throws AccException
AccException
public AccUserState getState()
throws AccException
AccException
public int getFlags()
throws AccException
AccException
public boolean getBlocked()
throws AccException
AccException
public void setBlocked(boolean Blocked)
throws AccException
AccException
public boolean getIgnored()
throws AccException
AccException
public void setIgnored(boolean Ignored)
throws AccException
AccException
public int getOnlineTime()
throws AccException
AccException
public int getIdleTime()
throws AccException
AccException
public int getWarningPercent()
throws AccException
AccException
public boolean getSmsChargeback()
throws AccException
AccException
public java.lang.String getEmailAddress()
throws AccException
AccException
public void setEmailAddress(java.lang.String EmailAddress)
throws AccException
AccException
public java.lang.String getNote()
throws AccException
AccException
public void setNote(java.lang.String Note)
throws AccException
AccException
public double getFrequency()
throws AccException
AccException
public boolean getInBuddyList()
throws AccException
AccException
public boolean getTrustedAsBuddy()
throws AccException
AccException
public java.util.Date getBuddyFeedUpdateTime()
throws AccException
AccException
public java.util.Date getBuddyFeedViewTime()
throws AccException
AccException
public void setBuddyFeedViewTime(java.util.Date BuddyFeedViewTime)
throws AccException
AccException
public java.lang.String getBuddyFeedUrl()
throws AccException
AccException
public java.lang.String[] getCapabilities()
throws AccException
AccException
public AccCertificate getCertificate()
throws AccException
AccException
public AccBartItem getSmallIcon()
throws AccException
AccException
public AccBartItem getBuddyIcon()
throws AccException
AccException
public AccBartItem getStatusText()
throws AccException
AccException
public AccBartItem getArriveSound()
throws AccException
AccException
public AccBartItem getRichName()
throws AccException
AccException
public AccBartItem getSuperIcon()
throws AccException
AccException
public AccBartItem getRadioStation()
throws AccException
AccException
public AccBartItem getSuperIconTrigger()
throws AccException
AccException
public AccBartItem getStatusTextLink()
throws AccException
AccException
public AccBartItem getE911Location()
throws AccException
AccException
public AccBartItem getLocation()
throws AccException
AccException
public AccBartItem getBigIcon()
throws AccException
AccException
public AccBartItem getStatusTextTimestamp()
throws AccException
AccException
public AccBartItem getAvTrack()
throws AccException
AccException
public AccBartItem getDepartSound()
throws AccException
AccException
public AccBartItem getWallpaper()
throws AccException
AccException
public AccBartItem getBadge()
throws AccException
AccException
public AccBartItem getFlashWallpaper()
throws AccException
AccException
public AccBartItem getImmersiveWallpaper()
throws AccException
AccException
public int getMaxFriendlyNameLength()
throws AccException
AccException
public int getMaxEmailAddressLength()
throws AccException
AccException
public int getMaxNoteLength()
throws AccException
AccException
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||