Collapse all Symbian^3 Application Developer Library

CSmsNumber Class Reference

class CSmsNumber : public CMsvRecipient

Recipient information for an SMS message.

A SMS-SUBMIT message may have several recipients

Inherits from

CSmsNumber
- CMsvRecipient
  - CBase

Public Member Functions
	~CSmsNumber ()
IMPORT_C TSmsAckStatus	AckStatus ( TSmsAckType )
IMPORT_C TPtrC	Address ()
IMPORT_C CSmsNumber &	CopyL (const CSmsNumber &)
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C void	InternalizeL ( RReadStream &)
TLogId	LogId ()
IMPORT_C TPtrC	Name ()
IMPORT_C CSmsNumber *	NewL ()
IMPORT_C CSmsNumber *	NewL (const CSmsNumber &)
IMPORT_C void	SetAckStatus ( TSmsAckType , TSmsAckStatus )
IMPORT_C void	SetAddressL (const TDesC &)
void	SetEmailAddressL (const TDesC &, CSmsEmailFields *, const TDesC &)
void	SetLogId ( TLogId )
IMPORT_C void	SetNameL (const TDesC &)

Private Member Functions
	CSmsNumber ()
TPtrC	LimitStringSize (const TPtrC &, TInt )

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()
	CMsvRecipient::CMsvRecipient()
	CMsvRecipient::Error()const
	CMsvRecipient::IncreaseRetries()
	CMsvRecipient::ResetRetries()
	CMsvRecipient::Retries()const
	CMsvRecipient::SetError(TInt)
	CMsvRecipient::SetStatus(TRecipientStatus)
	CMsvRecipient::Status()const
	CMsvRecipient::Time()
	CMsvRecipient::Time()const

Public Member Enumerations
enum	TSmsAckStatus { ENoAckRequested = 0, EPendingAck , EAckSuccessful , EAckError }

Inherited Enumerations
	CMsvRecipient:TRecipientStatus

Private Attributes
TSmsAckStatus	iDeliveryStatus
TLogId	iLogId
HBufC *	iName
HBufC *	iNumber

Constructor & Destructor Documentation

CSmsNumber()

CSmsNumber

(

)

[private]

~CSmsNumber()

IMPORT_C

~CSmsNumber

(

)

[virtual]

Member Functions Documentation

AckStatus(TSmsAckType)

IMPORT_C TSmsAckStatus

AckStatus

(

TSmsAckType

aAckType

)

const

Parameters

TSmsAckType aAckType

Address()

IMPORT_C TPtrC

Address

(

)

const

CopyL(const CSmsNumber &)

IMPORT_C CSmsNumber &

CopyL

(

const CSmsNumber &

aSmsNumber

)

Parameters

const CSmsNumber & aSmsNumber

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const [virtual]

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

[virtual]

Parameters

RReadStream & aStream

LimitStringSize(const TPtrC &, TInt)

TPtrC	LimitStringSize	(	const TPtrC &	aString,
			TInt	aMaxLength
		)	const [private]

Parameters

const TPtrC & aString
TInt aMaxLength

LogId()

TLogId

LogId

(

)

const [inline]

Gets the ID by which to identify the SMS-DELIVER message PDU for this recipient.

Name()

IMPORT_C TPtrC

Name

(

)

const

NewL()

IMPORT_C CSmsNumber *

NewL

(

)

[static]

NewL(const CSmsNumber &)

IMPORT_C CSmsNumber *

NewL

(

const CSmsNumber &

aSmsNumber

)

[static]

Parameters

const CSmsNumber & aSmsNumber

SetAckStatus(TSmsAckType, TSmsAckStatus)

IMPORT_C void	SetAckStatus	(	TSmsAckType	aAckType,
			TSmsAckStatus	aAckStatus
		)

Parameters

TSmsAckType aAckType
TSmsAckStatus aAckStatus

SetAddressL(const TDesC &)

IMPORT_C void

SetAddressL

(

const TDesC &

aAddress

)

Parameters

const TDesC & aAddress

SetEmailAddressL(const TDesC &, CSmsEmailFields *, const TDesC &)

void	SetEmailAddressL	(	const TDesC &	aAddress,
			CSmsEmailFields *	aEmailFields,
			const TDesC &	aAlias
		)

Parameters

const TDesC & aAddress
CSmsEmailFields * aEmailFields
const TDesC & aAlias

SetLogId(TLogId)

void

SetLogId

(

TLogId

aLogId

)

[inline]

Sets the ID by which to identify the SMS-DELIVER message PDU for this recipient.

Parameters

TLogId aLogId

The log ID for this recipient.

SetNameL(const TDesC &)

IMPORT_C void

SetNameL

(

const TDesC &

aName

)

Parameters

const TDesC & aName

Member Enumerations Documentation

Enum TSmsAckStatus

Defines the status of an acknowledgement for a recipient.

Enumerators

ENoAckRequested = 0	An acknowledgement for this recipient has not been requested.
EPendingAck	The delivery status for this recipient has been requested, but the status report has not yet been received.
EAckSuccessful	A successful acknowledgement for this recipient has been received.
EAckError	A failed acknowledgement for this recipient has been received.

Member Data Documentation

TSmsAckStatus iDeliveryStatus

TSmsAckStatus

iDeliveryStatus

[private]

TLogId iLogId

TLogId

iLogId

[private]

HBufC * iName

HBufC *

iName

[private]

HBufC * iNumber

HBufC *

iNumber

[private]