com.aol.acc
Enum AccBartItemProp

java.lang.Object
  extended by java.lang.Enum<AccBartItemProp>
      extended by com.aol.acc.AccBartItemProp
All Implemented Interfaces:
AccEnum, java.io.Serializable, java.lang.Comparable<AccBartItemProp>

public enum AccBartItemProp
extends java.lang.Enum<AccBartItemProp>
implements AccEnum

The IAccBartItem interface is used to get access to user data. It provides
a handle of sorts on the data, and the data can be downloaded on demand.
"BART" is a generic term that originally meant "Buddy ART", but now
can be used for data that is not multimedia-related.
The data for a BART item is not present until it is downloaded. Once it
is downloaded, it it stored in a cache and can be retrieved immediately.
The consequence of this is that if the data is not in cache,
calling get_Property on any data-related properties (MIME type, data,
stream, object) will return ACC_E_MUST_REQUEST_DATA, indicating that you
must use RequestProperty to asynchronously retrieve the data. In general,
unless you know that the data is in cache, RequestProperty should be used
for the properties marked as "(request)".

Image data is generally GIF, JPG or BMP format. Typically, SmallIcon is
16 x 16 px. SmallIcon max size is 32 x 32 px and 2K. Typically, BuddyIcon
is 48 x 48 px. BuddyIcon max size is 64 x 64 px and 7K. BuddyIcon min size
is 15 x 15 px.

Sound data is generally MP3, WAV or MID format. Sound data max size is 10K.

StatusTextLink max size is 60 bytes as UTF-8. StatusText max size is 251
bytes as UTF-8. AccStringWillTruncateForBartItem() can help in determining
whether a bart string will be truncated.


Enum Constant Summary
BartItemType
          The type of the bart item
BartUrl
          The aolbart: URL of the bart item, for display in a web browser
Data
          The bart item's data as an array of VT_UI1
DataObject
          The exact representation varies, depending on AccBartItemType.
DataStream
          The bart item's data as an IAccStream
Id
          The unique id of the bart item, in base64 format
IdHex
          The unique id of the bart item, in hex format
MimeType
          The MIME type of the bart item
Name
          The friendly name of the bart item (e.g.
Official
          Whether the bart item is an official (i.e.
UNKNOWNVALUE
           
 
Method Summary
 boolean equals(int i)
           
static AccBartItemProp intToEnum(int value)
           
 AccBartItemProp or(AccBartItemProp val)
           
 int value()
           
static AccBartItemProp valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AccBartItemProp[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

UNKNOWNVALUE

public static final AccBartItemProp UNKNOWNVALUE

BartItemType

public static final AccBartItemProp BartItemType
The type of the bart item


Official

public static final AccBartItemProp Official
Whether the bart item is an official (i.e. "AOL OKed") item


Id

public static final AccBartItemProp Id
The unique id of the bart item, in base64 format


IdHex

public static final AccBartItemProp IdHex
The unique id of the bart item, in hex format


MimeType

public static final AccBartItemProp MimeType
The MIME type of the bart item


Data

public static final AccBartItemProp Data
The bart item's data as an array of VT_UI1


DataObject

public static final AccBartItemProp DataObject
The exact representation varies, depending on AccBartItemType.


DataStream

public static final AccBartItemProp DataStream
The bart item's data as an IAccStream


BartUrl

public static final AccBartItemProp BartUrl
The aolbart: URL of the bart item, for display in a web browser


Name

public static final AccBartItemProp Name
The friendly name of the bart item (e.g. "Boing" for a sound)

Method Detail

values

public static final AccBartItemProp[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(AccBartItemProp c : AccBartItemProp.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static AccBartItemProp valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

value

public final int value()
Specified by:
value in interface AccEnum

equals

public final boolean equals(int i)

or

public final AccBartItemProp or(AccBartItemProp val)

intToEnum

public static AccBartItemProp intToEnum(int value)