CSmsHeader Class Reference

#include <app/smuthdr.h>

Link against: biowatcher.lib

class CSmsHeader : public CBase

Inherits from

CSmsHeader

Public Member Functions
	~CSmsHeader()
TBioMsgIdType	BioMsgIdType()
CSmsCommand &	Command()
const CSmsCommand &	Command()
IMPORT_C TBool	ContainsSmsHeaderL(const CMsvStore &)
CSmsDeliver &	Deliver()
const CSmsDeliver &	Deliver()
IMPORT_C const CSmsEmailFields &	EmailFields()
IMPORT_C void	ExternalizeL(RMsvWriteStream &)
TPtrC	FromAddress()
IMPORT_C void	GetSmsSettingsL(CSmsMessageSettings &)
IMPORT_C void	InternalizeL(RMsvReadStream &)
CSmsMessage &	Message()
const CSmsMessage &	Message()
IMPORT_C CSmsHeader *	NewL(CSmsPDU::TSmsPDUType, CEditableText &)
IMPORT_C CSmsHeader *	NewL(CSmsPDU::TSmsPDUType, CEditableText &, RFs &)
IMPORT_C CSmsHeader *	NewL(CSmsMessage *)
const CArrayPtrFlat< CSmsNumber > &	Recipients()
CArrayPtrFlat< CSmsNumber > &	Recipients()
TPtrC	ReplyAddressL()
TBool	ReplyPathProvided()
IMPORT_C void	RestoreL(CMsvStore &)
TPtrC	ServiceCenterAddress()
void	SetBioMsgIdType(TBioMsgIdType)
IMPORT_C void	SetEmailFieldsL(const CSmsEmailFields &)
void	SetForwardEmailFieldsL(const CSmsEmailFields &, const TDesC &)
void	SetFromAddressL(const TDesC &)
void	SetReplyEmailFieldsL(const CSmsEmailFields &, const TDesC &)
void	SetReplyPathProvided(TBool)
void	SetServiceCenterAddressL(const TDesC &)
IMPORT_C void	SetSmsSettingsL(const CSmsMessageSettings &)
CSmsStatusReport &	StatusReport()
const CSmsStatusReport &	StatusReport()
IMPORT_C void	StoreL(CMsvStore &)
CSmsSubmit &	Submit()
const CSmsSubmit &	Submit()
CSmsPDU::TSmsPDUType	Type()

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()

Detailed Description

The SMS MTM encapsulation of an SMS message.

This class allows a messaging client to access the lower-level message encapsulation used by the SMS stack.

It also provides functionality to restore and store an SMS message from/to the message store.

An SMS message is encapsulated in a Protocol Data Unit (PDU). In GSM there are six types of SMS message PDU. In the descriptions below, SC means Service Center and MS means Mobile Station (the phone).

1. SMS-DELIVER - sent from SC to MS

2. SMS-DELIVER-REPORT - sent from MS to SC

3. SMS-SUBMIT - sent from MS to SC

4. SMS-SUBMIT-REPORT - sent from SC to MS

5. SMS-STATUS-REPORT - sent from SC to MS

6. SMS-COMMAND - sent from MS to SC

Constructor & Destructor Documentation

~CSmsHeader ( )

IMPORT_C

~CSmsHeader

(

)

Member Function Documentation

BioMsgIdType ( )

TBioMsgIdType

BioMsgIdType

(

)

const [inline]

Gets the message's BIO message type identifier.

For non-BIO messages, this is EBioMsgIdNbs.

Returns: The BIO message type identifier

Command ( )

CSmsCommand &

Command

(

)

[inline]

Gets the message PDU for a SMS-COMMMAND type message.

The message PDU type can be checked by using the CSmsHeader::Type API.

panic: SMCM 0 The message was not a PDU of type SMS-COMMMAND (debug only).

See also: CSmsHeader::Type

Returns: The SMS-COMMMAND PDU object.

Command ( )

const CSmsCommand &

Command

(

)

const [inline]

Gets the (const) message PDU for a SMS-COMMMAND type message.

The message PDU type can be checked by using the CSmsHeader::Type API.

panic: SMCM 0 The message was not a PDU of type SMS-COMMMAND (debug only).

See also: CSmsHeader::Type

Returns: The SMS-COMMMAND PDU const object.

ContainsSmsHeaderL ( const CMsvStore & )

IMPORT_C TBool

ContainsSmsHeaderL

(

const CMsvStore &

aStore

)

Deliver ( )

CSmsDeliver &

Deliver

(

)

[inline]

Gets the message PDU for a SMS-DELIVER type message.

The message PDU type can be checked by using the CSmsHeader::Type API.

panic: SMCM 0 The message was not a PDU of type SMS-DELIVER (debug only).

See also: CSmsHeader::Type

Returns: The SMS-DELIVER PDU object.

Deliver ( )

const CSmsDeliver &

Deliver

(

)

const [inline]

Gets the (const) message PDU for a SMS-DELIVER type message.

The message PDU type can be checked by using the CSmsHeader::Type API.

panic: SMCM 0 The message was not a PDU of type SMS-DELIVER (debug only).

See also: CSmsHeader::Type

Returns: The SMS-DELIVER PDU const object.

EmailFields ( )

IMPORT_C const CSmsEmailFields &

EmailFields

(

)

const

ExternalizeL ( RMsvWriteStream & )

IMPORT_C void

ExternalizeL

(

RMsvWriteStream &

aStream

)

const

FromAddress ( )

TPtrC

FromAddress

(

)

const [inline]

Gets the originator address.

Only valid for SMS-DELIVER and SMS-SUBMIT type messages. With any other message types the returned originator address is empty.

Returns: The originator address.

GetSmsSettingsL ( CSmsMessageSettings & )

IMPORT_C void

GetSmsSettingsL

(

CSmsMessageSettings &

aSmsSettings

)

const

InternalizeL ( RMsvReadStream & )

IMPORT_C void

InternalizeL

(

RMsvReadStream &

aStream

)

Message ( )

CSmsMessage &

Message

(

)

[inline]

Gets the SMS stack representation of the message.

Message ( )

const CSmsMessage &

Message

(

)

const [inline]

Gets the (const) SMS stack representation of the message.

Returns: The const SMS stack representation of the message

NewL ( CSmsPDU::TSmsPDUType, CEditableText & )

IMPORT_C CSmsHeader *	NewL	(	CSmsPDU::TSmsPDUType	aType,
			CEditableText &	aText
		)	[static]

NewL ( CSmsPDU::TSmsPDUType, CEditableText &, RFs & )

IMPORT_C CSmsHeader *	NewL	(	CSmsPDU::TSmsPDUType	aType,
			CEditableText &	aText,
			RFs &	aFs
		)	[static]

NewL ( CSmsMessage * )

IMPORT_C CSmsHeader *

NewL

(

CSmsMessage *

aMessage

)

[static]

Recipients ( )

const CArrayPtrFlat< CSmsNumber > &

Recipients

(

)

const [inline]

Gets the (const) message recipients.

Returns: The const array of message recipients

Recipients ( )

CArrayPtrFlat< CSmsNumber > &

Recipients

(

)

[inline]

Gets the (const) message recipients.

Returns: The array of message recipients

ReplyAddressL ( )

TPtrC

ReplyAddressL

(

)

const

ReplyPathProvided ( )

TBool

ReplyPathProvided

(

)

const [inline]

Tests if the message contains a reply path.

Returns: A value of True if the message contains a reply path.

RestoreL ( CMsvStore & )

IMPORT_C void

RestoreL

(

CMsvStore &

aStore

)

ServiceCenterAddress ( )

TPtrC

ServiceCenterAddress

(

)

const [inline]

Gets the message's service center address.

This can only be used on SMS-SUBMIT type messages. The message PDU type can be checked by using the CSmsHeader::Type API.

panic: SMCM 0 The message was not a PDU of type SMS-SUBMIT (debug only).

See also: CSmsHeader::Type

Returns: The Service Center address.

SetBioMsgIdType ( TBioMsgIdType )

void

SetBioMsgIdType

(

TBioMsgIdType

aBioMsgIdType = EBioMsgIdNbs

)

[inline]

Sets the message's BIO message type identifier.

Parameter	Description
aBioMsgIdType	The BIO message type identifier

SetEmailFieldsL ( const CSmsEmailFields & )

IMPORT_C void

SetEmailFieldsL

(

const CSmsEmailFields &

aEmailFields

)

SetForwardEmailFieldsL ( const CSmsEmailFields &, const TDesC & )

void	SetForwardEmailFieldsL	(	const CSmsEmailFields &	aEmailFields,
			const TDesC &	aForwardSubjectFormat
		)

SetFromAddressL ( const TDesC & )

void

SetFromAddressL

(

const TDesC &

aAddress

)

[inline]

Sets the originator address.

Parameter	Description
aAddress	The originator address

SetReplyEmailFieldsL ( const CSmsEmailFields &, const TDesC & )

void	SetReplyEmailFieldsL	(	const CSmsEmailFields &	aEmailFields,
			const TDesC &	aReplySubjectFormat
		)

SetReplyPathProvided ( TBool )

void

SetReplyPathProvided

(

TBool

aReplyPathProvided

)

[inline]

Set the message flag that indicates whether it contains a reply path.

Parameter	Description
aReplyPathProvided	A value of True to set the flag.

SetServiceCenterAddressL ( const TDesC & )

void

SetServiceCenterAddressL

(

const TDesC &

aAddress

)

[inline]

Sets the message's service center address.

This can only be used on SMS-SUBMIT type messages. The message PDU type can be checked by using the CSmsHeader::Type API.

panic: SMCM 0 The message was not a PDU of type SMS-SUBMIT (debug only).

See also: CSmsHeader::Type

Parameter	Description
aAddress	The Service Center address

SetSmsSettingsL ( const CSmsMessageSettings & )

IMPORT_C void

SetSmsSettingsL

(

const CSmsMessageSettings &

aSmsSettings

)

StatusReport ( )

CSmsStatusReport &

StatusReport

(

)

[inline]

Gets the message PDU for a SMS-STATUS-REPORT type message.

The message PDU type can be checked by using the CSmsHeader::Type API.

panic: SMCM 0 The message was not a PDU of type SMS-STATUS-REPORT (debug only).

See also: CSmsHeader::Type

Returns: The SMS-STATUS-REPORT PDU object.

StatusReport ( )

const CSmsStatusReport &

StatusReport

(

)

const [inline]

Gets the (const) message PDU for a SMS-STATUS-REPORT type message.

The message PDU type can be checked by using the CSmsHeader::Type API.

panic: SMCM 0 The message was not a PDU of type SMS-STATUS-REPORT (debug only).

See also: CSmsHeader::Type

Returns: The SMS-STATUS-REPORT PDU const object.

StoreL ( CMsvStore & )

IMPORT_C void

StoreL

(

CMsvStore &

aStore

)

const

Submit ( )

CSmsSubmit &

Submit

(

)

[inline]

Gets the message PDU for a SMS-SUBMIT type message.

The message PDU type can be checked by using the CSmsHeader::Type API.

panic: SMCM 0 The message was not a PDU of type SMS-SUBMIT (debug only).

See also: CSmsHeader::Type

Returns: The SMS-SUBMIT PDU object.

Submit ( )

const CSmsSubmit &

Submit

(

)

const [inline]

Gets the (const) message PDU for a SMS-SUBMIT type message.

The message PDU type can be checked by using the CSmsHeader::Type API.

panic: SMCM 0 The message was not a PDU of type SMS-SUBMIT (debug only).

See also: CSmsHeader::Type

Returns: The SMS-SUBMIT PDU const object.

Type ( )

CSmsPDU::TSmsPDUType

Type

(

)

const [inline]

Gets the message PDU type.

There are six types of PDU - SMS-DELIVER, SMS-DELIVER-REPORT, SMS-SUBMIT, SMS-SUBMIT-REPORT, SMS-STATUS-REPORT and SMS-COMMAND.

There is access to only to SMS-DELIVER, SMS-SUBMIT, SMS-STATUS-REPORT and SMS-COMMAND PDUs via the CSmsHeader encapsulation.