CSmsSpecialSMSMessageOperations Class Reference

#include <gsmuieoperations.h>

class CSmsSpecialSMSMessageOperations : public CSmsCtrlOperation, public CSmsCtrlOperation

Inherits from

CSmsSpecialSMSMessageOperations
- CSmsCtrlOperation
  - CSmsIEOperation
    - CBase
    - CBase
  - CSmsIEOperation
    - CBase
    - CBase
- CSmsCtrlOperation
  - CSmsIEOperation
    - CBase
    - CBase
  - CSmsIEOperation
    - CBase
    - CBase

Public Member Functions
	CSmsSpecialSMSMessageOperations(CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage &)
	~CSmsSpecialSMSMessageOperations()
IMPORT_C void	AddSpecialMessageIndicationL(TBool, TSmsMessageIndicationType, TExtendedSmsIndicationType, TSmsMessageProfileType, TUint8)
IMPORT_C TUint	GetCountOfSpecialMessageIndicationsL()
IMPORT_C void	GetMessageIndicationIEL(TUint, TBool &, TSmsMessageIndicationType &, TExtendedSmsIndicationType &, TSmsMessageProfileType &, TUint8 &)
IMPORT_C void	RemoveAllSpecialMessageIndicationsL()
IMPORT_C void	RemoveSpecialMessageIndicationL(TSmsMessageIndicationType, TExtendedSmsIndicationType)

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

Inherited Attributes
	CSmsIEOperation::iMessage

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::NewL(CSmsInformationElement::TSmsInformationElementIdentifier,CSmsMessage &,CCnvCharacterSetConverter &,RFs &)
	CSmsIEOperation::operator=(const CSmsIEOperation &)
	CSmsIEOperation::operator==(const CSmsIEOperation &)
	CSmsIEOperation::~CSmsIEOperation()

Detailed Description

Clients use this class to configure a CSmsMessage with a Special SMS Message Indication Information Element per 23.040 v6.5.0 section 9.2.3.24.2.

Constructor & Destructor Documentation

CSmsSpecialSMSMessageOperations ( CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage & )

CSmsSpecialSMSMessageOperations	(	CSmsInformationElement::TSmsInformationElementIdentifier	aId,
		CSmsMessage &	aMessage
	)

~CSmsSpecialSMSMessageOperations ( )

~CSmsSpecialSMSMessageOperations

(

)

[inline]

Member Function Documentation

AddSpecialMessageIndicationL ( TBool, TSmsMessageIndicationType, TExtendedSmsIndicationType, TSmsMessageProfileType, TUint8 )

IMPORT_C void	AddSpecialMessageIndicationL	(	TBool	aStore,
			TSmsMessageIndicationType	aMessageIndicationType,
			TExtendedSmsIndicationType	aExtendedType,
			TSmsMessageProfileType	aProfile,
			TUint8	aMessageCount
		)	const

Either adds a new or updates an existing special message indication information element.

Parameters
aStore	Indicates whether or not the message shall be stored.
aMessageIndicationType	Indicates the basic message type
aExtendedType	Indicates the extended message type
aProfile	Indicates the profile ID of the Multiple Subscriber Profile
aMessageCount	Indicates the number of messages of the type specified in Octet 1 that are waiting

Leave Codes
KErrNotSupported	If the message version or type does not support this query.

Capability
None

GetCountOfSpecialMessageIndicationsL ( )

IMPORT_C TUint

GetCountOfSpecialMessageIndicationsL

(

)

const

Gets a count of the number of special message indication information elements which are stored inside the user data.

Return Value: The number of special message indication information elements which are stored inside the user data.

Leave Codes
KErrNotSupported	If the message version or type does not support this query.

Capability
None

GetMessageIndicationIEL ( TUint, TBool &, TSmsMessageIndicationType &, TExtendedSmsIndicationType &, TSmsMessageProfileType &, TUint8 & )

IMPORT_C void	GetMessageIndicationIEL	(	TUint	aIndex,
			TBool &	aStore,
			TSmsMessageIndicationType &	aMessageIndicationType,
			TExtendedSmsIndicationType &	aExtendedType,
			TSmsMessageProfileType &	aProfile,
			TUint8 &	aMessageCount
		)	const

Gets the attributes of the Special Message Indication specified by aIndex.

Parameters
aIndex	aIndex is a value less than GetCountOfSpecialMessageIndications().
aStore	Indicates whether or not the message shall be stored.
aMessageIndicationType	Indicates the basic message type
aExtendedType	Indicates the extended message type
aProfile	Indicates the profile ID of the Multiple Subscriber Profile
aMessageCount	Indicates the number of messages of the type specified in Octet 1 that are waiting

Leave Codes
KErrNotSupported	If the message version or type does not support this query.
KErrArgument	If aIndex is >= GetCountOfSpecialMessageIndications()

Capability
None

RemoveAllSpecialMessageIndicationsL ( )

IMPORT_C void

RemoveAllSpecialMessageIndicationsL

(

)

const

Removes all Special Message Indications Information Elements contained in the message.

Leave Codes
KErrNotSupported	If the message version or type does not support this query.

Capability
None

RemoveSpecialMessageIndicationL ( TSmsMessageIndicationType, TExtendedSmsIndicationType )

IMPORT_C void	RemoveSpecialMessageIndicationL	(	TSmsMessageIndicationType	aMessageIndicationType,
			TExtendedSmsIndicationType	aExtendedType
		)	const

Removes the Special Message Indication specified by the input attributes, provided it exists.

Parameters
aMessageIndicationType	Indicates the basic message type
aExtendedType	Indicates the extended message type

Leave Codes
KErrNotSupported	If the message version or type does not support this query.

Capability
None

ValidateOperationL ( )

void

ValidateOperationL

(

)

const [protected, virtual]

Reimplemented from CSmsIEOperation::ValidateOperationL()const

Identifies whether the message type or version supports this operation

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

Leave Codes

operator= ( const CSmsSpecialSMSMessageOperations & )

void

operator=

(

const CSmsSpecialSMSMessageOperations &

)

[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

operator== ( const CSmsSpecialSMSMessageOperations & )

TBool

operator==

(

const CSmsSpecialSMSMessageOperations &

)

[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