Symbian^3 Application Developer Library >

TSmsValidityPeriod Class Reference

class TSmsValidityPeriod

TP-VP Validity Period Found in SUBMIT PDUs.

The validy period format is encoded in the first octet of the PDU, so the class takes a reference to a TSmsFirstOctet . The validty period specifies the length of time the PDU lives in the service center if the PDU cannot be immediately delivered.

Public Member Functions
TSmsValidityPeriod ( TSmsFirstOctet &)
void DecodeL ( TGsmuLex8 &)
TUint8 * EncodeL ( TUint8 *)
TUint8 * EncodeL ( TUint8 *, const TEncodeParams *)
void ExternalizeL ( RWriteStream &)
void InternalizeL ( RReadStream &)
void SetTimeIntervalMinutes (const TTimeIntervalMinutes &)
void SetValidityPeriodFormat ( TSmsFirstOctet::TSmsValidityPeriodFormat )
TTime Time ()
const TTimeIntervalMinutes & TimeIntervalMinutes ()
TSmsFirstOctet::TSmsValidityPeriodFormat ValidityPeriodFormat ()
Public Member Enumerations
enum TValidityPeriodLimit { EFiveMinuteUnitLimit  = 143, EHalfHourUnitLimit  = 167, EOneDayUnitLimit  = 196, EOneWeekUnitLimit  = 255 }
enum TValidityPeriodUnitInMinutes { EFiveMinuteUnitInMinutes  = 5, EHalfHourUnitInMinutes  = 30, EOneDayUnitInMinutes  = 1440, EOneWeekUnitInMinutes  = 7*EOneDayUnitInMinutes }
enum TValidityPeriodUnitLimitInMinutes { EFiveMinuteUnitLimitInMinutes  = 24*EHalfHourUnitInMinutes, EHalfHourUnitLimitInMinutes  = EOneDayUnitInMinutes, EOneDayUnitLimitInMinutes  = 30*EOneDayUnitInMinutes, EOneWeekUnitLimitInMinutes  = 63*EOneWeekUnitInMinutes }
Private Attributes
TSmsFirstOctet & iFirstOctet
TTimeIntervalMinutes iTimeIntervalMinutes

Constructor & Destructor Documentation

TSmsValidityPeriod(TSmsFirstOctet &)

TSmsValidityPeriod ( TSmsFirstOctet & aFirstOctet )

Parameters

TSmsFirstOctet & aFirstOctet

Member Functions Documentation

DecodeL(TGsmuLex8 &)

void DecodeL ( TGsmuLex8 & aPdu )

Parameters

TGsmuLex8 & aPdu

EncodeL(TUint8 *)

TUint8 * EncodeL ( TUint8 * aPtr ) const

Parameters

TUint8 * aPtr

EncodeL(TUint8 *, const TEncodeParams *)

TUint8 * EncodeL ( TUint8 * aPtr,
const TEncodeParams * aEncodeParams
) const

Parameters

TUint8 * aPtr
const TEncodeParams * aEncodeParams

ExternalizeL(RWriteStream &)

void ExternalizeL ( RWriteStream & aStream ) const

Parameters

RWriteStream & aStream

InternalizeL(RReadStream &)

void InternalizeL ( RReadStream & aStream )

Parameters

RReadStream & aStream

SetTimeIntervalMinutes(const TTimeIntervalMinutes &)

void SetTimeIntervalMinutes ( const TTimeIntervalMinutes & aTimeIntervalMinutes ) [inline]

Sets the message Validity Period in minutes.

Parameters

const TTimeIntervalMinutes & aTimeIntervalMinutes The message Validity Period in minutes

SetValidityPeriodFormat(TSmsFirstOctet::TSmsValidityPeriodFormat)

void SetValidityPeriodFormat ( TSmsFirstOctet::TSmsValidityPeriodFormat aValidityPeriodFormat ) [inline]

Sets the message Validity Period Format.

Parameters

TSmsFirstOctet::TSmsValidityPeriodFormat aValidityPeriodFormat The message Validity Period Format

Time()

TTime Time ( ) const

TimeIntervalMinutes()

const TTimeIntervalMinutes & TimeIntervalMinutes ( ) const [inline]

Gets the message Validity Period in minutes.

ValidityPeriodFormat()

TSmsFirstOctet::TSmsValidityPeriodFormat ValidityPeriodFormat ( ) const [inline]

Gets the message Validity Period Format.

Member Enumerations Documentation

Enum TValidityPeriodLimit

Limits for validity period units.

Enumerators

EFiveMinuteUnitLimit = 143

Limit for 5 minute validity period unit.

EHalfHourUnitLimit = 167

Limit for 30 minute validity period unit.

EOneDayUnitLimit = 196

Limit for 1 day validity period unit.

EOneWeekUnitLimit = 255

Limit for 1 week validity period unit.

Enum TValidityPeriodUnitInMinutes

Validity period units (in minutes).

Enumerators

EFiveMinuteUnitInMinutes = 5

Five minutes.

EHalfHourUnitInMinutes = 30

30 minutes.

EOneDayUnitInMinutes = 1440

1 day.

EOneWeekUnitInMinutes = 7*EOneDayUnitInMinutes

1 week.

Enum TValidityPeriodUnitLimitInMinutes

Limits for validity period units (in minutes).

Enumerators

EFiveMinuteUnitLimitInMinutes = 24*EHalfHourUnitInMinutes

Limit for 5 minute validity period unit.

EHalfHourUnitLimitInMinutes = EOneDayUnitInMinutes

Limit for 30 minute validity period unit.

EOneDayUnitLimitInMinutes = 30*EOneDayUnitInMinutes

Limit for 1 day validity period unit.

EOneWeekUnitLimitInMinutes = 63*EOneWeekUnitInMinutes

Limit for 1 week validity period unit.

Member Data Documentation

TSmsFirstOctet & iFirstOctet

TSmsFirstOctet & iFirstOctet [private]

TTimeIntervalMinutes iTimeIntervalMinutes

TTimeIntervalMinutes iTimeIntervalMinutes [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.