Class TMsvMessageSms

class TMsvMessageSms : public TMsvMessageBio;

Description

Proxy that provides a generic text message interface to the underlying container (CSmsMessage) which is tailored mainly for GSM.

Derivation

• TMsvMessageBio - Proxy that provides a bearer independent interface to the underlying container ( CSmsMessage) which is tailored mainly for GSM

• TMsvMessageSms - Proxy that provides a generic text message interface to the underlying container ( CSmsMessage) which is tailored mainly for GSM

Members

Defined in TMsvMessageSms:
AddEMSInformationElementL(), GetEMSInformationElementsL(), GetMessageServiceCenterTimeStamp(), GetValidityPeriodAbsolute(), GetValidityPeriodRelative(), RemoveEMSInformationElementL(), RemoveEMSInformationElementsL(), ResetEMSL(), SetValidityPeriodAbsoluteL(), SetValidityPeriodRelativeL(), ValidityPeriodFormat()

Inherited from TMsvMessageBio:
BioMsgIdType(), Encoding(), OriginatingAddress(), SetBioMsgIdType(), SetEncoding(), iSmsHeader

IMPORT_C TSmsTimePeriodFormat ValidityPeriodFormat() const;

Description

Returns the format in which the validity period is stored

Return value

TSmsTimePeriodFormat TSmsTimePeriodFormat for the validity period

Panic codes

SMCM 19 Current message is not set (debug only) SMCM 18 Message bearing is inward (debug only)

IMPORT_C TInt GetValidityPeriodAbsolute(TDateTime &arValidityPeriod) const;

Description

The Validity Period - Absolute subparameter indicates to the message center the message expiration time, after which the message should be discarded if not delivered to the destination.

Parameters

TDateTime &arValidityPeriod absolute validity period

Return value

TInt KErrNone if returned value is valid

Panic codes

SMCM 18 Message bearing is inward (debug only) SMCM 3 ValidityPeriod format is not absolute (debug only)

IMPORT_C TInt SetValidityPeriodAbsoluteL(const TDateTime &aValidityPeriod);

Description

The Validity Period - Absolute subparameter indicates to the message center the message expiration time, after which the message should be discarded if not delivered to the destination.

Parameters

const TDateTime &aValidityPeriod validity period

Return value

TInt KErrNone if value was applied successfully,

Leave codes

KErrOverflow if the time cannot be expressed in minutes from now, KErrUnderflow if the expiration time is in the past

Panic codes

SMCM 19 Current message is not set (debug only) SMCM 18 Message bearing is inward (debug only)

IMPORT_C TInt GetValidityPeriodRelative(TSmsRelativeTimeUnit &arTimeUnit, TUint32 &aRelativeTime) const;

Description

The Validity Period - Relative subparameter indicates to the message center the time period, beginning from the time the message is received by the message center, after which the message should be discarded if not delivered to the destination. May also be used to indicate the time period to retain a message sent to a mobile station.

Parameters

TSmsRelativeTimeUnit &arTimeUnit time period (minutes, hours, etc.) TUint32 &aRelativeTime time period value

Return value

TInt KErrNone if returned value is valid

Panic codes

SMCM 19 Current message is not set (debug only) SMCM 18 Message bearing is inward (debug only) SMCM 3 Validity period is absolute (debug only)

IMPORT_C TInt SetValidityPeriodRelativeL(TSmsRelativeTimeUnit aTimeUnit, TUint32 aRelativeTime);

Description

The Validity Period - Relative subparameter indicates to the message center the time period, beginning from the time the message is received by the message center, after which the message should be discarded if not delivered to the destination. May also be used to indicate the time period to retain a message sent to a mobile station.

Parameters

TSmsRelativeTimeUnit aTimeUnit time period (minutes, hours, etc.) TUint32 aRelativeTime time period value

Return value

TInt KErrNone if value was applied successfully

Panic codes

SMCM 19 Current message is not set (debug only) SMCM 18 Message bearing is inward (debug only)

IMPORT_C TInt GetMessageServiceCenterTimeStamp(TDateTime &arTimeStamp, TInt &arQuarterHourUTCOffset) const;

Description

Time that the message was received by the message center

Parameters

TDateTime &arTimeStamp message center time stamp TInt &arQuarterHourUTCOffset time zone offset in quarter hours

Return value

TInt KErrNone if returned value is valid

Panic codes

SMCM 19 Current message is not set (debug only) SMCM 18 Message bearing is inward (debug only)

IMPORT_C const RPointerArray< const CEmsInformationElement > &GetEMSInformationElementsL() const;

Description

Retrieves EMS IE from the message

Return value

const RPointerArray< const CEmsInformationElement > & reference to internal EMS array

Panic codes

SMCM 19 Current message is not set (debug only)

IMPORT_C void AddEMSInformationElementL(const CEmsInformationElement &aEmsIE);

Description

Adds EMS Information Element to the message

Parameters

const CEmsInformationElement &aEmsIE EMS object to be added.

Leave codes

KErrNoMemory when not enough memory

Panic codes

SMCM 19 Current message is not set (debug only) SMCM 18 Message bearing is inward (debug only) SMCM 23 Teleservice does not support EMS (debug only)

IMPORT_C RPointerArray< CEmsInformationElement > *RemoveEMSInformationElementsL(const TUint aStartPosition, const TSmsId aEmsId);

Description

Removes all EMS IEs that matches the criteria from the message

Parameters

const TUint aStartPosition of a EMS object to be removed. const TSmsId aEmsId type of a EMS object to be removed

Return value

RPointerArray< CEmsInformationElement > * pointer to array of EMS IE

Panic codes

SMCM 19 Current message is not set (debug only) SMCM 18 Message bearing is inward (debug only) SMCM 23 Teleservice does not support EMS (debug only)

IMPORT_C CEmsInformationElement *RemoveEMSInformationElementL(const TUint aStartPosition, const TSmsId aEmsId);

Description

Removes first EMS IE that matches the criteria from the message

Parameters

const TUint aStartPosition of a EMS object to be removed. const TSmsId aEmsId type of a EMS object to be removed

Return value

CEmsInformationElement * pointer to EMS information element

Panic codes

SMCM 19 Current message is not set (debug only) SMCM 18 Message bearing is inward (debug only) SMCM 23 Teleservice does not support EMS (debug only)

IMPORT_C void ResetEMSL();

Description

Resets EMS IE from the message

Panic codes

SMCM 19 Current message is not set (debug only) SMCM 18 Message bearing is inward (debug only) SMCM 23 Teleservice does not support EMS (debug only)