Collapse all Symbian^3 Product Developer Library

CSmsReplyAddressOperations Class Reference

class CSmsReplyAddressOperations : public CSmsCtrlOperation

Clients use this class to configure a CSmsMessage with a reply address per 23.040 v6.5.0 section 9.2.3.24.10.1.17.

Inherits from

CSmsReplyAddressOperations
- CSmsCtrlOperation
  - CSmsIEOperation
    - CBase

Public Member Functions
	CSmsReplyAddressOperations(CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage &, CCnvCharacterSetConverter &, RFs &)
	~CSmsReplyAddressOperations()
IMPORT_C void	AddParsedReplyAddressL(const TGsmSmsTelNumber &)
IMPORT_C void	AddReplyAddressL(const TDesC &)
IMPORT_C TBool	ContainsReplyAddressIEL()
IMPORT_C TInt	GetParsedReplyAddressL(TGsmSmsTelNumber &)
IMPORT_C HBufC *	GetReplyAddressL()
CSmsReplyAddressOperations *	NewL(CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage &, CCnvCharacterSetConverter &, RFs &)
IMPORT_C void	RemoveReplyAddressL()

Protected Member Functions
void	ValidateOperationL()
void	operator=(const CSmsReplyAddressOperations &)
TBool	operator==(const CSmsReplyAddressOperations &)

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()
	CSmsCtrlOperation::CSmsCtrlOperation(CSmsInformationElement::TSmsInformationElementIdentifier,CSmsMessage &)
	CSmsCtrlOperation::operator=(const CSmsCtrlOperation &)
	CSmsCtrlOperation::operator==(const CSmsCtrlOperation &)
	CSmsCtrlOperation::~CSmsCtrlOperation()
	CSmsIEOperation::CSmsIEOperation(CSmsInformationElement::TSmsInformationElementIdentifier,CSmsMessage &)
	CSmsIEOperation::Id()const
	CSmsIEOperation::MessageTypeSupported()const
	CSmsIEOperation::operator=(const CSmsIEOperation &)
	CSmsIEOperation::operator==(const CSmsIEOperation &)
	CSmsIEOperation::~CSmsIEOperation()

Protected Attributes
CCnvCharacterSetConverter &	iCharacterSetConverter
RFs &	iFs

Inherited Attributes
	CSmsIEOperation::iMessage

Constructor & Destructor Documentation

CSmsReplyAddressOperations(CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage &, CCnvCharacterSetConverter &, RFs &)

CSmsReplyAddressOperations	(	CSmsInformationElement::TSmsInformationElementIdentifier	aId,
		CSmsMessage &	aMessage,
		CCnvCharacterSetConverter &	iCharacterSetConverter,
		RFs &	iFs
	)

Parameters

CSmsInformationElement::TSmsInformationElementIdentifier aId
CSmsMessage & aMessage
CCnvCharacterSetConverter & iCharacterSetConverter
RFs & iFs

~CSmsReplyAddressOperations()

~CSmsReplyAddressOperations

(

)

[inline]

Member Functions Documentation

AddParsedReplyAddressL(const TGsmSmsTelNumber &)

IMPORT_C void

AddParsedReplyAddressL

(

const TGsmSmsTelNumber &

aParsedAddress

)

const

Adds a reply address information element.

leave: KErrNotSupported If the message version or type does not support a reply addresses.

leave: KErrAlreadyExists If the message already contains a reply address.

capability: None

Parameters

const TGsmSmsTelNumber & aParsedAddress

AddReplyAddressL(const TDesC &)

IMPORT_C void

AddReplyAddressL

(

const TDesC &

aAddress

)

const

Adds a reply address information element.

leave: KErrNotSupported If the message version or type does not support a reply addresses.

leave: KErrAlreadyExists If the message already contains a reply address.

capability: None

Parameters

const TDesC & aAddress

The international number to be used in the reply address.

ContainsReplyAddressIEL()

IMPORT_C TBool

ContainsReplyAddressIEL

(

)

const

Identifies whether a reply address has already been added to this CSmsMessage using the CSmsReplyAddressOperations interface.

leave: KErrNotSupported If the message version or type does not support this query.

capability: None

GetParsedReplyAddressL(TGsmSmsTelNumber &)

IMPORT_C TInt

GetParsedReplyAddressL

(

TGsmSmsTelNumber &

aParsedAddress

)

const

Returns the reply address in ETSI format.

leave: KErrNotSupported If the message version or type does not support this query.

leave: KErrCorrupt If the reply address is corrupt

capability: None

Parameters

TGsmSmsTelNumber & aParsedAddress

GetReplyAddressL()

IMPORT_C HBufC *

GetReplyAddressL

(

)

const

Returns the reply address as an international number

leave: KErrNotSupported If the message version or type does not support this query.

leave: KErrNotFound If the message does not contain a reply address information element.

leave: KErrCorrupt If the reply address is corrupt

capability: None

NewL(CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage &, CCnvCharacterSetConverter &, RFs &)

CSmsReplyAddressOperations *	NewL	(	CSmsInformationElement::TSmsInformationElementIdentifier	aId,
			CSmsMessage &	aMessage,
			CCnvCharacterSetConverter &	aCharacterSetConverter,
			RFs &	aFs
		)	[static]

This is used by the CSmsMessage to create a CSmsIEOperation. Each instance is owned by the CSmsMessage which created it. Therefore only the CSmsMessage (GSMU component) is allowed to create and delete CSmsIEOperations.

Parameters

CSmsInformationElement::TSmsInformationElementIdentifier aId	The ID for the CSmsInformationElement for whom an operation class needs to be created.
CSmsMessage & aMessage	The CSmsMessage that this operations class belongs to.
CCnvCharacterSetConverter & aCharacterSetConverter	A reference to a character set converter, needed by some derived operation classes.
RFs & aFs	A reference to the file server, needed by some derived operations classes.

RemoveReplyAddressL()

IMPORT_C void

RemoveReplyAddressL

(

)

const

Removes the reply address information element.

leave: KErrNotSupported If the message version or type does not support this query.

capability: None

ValidateOperationL()

void

ValidateOperationL

(

)

const [protected, virtual]

Identifies whether the message type or version supports this operation

leave

If the message type or version does not support this operation.

operator=(const CSmsReplyAddressOperations &)

void

operator=

(

const CSmsReplyAddressOperations &

)

[protected]

Prevent clients from using the assignment operator by including it in the class definition but making it protected and not exporting it.

capability: None

Parameters

const CSmsReplyAddressOperations &

operator==(const CSmsReplyAddressOperations &)

TBool

operator==

(

const CSmsReplyAddressOperations &

)

[protected]

Prevent clients from using the equality operator by including it in the class definition but making it protected and not exporting it.

capability: None

Parameters

const CSmsReplyAddressOperations &

Member Data Documentation

CCnvCharacterSetConverter & iCharacterSetConverter

CCnvCharacterSetConverter &

iCharacterSetConverter

[protected]

RFs & iFs

RFs &

iFs

[protected]