IAccIm Interface Reference

Detailed Description

The IAccIm interface represents an instant message. By default IAccIms are of the text/x-aolrtf MIME type, and pass their data unchanged to/from the application. IAccIm also supports the ability to convert the content to/from other MIME types, using the GetConvertedText and ConvertToMimeType calls. Supported types include the default text/x-aolrtf, and: application/xhtml+xml application/x-aol-xhtml-div+xml text/plain Applications that want to handle text/x-aolrtf directly do not need to concern themselves with these APIs, but it is strongly recommended that applications use application/xhtml+xml instead. This allows use of standard compose/render controls, and also ensures that the data received by the renderer is sanitized and well-formed. IAccIm will also accept text/html as an input format, to support compose controls that cannot generate XHTML.

Public Types

enum AccImProp {
  AccImProp_MimeType,
  AccImProp_Flags,
  AccImProp_Timestamp,
  AccImProp_Verified,
  AccImProp_Segments,
  AccImProp_SegmentCharsRemaining,
  AccImProp_Cookie,
  AccImProp_ContainsImages,
  AccImProp_AllowImages,
  AccImProp_Subject,
  AccImProp_StreamCount,
  AccImProp_Disposition,
  AccImProp_SerializedText,
  AccImProp_Local,
  AccImProp_AllowedContentFlags,
  AccImProp_ActualContentFlags,
  AccImProp_BartBase = 10000,
  AccImProp_BuddyIcon = AccImProp_BartBase + 1,
  AccImProp_SuperIcon = AccImProp_BartBase + 5,
  AccImProp_SuperIconTrigger = AccImProp_BartBase + 7,
  AccImProp_BigIcon = AccImProp_BartBase + 12,
  AccImProp_Wallpaper = AccImProp_BartBase + 129,
  AccImProp_Sound = AccImProp_BartBase + 131,
  AccImProp_FlashWallpaper = AccImProp_BartBase + 136
}
enum AccImFlags {
  AccImFlags_AutoResponse = 0x01,
  AccImFlags_Store = 0x02,
  AccImFlags_Rtim = 0x04
}
enum AccImContentFlags {
  AccImContentFlags_Image = 0x1,
  AccImContentFlags_Video = 0x2,
  AccImContentFlags_File = 0x4,
  AccImContentFlags_All = AccImContentFlags_Image + AccImContentFlags_Video + AccImContentFlags_File,
  AccImContentFlags_ImageData = 0x10000000,
  AccImContentFlags_ImageUri = 0x20000000
}
typedef enum IAccIm::AccImProp AccImProp
typedef enum IAccIm::AccImFlags AccImFlags
typedef enum
IAccIm::AccImContentFlags AccImContentFlags

Public Member Functions

HRESULT Text ([out, retval] xp_str *text)
HRESULT Text ([in] xp_kstr text)
HRESULT Property ([in] AccImProp property,[out, retval] xp_variant *value)
HRESULT Property ([in] AccImProp property,[in] xp_kvariant value)
HRESULT GetConvertedText ([in] xp_kstr type,[out, retval] xp_str *text)
HRESULT ConvertToMimeType ([in] xp_kstr type)
HRESULT GetStream ([in] xp_kstr id,[out, retval] IAccStream **stream)
HRESULT SetStream ([in] xp_kstr id,[in] IAccStream *stream)

Member Typedef Documentation

typedef enum IAccIm::AccImProp IAccIm::AccImProp

Properties for the Property method.

typedef enum IAccIm::AccImFlags IAccIm::AccImFlags

Values for AccImProp_Flags.

typedef enum IAccIm::AccImContentFlags IAccIm::AccImContentFlags

Values for AccImProp_AllowedContentFlags and AccImProp_ActualContentFlags.

Member Enumeration Documentation

enum IAccIm::AccImProp

Properties for the Property method.

Enumerator:

AccImProp_MimeType	The MIME type of the IM being sent, i.e. text/plain or application/xhtml+xml [get] xp_str* [put] xp_kstr
AccImProp_Flags	The flags for the IM, from AccImFlags [get] xp_u32* [put] xp_u32
AccImProp_Timestamp	The timestamp of the IM [get] xp_date*
AccImProp_Verified	Whether the IM has a verified digital signature [get] xp_bool*
AccImProp_Segments	The number of SMS segments required for this IM [get] xp_s32*
AccImProp_SegmentCharsRemaining	The number of characters remaining in this IM before another SMS segment is required [get] xp_s32*
AccImProp_Cookie	The unique id for this IM [get] xp_str*
AccImProp_ContainsImages	DEPRECATED. Use AccImProp_ActualContentFlags. [get] xp_bool*
AccImProp_AllowImages	DEPRECATED. Use AccImProp_AllowedContentFlags. [get] xp_bool* [put] xp_bool
AccImProp_Subject	The subject (used for away message label) [get] xp_str* [put] xp_kstr
AccImProp_StreamCount	The current number of embedded streams. [get] xp_int*
AccImProp_Disposition	To be set in BeforeImSend/Receive if a plugin wants to intercept an IM Use ACC_E_PLUGIN_ABORTED_ACTION or ACC_E_PLUGIN_CONSUMED_ACTION, as appropriate [get] AccResult* [put] AccResult
AccImProp_SerializedText	A private, serialized representation of the IAccIm. [get] xp_str* [put] xp_kstr
AccImProp_Local	Whether this IM is to be appended as a "status message" in local IM session history instead of being sent over the wire. [get] xp_bool* [put] xp_bool
AccImProp_AllowedContentFlags	Allow or suppress content in this IM when converting to or from xhtml. Ignored when IM sent as standard IM. [get] xp_u32* [put] xp_u32
AccImProp_ActualContentFlags	Flags that describe content of the IM. [get] xp_u32*
AccImProp_BartBase
AccImProp_BuddyIcon	The buddy icon associated with the IM. [get] IAccBartItem** [put] IAccBartItem*
AccImProp_SuperIcon	The super buddy icon associated with the IM. [get] IAccBartItem** [put] IAccBartItem*
AccImProp_SuperIconTrigger	DEPRECATED.
AccImProp_BigIcon	The big icon associated with the IM. Can be 48x48...128x128, GIF/PNG/JPG/JPG2000/SWF [get] IAccBartItem** [put] IAccBartItem*
AccImProp_Wallpaper	The wallpaper associated with the IM. [get] IAccBartItem** [put] IAccBartItem*
AccImProp_Sound	The sound associated with the IM. [get] IAccBartItem** [put] IAccBartItem*
AccImProp_FlashWallpaper	The flash wallpaper associated with the IM. [get] IAccBartItem** [put] IAccBartItem*

enum IAccIm::AccImFlags

Values for AccImProp_Flags.

Enumerator:

AccImFlags_AutoResponse	this IM was an automatic response to a received IM
AccImFlags_Store	this IM is to be stored if recipient is offline (or was stored)
AccImFlags_Rtim	this Direct IM is a Real-Time IM

enum IAccIm::AccImContentFlags

Values for AccImProp_AllowedContentFlags and AccImProp_ActualContentFlags.

Enumerator:

AccImContentFlags_Image	image ('img' element)
AccImContentFlags_Video	video ('embed', 'object' and 'param' elements)
AccImContentFlags_File	file ('file' URI scheme)
AccImContentFlags_All
AccImContentFlags_ImageData	image subtype: embedded data (Direct IM)
AccImContentFlags_ImageUri	image subtype: URI reference to external data

Member Function Documentation

HRESULT IAccIm::Text ( [out, retval] xp_str * text ) [get]

Gets the message text, in the format specified by AccImProp_MimeType.

HRESULT IAccIm::Text ( [in] xp_kstr text ) [set]

Sets the text for the message, in the format specified by AccImProp_MimeType.

HRESULT IAccIm::Property	(	[in] AccImProp	property,
		[out, retval] xp_variant *	value
	)			`[get]`

Get a specific property of the message.

HRESULT IAccIm::Property	(	[in] AccImProp	property,
		[in] xp_kvariant	value
	)			`[set]`

Set a specific property of the message.

HRESULT IAccIm::GetConvertedText	(	[in] xp_kstr	type,
		[out, retval] xp_str *	text
	)

Gets the message text, converted to a specific MIME type.

HRESULT IAccIm::ConvertToMimeType ( [in] xp_kstr type )

Converts the message in-place to a different MIME type.

HRESULT IAccIm::GetStream	(	[in] xp_kstr	id,
		[out, retval] IAccStream **	stream
	)

Gets a copy of a stream object on this IM for reading. This is how embedded data can be retrieved from an IM.

HRESULT IAccIm::SetStream	(	[in] xp_kstr	id,
		[in] IAccStream *	stream
	)

Sets a stream object on this IM. This is how you add embed data to an IM.