Collapse all Symbian^3 Product Developer Library

CMessageData Class Reference

class CMessageData : public CBase

Encapsulates the message data for sending services.

Encapsulates the message data for sending services. Class supports externalazation and internalization, which are used to relay message to SendUI server application.

sendui

Since: S60 v3.0

Inherits from

CMessageData
- CBase

Public Member Functions
	~CMessageData()
IMPORT_C void	AppendAttachmentHandleL(const RFile &)
IMPORT_C void	AppendAttachmentL(const TDesC &)
IMPORT_C void	AppendBccAddressL(const TDesC &, const TDesC &)
IMPORT_C void	AppendCcAddressL(const TDesC &, const TDesC &)
IMPORT_C void	AppendToAddressL(const TDesC &, const TDesC &)
IMPORT_C const CDesCArray &	AttachmentArray()
IMPORT_C const RArray< RFile > &	AttachmentHandleArray()
IMPORT_C const CMessageAddressArray &	BccAddressArray()
IMPORT_C const CRichText *	BodyText()
IMPORT_C const CMessageAddressArray &	CcAddressArray()
IMPORT_C void	ClearAddresses()
IMPORT_C void	ClearAttachmentArray()
IMPORT_C TUid	DataType()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
IMPORT_C CMessageData *	NewL()
IMPORT_C CMessageData *	NewLC()
IMPORT_C const TPtrC8	OpaqueData()
IMPORT_C void	SetBodyTextL(const CRichText *)
IMPORT_C void	SetOpaqueDataL(const TDesC8 *, TUid)
IMPORT_C void	SetSubjectL(const TDesC *)
IMPORT_C const TPtrC	Subject()
IMPORT_C const CMessageAddressArray &	ToAddressArray()

Protected Member Functions
	CMessageData()
IMPORT_C void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Protected Attributes
TUid	iDataType

Private Attributes
CMessageDataImpl *	iMessageDataImpl
TAny *	iReserved1
TAny *	iReserved2
TAny *	iReserved3
TAny *	iReserved4
TAny *	iReserved5
RArray< TAny * >	iReserved6

Constructor & Destructor Documentation

CMessageData()

IMPORT_C

CMessageData

(

)

[protected]

C++ default constructor.

~CMessageData()

IMPORT_C

~CMessageData

(

)

[virtual]

Destructor.

Member Functions Documentation

AppendAttachmentHandleL(const RFile &)

IMPORT_C void

AppendAttachmentHandleL

(

const RFile &

aFileHandle

)

Appends attachment handle to the array of attachment handles.

NOTE: Attachment handles should be opened using ShareProtected() file session, otherwise handles can not be transfered through client-server interface.

NOTE: When adding a temporary file as an attachment, always use this method,

Since: Series 60 3.0

Parameters

const RFile & aFileHandle

File handle of the attachment.

AppendAttachmentL(const TDesC &)

IMPORT_C void

AppendAttachmentL

(

const TDesC &

aFilePath

)

Appends attachment file path to the array of attachment file paths. Only a link to the attachment is stored and compared to AppendAttachmentHandleL less resources is used during the send operation.

NOTE: Do not add any temporary files as an attachment. Always use AppendAttachmentHandleL for temporary files.

Since: Series 60 3.0

Parameters

const TDesC & aFilePath

File path of the attachment.

AppendBccAddressL(const TDesC &, const TDesC &)

IMPORT_C void	AppendBccAddressL	(	const TDesC &	aBccAddress,
			const TDesC &	aBccAlias = KNullDesC
		)

Encapsulates Bcc address and alias to CMessageAddress and adds to array.

Since: Series 60 3.0

Parameters

const TDesC & aBccAddress	Real Bcc-address.
const TDesC & aBccAlias = KNullDesC	Alias for the real Bcc-address.

AppendCcAddressL(const TDesC &, const TDesC &)

IMPORT_C void	AppendCcAddressL	(	const TDesC &	aCcAddress,
			const TDesC &	aCcAlias = KNullDesC
		)

Encapsulates CC address and alias to CMessageAddress and adds to array.

Since: Series 60 3.0

Parameters

const TDesC & aCcAddress	Real CC-address.
const TDesC & aCcAlias = KNullDesC	Alias for the real CC-address.

AppendToAddressL(const TDesC &, const TDesC &)

IMPORT_C void	AppendToAddressL	(	const TDesC &	aAddress,
			const TDesC &	aAlias = KNullDesC
		)

Encapsulates address and alias to CMessageAddress and adds to array.

Since: Series 60 3.0

Parameters

const TDesC & aAddress	Real address.
const TDesC & aAlias = KNullDesC	Alias for the real address.

AttachmentArray()

IMPORT_C const CDesCArray &

AttachmentArray

(

)

const

Returns the array of attachment file paths.

Since: Series 60 3.0

AttachmentHandleArray()

IMPORT_C const RArray< RFile > &

AttachmentHandleArray

(

)

const

Returns the array of attachment handles.

Since: Series 60 3.0

BccAddressArray()

IMPORT_C const CMessageAddressArray &

BccAddressArray

(

)

const

Returns array of Bcc addresses and aliases.

Since: Series 60 3.0

BodyText()

IMPORT_C const CRichText *

BodyText

(

)

const

Returns message body text.

Since: Series 60 3.0

CcAddressArray()

IMPORT_C const CMessageAddressArray &

CcAddressArray

(

)

const

Returns array of CC addresses and aliases.

Since: Series 60 3.0

ClearAddresses()

IMPORT_C void

ClearAddresses

(

)

Clears all addressee arrays.

Since: Series 60 3.0

ClearAttachmentArray()

IMPORT_C void

ClearAttachmentArray

(

)

Clears the array of attachment file paths.

Since: Series 60 3.0

ConstructL()

IMPORT_C void

ConstructL

(

)

[protected]

By default Symbian 2nd phase constructor is private.

DataType()

IMPORT_C TUid

DataType

(

)

const

Returns data type id.

This can be used for interpreting the opaque data.

Since: Series 60 3.0

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes message data to a stream

Since: Series 60 3.2

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalizes message data to from a stream

Since: Series 60 3.2

Parameters

RReadStream & aStream

NewL()

IMPORT_C CMessageData *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

IMPORT_C CMessageData *

NewLC

(

)

[static]

Two-phased constructor.

OpaqueData()

IMPORT_C const TPtrC8

OpaqueData

(

)

const

Get opaque data

Since: Series 60 3.2

SetBodyTextL(const CRichText *)

IMPORT_C void

SetBodyTextL

(

const CRichText *

aBodyText

)

Set message body text.

Since: Series 60 3.0

Parameters

const CRichText * aBodyText

Message body text.

SetOpaqueDataL(const TDesC8 *, TUid)

IMPORT_C void	SetOpaqueDataL	(	const TDesC8 *	aData,
			TUid	aDataType
		)

Set opaque data

Since: Series 60 3.2

Parameters

const TDesC8 * aData	Opaque data.
TUid aDataType

SetSubjectL(const TDesC *)

IMPORT_C void

SetSubjectL

(

const TDesC *

aSubject

)

Set message subject.

Since: Series 60 3.0

Parameters

const TDesC * aSubject

Sets message subject. Does not take ownership.

Subject()

IMPORT_C const TPtrC

Subject

(

)

const

Returns message subject.

Since: Series 60 3.0

ToAddressArray()

IMPORT_C const CMessageAddressArray &

ToAddressArray

(

)

const

Returns array of addresses and aliases.

Since: Series 60 3.0

Member Data Documentation

TUid iDataType

TUid

iDataType

[protected]

Data type of this message. Normally this is KSenduiMsgDataBase This can be used for interpreting the opaque data.

CMessageDataImpl * iMessageDataImpl

CMessageDataImpl *

iMessageDataImpl

[private]

Message data implementation. Owned.

TAny * iReserved1

TAny *

iReserved1

[private]

Reserved.

TAny * iReserved2

TAny *

iReserved2

[private]

TAny * iReserved3

TAny *

iReserved3

[private]

TAny * iReserved4

TAny *

iReserved4

[private]

TAny * iReserved5

TAny *

iReserved5

[private]

RArray< TAny * > iReserved6

RArray< TAny * >

iReserved6

[private]