|
||||||||
| 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.AccBartItem
public class AccBartItem
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.
| Method Summary | |
|---|---|
AccBartItemType |
getBartItemType()
The type of the bart item |
java.lang.String |
getBartUrl()
The aolbart: URL of the bart item, for display in a web browser |
byte[] |
getData()
The bart item's data as an array of VT_UI1 |
AccVariant |
getDataObject()
The exact representation varies, depending on AccBartItemType. |
AccStream |
getDataStream()
The bart item's data as an IAccStream |
java.lang.String |
getId()
The unique id of the bart item, in base64 format |
java.lang.String |
getIdHex()
The unique id of the bart item, in hex format |
java.lang.String |
getMimeType()
The MIME type of the bart item |
java.lang.String |
getName()
The friendly name of the bart item (e.g. |
boolean |
getOfficial()
Whether the bart item is an official (i.e. |
int |
requestProperty(AccBartItemProp property)
Request a specific property of the BART item. The result will be asynchronously dispatched through DAccEvents::OnBartItemRequestPropertyResult. |
void |
setDataObject(AccVariant DataObject)
The exact representation varies, depending on AccBartItemType. |
| 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 int requestProperty(AccBartItemProp property)
throws AccException
AccException
public AccBartItemType getBartItemType()
throws AccException
AccException
public boolean getOfficial()
throws AccException
AccException
public java.lang.String getId()
throws AccException
AccException
public java.lang.String getIdHex()
throws AccException
AccException
public java.lang.String getMimeType()
throws AccException
AccException
public byte[] getData()
throws AccException
AccException
public AccVariant getDataObject()
throws AccException
AccException
public void setDataObject(AccVariant DataObject)
throws AccException
AccException
public AccStream getDataStream()
throws AccException
AccException
public java.lang.String getBartUrl()
throws AccException
AccException
public java.lang.String getName()
throws AccException
AccException
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||