Class CSmsUserData

class CSmsUserData : public CBase;

Description

Operations on the User Data described in TP-UD.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CSmsUserData - Operations on the User Data described in TP-UD

Members

Defined in CSmsUserData:
AddInformationElementL(), Body(), InformationElement(), InformationElementIndex(), IsSupportedL(), KSmsMaxUserDataSize, MaxBodyLengthInChars(), NumInformationElements(), RemoveInformationElement(), SetBodyL(), anonymous

Inherited from CBase:
Delete(), Extension_(), operator new()

inline TInt NumInformationElements() const;

Description

Gets the number of information elements.

Return value

TInt Number of information elements

Capability:

Illegal

IMPORT_C CSmsInformationElement &InformationElement(TInt aIndex) const;

Description

Gets an information element by index.

Parameters

TInt aIndex Index of the information element within the User Data

Return value

CSmsInformationElement & Information element

Capability:

Illegal

IMPORT_C TBool InformationElementIndex(CSmsInformationElement::TSmsInformationElementIdentifier aIdentifier, TInt &aIndex) const;

Description

Gets the index of an information element.

Use InformationELementIndexL to get all elements.

Parameters

CSmsInformationElement::TSmsInformationElementIdentifier aIdentifier An information element Identifier to search for TInt &aIndex The index within the User Data of the information element (if found). If more than 1 instance of this information element exists, then the 1st instance will be returned.

Return value

TBool True if aIdentifier is found in the User Data

Capability:

Illegal

IMPORT_C void AddInformationElementL(TSmsId aIdentifier, const TDesC8 &aData);

Description

Adds an information element. This method can be used to create information elements in the range: 00 - 09 - i.e. Control Information Elements It can be used to create information elements in the following ranges (on the assumption that the information element is intended to be encoded into every PDU): 70 - 7F - i.e. SIM Tool Kit Security Headers 80 - 9F - i.e SMS to SME specific use C0 - CF - i.e. SC specific use

Information elements in the following ranges should not be added using this interface. Instead they should be added using the following identified interfaces: 0A-1F - Use the interfaces provided to support EMS Elements 20 - Use the interfaces provided for Email in CSmsMessage 21 - Use the interface provided by CSmsHyperLinkOperations 22 - Use the interface provided by CSmsReplyAddressOperations 23 - Use the interface provided by CSmsEnhancedVoiceMailOperations

This interface should not be used for information element in the following ranges, these are reserved for future use in TS23.040 V6.5.0 and their characteristics and repeatability have not yet been defined. 24-6F A0-BF E0-FF

KErrNotSupported if the information element is not supported via this interface.

Parameters

TSmsId aIdentifier An information element Identifier for aData const TDesC8 &aData The information element to add to the User Data

Leave codes

Capability:

Illegal

IMPORT_C void RemoveInformationElement(TInt aIndex);

Description

Removes an information element at the specified index.

Parameters

TInt aIndex Information element index

Capability:

Illegal

IMPORT_C TInt MaxBodyLengthInChars() const;

Description

Return value

TInt

Capability:

Illegal

IMPORT_C TPtrC8 Body() const;

Description

Gets the unpacked User Data Elements.

Return value

TPtrC8 Unpacked User Data Elements

Capability:

Illegal

IMPORT_C void SetBodyL(const TDesC8 &aBody);

Description

Sets the User Data (unpacked).

Parameters

const TDesC8 &aBody Unpacked User Data Elements

Capability:

Illegal

IMPORT_C TBool IsSupportedL(TChar aChar);

Description

Tests if the User Data supports a specified character.

Parameters

TChar aChar Character to test

Return value

TBool True if the User Data as configured, supports this character

n/a

Description

KSmsMaxUserDataSize