Main Page | Class Hierarchy | Class Members | Global Enums and Constants | Global Entry Points | Related Pages

IAccBartItem Interface Reference


Detailed Description

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.

Public Types

Public Member Functions

Properties


Member Typedef Documentation

typedef enum IAccBartItem::AccBartItemType IAccBartItem::AccBartItemType

Types of BART items. See AccBartItemProp_BartItemType.

typedef enum IAccBartItem::AccBartItemProp IAccBartItem::AccBartItemProp

Properties for the Property method.


Member Enumeration Documentation

enum IAccBartItem::AccBartItemType

Types of BART items. See AccBartItemProp_BartItemType.

Enumerator:
AccBartItemType_SmallIcon 
AccBartItemType_BuddyIcon 
AccBartItemType_StatusText 
AccBartItemType_ArriveSound 
AccBartItemType_RichName 
AccBartItemType_SuperIcon 
AccBartItemType_RadioStation 
AccBartItemType_SuperIconTrigger 
AccBartItemType_StatusTextLink 
AccBartItemType_Location 
AccBartItemType_BigIcon 
AccBartItemType_StatusTextTimestamp 
AccBartItemType_CurrentAvTrack 
AccBartItemType_DepartSound 
AccBartItemType_Wallpaper 
AccBartItemType_ImSound 
AccBartItemType_Badge 
AccBartItemType_ImInitialSound  AccBartItemType_BadgeUrl = 133,.
AccBartItemType_FlashWallpaper 
AccBartItemType_ImmersiveWallpaper 
AccBartItemType_EmoticonSet 

enum IAccBartItem::AccBartItemProp

Properties for the Property method.

Enumerator:
AccBartItemProp_BartItemType  The type of the bart item [get] AccBartItemType*
AccBartItemProp_Official  Whether the bart item is an official (i.e. "AOL OKed") item [get] xp_bool*
AccBartItemProp_Id  The unique id of the bart item, in base64 format [get] xp_str*
AccBartItemProp_IdHex  The unique id of the bart item, in hex format [get] xp_str*
AccBartItemProp_MimeType  The MIME type of the bart item (request) [get] xp_str*
AccBartItemProp_Data  The bart item's data as an array of VT_UI1 (request) [get] xp_array**
AccBartItemProp_DataObject  The bart item's data serialized into an object or string. The exact representation varies, depending on AccBartItemType. (request) [get] xp_variant* [put] xp_kvariant
AccBartItemProp_DataStream  The bart item's data as an IAccStream (request) [get] IAccStream**
AccBartItemProp_BartUrl  The aolbart: URL of the bart item, for display in a web browser [get] xp_str*
AccBartItemProp_Name  The friendly name of the bart item (e.g. "Boing" for a sound) (request) [get] xp_str*


Member Function Documentation

HRESULT IAccBartItem::RequestProperty ( [in] AccBartItemProp  property,
[out, retval] AccTransId pTransId 
)

Request a specific property of the BART item. The result will be asynchronously dispatched through DAccEvents::OnBartItemRequestPropertyResult.


Property Documentation

xp_variant IAccBartItem::Property( [in] AccBartItemProp property) ( [in] AccBartItemProp  property  )  [get]

Get a specific property of the BART item.

xp_kvariant IAccBartItem::Property( [in] AccBartItemProp property) ( [in] AccBartItemProp  property  )  [set]

Set a specific property of the BART item.


Questions? Stop by the AIM SDK Developer Forum
Created Mon Oct 15 18:06:39 2007 for AIM: Developer SDK
© 2007 AOL LLC. All Rights Reserved.