com.aol.acc
Class AccUser

java.lang.Object
  extended by com.aol.acc.AccBase
      extended by com.aol.acc.AccUser

public class AccUser
extends AccBase

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

getName

public java.lang.String getName()
                         throws AccException
Get the name for this user.

Throws:
AccException

getGroups

public AccGroup[] getGroups()
                     throws AccException
Return a list of groups the user is in, if any, as an array of IAccGroups.

Throws:
AccException

requestProperty

public int requestProperty(AccUserProp property)
                    throws AccException
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. The result will be dispatched through
DAccEvents::OnUserRequestPropertyResult.

Throws:
AccException

report

public int report(boolean notify,
                  java.lang.String reason)
           throws AccException
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. A text reason may be included
as part of such reports.
Only AOL accounts can 'notify'.
The result is returned via DAccEvents::OnReportUserResult.

Throws:
AccException

getSession

public AccSession getSession()
                      throws AccException
The IAccSession object for the user, if any

Throws:
AccException

getFriendlyName

public java.lang.String getFriendlyName()
                                 throws AccException
The friendly name of the user

Throws:
AccException

setFriendlyName

public void setFriendlyName(java.lang.String FriendlyName)
                     throws AccException
The friendly name of the user

Throws:
AccException

getState

public AccUserState getState()
                      throws AccException
The state of the user, from AccUserState

Throws:
AccException

getFlags

public int getFlags()
             throws AccException
The flags associated with the user, from AccUserFlags

Throws:
AccException

getBlocked

public boolean getBlocked()
                   throws AccException
Whether the user is blocked

Throws:
AccException

setBlocked

public void setBlocked(boolean Blocked)
                throws AccException
Whether the user is blocked

Throws:
AccException

getIgnored

public boolean getIgnored()
                   throws AccException
Whether the user is ignored

Throws:
AccException

setIgnored

public void setIgnored(boolean Ignored)
                throws AccException
Whether the user is ignored

Throws:
AccException

getOnlineTime

public int getOnlineTime()
                  throws AccException
The user's online time, in seconds

Throws:
AccException

getIdleTime

public int getIdleTime()
                throws AccException
The user's idle time, in seconds

Throws:
AccException

getWarningPercent

public int getWarningPercent()
                      throws AccException
The user's warning level

Throws:
AccException

getSmsChargeback

public boolean getSmsChargeback()
                         throws AccException
Whether or not sending a SMS message to the user will be charged

Throws:
AccException

getEmailAddress

public java.lang.String getEmailAddress()
                                 throws AccException
The user's email address

Throws:
AccException

setEmailAddress

public void setEmailAddress(java.lang.String EmailAddress)
                     throws AccException
The user's email address

Throws:
AccException

getNote

public java.lang.String getNote()
                         throws AccException
A locally specified note about the user

Throws:
AccException

setNote

public void setNote(java.lang.String Note)
             throws AccException
A locally specified note about the user

Throws:
AccException

getFrequency

public double getFrequency()
                    throws AccException
The user's frequency score

Throws:
AccException

getInBuddyList

public boolean getInBuddyList()
                       throws AccException
Whether the user is in the buddy list

Throws:
AccException

getTrustedAsBuddy

public boolean getTrustedAsBuddy()
                          throws AccException
Whether the user is a known buddy, i.e. not auto added

Throws:
AccException

getBuddyFeedUpdateTime

public java.util.Date getBuddyFeedUpdateTime()
                                      throws AccException
Time when user's buddy feed last updated

Throws:
AccException

getBuddyFeedViewTime

public java.util.Date getBuddyFeedViewTime()
                                    throws AccException
Time when self last viewed user's buddy feed

Throws:
AccException

setBuddyFeedViewTime

public void setBuddyFeedViewTime(java.util.Date BuddyFeedViewTime)
                          throws AccException
Time when self last viewed user's buddy feed

Throws:
AccException

getBuddyFeedUrl

public java.lang.String getBuddyFeedUrl()
                                 throws AccException
URL for displaying buddy feed

Throws:
AccException

getCapabilities

public java.lang.String[] getCapabilities()
                                   throws AccException
The user's capabilities UUIDs

Throws:
AccException

getCertificate

public AccCertificate getCertificate()
                              throws AccException
The user's signing certificate

Throws:
AccException

getSmallIcon

public AccBartItem getSmallIcon()
                         throws AccException
The user's small icon

Throws:
AccException

getBuddyIcon

public AccBartItem getBuddyIcon()
                         throws AccException
The user's buddy icon

Throws:
AccException

getStatusText

public AccBartItem getStatusText()
                          throws AccException
The user's status text

Throws:
AccException

getArriveSound

public AccBartItem getArriveSound()
                           throws AccException
The user's arrive sound

Throws:
AccException

getRichName

public AccBartItem getRichName()
                        throws AccException
The user's rich text name

Throws:
AccException

getSuperIcon

public AccBartItem getSuperIcon()
                         throws AccException
The user's super buddy icon

Throws:
AccException

getRadioStation

public AccBartItem getRadioStation()
                            throws AccException
The user's current radio station

Throws:
AccException

getSuperIconTrigger

public AccBartItem getSuperIconTrigger()
                                throws AccException
The user's super buddy icon trigger

Throws:
AccException

getStatusTextLink

public AccBartItem getStatusTextLink()
                              throws AccException
The user's status text link

Throws:
AccException

getE911Location

public AccBartItem getE911Location()
                            throws AccException
The user's location for E911 support

Throws:
AccException

getLocation

public AccBartItem getLocation()
                        throws AccException
The user's geographic location

Throws:
AccException

getBigIcon

public AccBartItem getBigIcon()
                       throws AccException
Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF

Throws:
AccException

getStatusTextTimestamp

public AccBartItem getStatusTextTimestamp()
                                   throws AccException
The unix time when AccUserProp_StatusText last changed.

Throws:
AccException

getAvTrack

public AccBartItem getAvTrack()
                       throws AccException
The user's current A/V track

Throws:
AccException

getDepartSound

public AccBartItem getDepartSound()
                           throws AccException
The user's depart sound

Throws:
AccException

getWallpaper

public AccBartItem getWallpaper()
                         throws AccException
The user's wallpaper

Throws:
AccException

getBadge

public AccBartItem getBadge()
                     throws AccException
The user's badge

Throws:
AccException

getFlashWallpaper

public AccBartItem getFlashWallpaper()
                              throws AccException
The user's flash wallpaper

Throws:
AccException

getImmersiveWallpaper

public AccBartItem getImmersiveWallpaper()
                                  throws AccException
The user's immersive expression

Throws:
AccException

getMaxFriendlyNameLength

public int getMaxFriendlyNameLength()
                             throws AccException
Maximum friendly name length

Throws:
AccException

getMaxEmailAddressLength

public int getMaxEmailAddressLength()
                             throws AccException
Maximum email address length

Throws:
AccException

getMaxNoteLength

public int getMaxNoteLength()
                     throws AccException
Maximum user note length

Throws:
AccException