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

• enum AccBartItemType {
    AccBartItemType_SmallIcon = 0,
    AccBartItemType_BuddyIcon = 1,
    AccBartItemType_StatusText = 2,
    AccBartItemType_ArriveSound = 3,
    AccBartItemType_RichName = 4,
    AccBartItemType_SuperIcon = 5,
    AccBartItemType_RadioStation = 6,
    AccBartItemType_SuperIconTrigger = 7,
    AccBartItemType_StatusTextLink = 9,
    AccBartItemType_Location = 11,
    AccBartItemType_BigIcon = 12,
    AccBartItemType_StatusTextTimestamp = 13,
    AccBartItemType_CurrentAvTrack = 15,
    AccBartItemType_DepartSound = 96,
    AccBartItemType_Wallpaper = 129,
    AccBartItemType_ImSound = 131,
    AccBartItemType_Badge = 132,
    AccBartItemType_ImInitialSound = 134,
    AccBartItemType_FlashWallpaper = 136,
    AccBartItemType_ImmersiveWallpaper = 137,
    AccBartItemType_EmoticonSet = 1024
  }
• enum AccBartItemProp {
    AccBartItemProp_BartItemType,
    AccBartItemProp_Official,
    AccBartItemProp_Id,
    AccBartItemProp_IdHex,
    AccBartItemProp_MimeType,
    AccBartItemProp_Data,
    AccBartItemProp_DataObject,
    AccBartItemProp_DataStream,
    AccBartItemProp_BartUrl,
    AccBartItemProp_Name
  }
• typedef enum
  IAccBartItem::AccBartItemType AccBartItemType
• typedef enum
  IAccBartItem::AccBartItemProp AccBartItemProp

Public Member Functions

• HRESULT Property ([in] AccBartItemProp property,[out, retval] xp_variant *value)
• HRESULT Property ([in] AccBartItemProp property,[in] xp_kvariant value)
• HRESULT RequestProperty ([in] AccBartItemProp property,[out, retval] AccTransId *pTransId)

---

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::Property	(	[in] AccBartItemProp	property,
		[out, retval] xp_variant *	value
	)			[get]

Get a specific property of the BART item.

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

Set a specific property of the BART item.

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.