Symbian^3 Application Developer Library >

CEnhancedVoiceMailBoxInformation Class Reference

class CEnhancedVoiceMailBoxInformation : public CBase

This is the base class for Enhanced Voice Mail Notifications and Enhanced Voice Mail Delete Confirmations. It encapsulates the attributes and encoding / decoding algorithms common to both types of Enhanced Voice Mail Information Element.

Inherits from

  • CEnhancedVoiceMailBoxInformation
Public Member Functions
~CEnhancedVoiceMailBoxInformation ()
void DecodeL ( TGsmuLex8 &, CCnvCharacterSetConverter &, RFs &)
TUint8 * EncodeL ( TUint8 *, CCnvCharacterSetConverter &, RFs &)
IMPORT_C TBool MaximumCapacity ()
CEnhancedVoiceMailBoxInformation * NewL ()
IMPORT_C TUint8 NumberOfVoiceMessages ()
IMPORT_C void ParsedAccessAddress ( TGsmSmsTelNumber &)
IMPORT_C void SetAccessAddressL (const TDesC &)
IMPORT_C void SetAlmostMaximumCapacity ( TBool )
IMPORT_C void SetMaximumCapacity ( TBool )
IMPORT_C void SetNumberOfVoiceMessages ( TUint8 )
IMPORT_C void SetParsedAccessAddressL (const TGsmSmsTelNumber &)
IMPORT_C void SetProfile ( TSmsMessageProfileType )
IMPORT_C void SetStorage ( TBool )
IMPORT_C TBool Store ()
IMPORT_C TVoiceMailInfoType Type ()
Protected Member Functions
CEnhancedVoiceMailBoxInformation ()
CEnhancedVoiceMailBoxInformation ( TVoiceMailInfoType )
CEnhancedVoiceMailBoxInformation (const CEnhancedVoiceMailBoxInformation &)
void ConstructL ()
void DoSetParsedAddressL (const TDesC &)
void NewBufferL ( TInt )
void operator= (const CEnhancedVoiceMailBoxInformation &)
TBool operator== (const CEnhancedVoiceMailBoxInformation &)
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()
Public Member Enumerations
enum anonymous { KSmsMaxEnhancedVoiceMailSize  = CSmsUserData::KSmsMaxUserDataSize - 3 }
Private Member Enumerations
enum TBitMasks { EMask1Bit  = 0x01, EMask2Bits  = 0x03, EMask4Bits  = 0x0F }
Protected Attributes
HBufC * iAccessAddress
TBool iAlmostFull
TBool iExtensionIndicator
TBool iFull
TUint8 iNumberOfVoiceMessages
TBool iOctet1Bit1
TSmsMessageProfileType iProfile
TBool iStorage
TVoiceMailInfoType iType
TGsmSmsTypeOfAddress iTypeOfAddress

Constructor & Destructor Documentation

CEnhancedVoiceMailBoxInformation()

CEnhancedVoiceMailBoxInformation ( ) [protected]

CEnhancedVoiceMailBoxInformation(TVoiceMailInfoType)

CEnhancedVoiceMailBoxInformation ( TVoiceMailInfoType aTVoiceMailInfoType ) [protected]

Parameters

TVoiceMailInfoType aTVoiceMailInfoType

CEnhancedVoiceMailBoxInformation(const CEnhancedVoiceMailBoxInformation &)

CEnhancedVoiceMailBoxInformation ( const CEnhancedVoiceMailBoxInformation & ) [protected]

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

capability
None

Parameters

const CEnhancedVoiceMailBoxInformation &

~CEnhancedVoiceMailBoxInformation()

~CEnhancedVoiceMailBoxInformation ( ) [virtual]

Member Functions Documentation

ConstructL()

void ConstructL ( ) [protected]

DecodeL(TGsmuLex8 &, CCnvCharacterSetConverter &, RFs &)

void DecodeL ( TGsmuLex8 & aVoiceMailInfo,
CCnvCharacterSetConverter & aCharacterSetConverter,
RFs & aFs
) [virtual]

Parameters

TGsmuLex8 & aVoiceMailInfo
CCnvCharacterSetConverter & aCharacterSetConverter
RFs & aFs

DoSetParsedAddressL(const TDesC &)

void DoSetParsedAddressL ( const TDesC & aAddress ) [protected]

Parameters

const TDesC & aAddress

EncodeL(TUint8 *, CCnvCharacterSetConverter &, RFs &)

TUint8 * EncodeL ( TUint8 * aPtr,
CCnvCharacterSetConverter & aCharacterSetConverter,
RFs & aFs
) const [virtual]

Parameters

TUint8 * aPtr
CCnvCharacterSetConverter & aCharacterSetConverter
RFs & aFs

MaximumCapacity()

IMPORT_C TBool MaximumCapacity ( ) const

NewBufferL(TInt)

void NewBufferL ( TInt aLength ) [protected]

Parameters

TInt aLength

NewL()

CEnhancedVoiceMailBoxInformation * NewL ( ) [static]

NumberOfVoiceMessages()

IMPORT_C TUint8 NumberOfVoiceMessages ( ) const

ParsedAccessAddress(TGsmSmsTelNumber &)

IMPORT_C void ParsedAccessAddress ( TGsmSmsTelNumber & aParsedAddress ) const

Used to get the voice mail box number as a parsed address.

capability
None

Parameters

TGsmSmsTelNumber & aParsedAddress An output parameter which is set to the parsed address.

SetAccessAddressL(const TDesC &)

IMPORT_C void SetAccessAddressL ( const TDesC & aParsedAddress )

Used to set the voice mail box number, overwriting any pre-existing number.

capability
None

Parameters

const TDesC & aParsedAddress The voice mail box address.

SetAlmostMaximumCapacity(TBool)

IMPORT_C void SetAlmostMaximumCapacity ( TBool aIsAlmostFull )

Parameters

TBool aIsAlmostFull

SetMaximumCapacity(TBool)

IMPORT_C void SetMaximumCapacity ( TBool aIsFull )

Used to set or reset the voice mail status to full.

capability
None

Parameters

TBool aIsFull

SetNumberOfVoiceMessages(TUint8)

IMPORT_C void SetNumberOfVoiceMessages ( TUint8 aNumber )

Sets the number of voice messages to a value in the range 0 to 255.

capability
None

Parameters

TUint8 aNumber The number of voice messages.

SetParsedAccessAddressL(const TGsmSmsTelNumber &)

IMPORT_C void SetParsedAccessAddressL ( const TGsmSmsTelNumber & aParsedAddress )

Used to set the voice mail box number as a parsed address

capability
None

Parameters

const TGsmSmsTelNumber & aParsedAddress The parsed address to be used as the voice mail box number.

SetProfile(TSmsMessageProfileType)

IMPORT_C void SetProfile ( TSmsMessageProfileType aProfile )

Parameters

TSmsMessageProfileType aProfile

SetStorage(TBool)

IMPORT_C void SetStorage ( TBool aIsStored )

Configures the storage directive

capability
None

Parameters

TBool aIsStored Set to True if the SM is to be stored in the ME or USIM, False is the SM is to be discarded.

Store()

IMPORT_C TBool Store ( ) const

Indicates whether the SM is to be stored or discarded

capability
None

Type()

IMPORT_C TVoiceMailInfoType Type ( ) const

Indicates whether this message is a Voice Mail Notification or a Voice Mail Deletion Confirmation.

capability
None

operator=(const CEnhancedVoiceMailBoxInformation &)

void operator= ( const CEnhancedVoiceMailBoxInformation & ) [protected]

Parameters

const CEnhancedVoiceMailBoxInformation &

operator==(const CEnhancedVoiceMailBoxInformation &)

TBool operator== ( const CEnhancedVoiceMailBoxInformation & ) [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 CEnhancedVoiceMailBoxInformation &

Member Enumerations Documentation

Enum anonymous

Enumerators

KSmsMaxEnhancedVoiceMailSize = CSmsUserData::KSmsMaxUserDataSize - 3

Enum TBitMasks

Enumerators

EMask1Bit = 0x01
EMask2Bits = 0x03
EMask4Bits = 0x0F

Member Data Documentation

HBufC * iAccessAddress

HBufC * iAccessAddress [protected]

TBool iAlmostFull

TBool iAlmostFull [protected]

TBool iExtensionIndicator

TBool iExtensionIndicator [protected]

TBool iFull

TBool iFull [protected]

TUint8 iNumberOfVoiceMessages

TUint8 iNumberOfVoiceMessages [protected]

TBool iOctet1Bit1

TBool iOctet1Bit1 [protected]

TSmsMessageProfileType iProfile

TSmsMessageProfileType iProfile [protected]

TBool iStorage

TBool iStorage [protected]

TVoiceMailInfoType iType

TVoiceMailInfoType iType [protected]

TGsmSmsTypeOfAddress iTypeOfAddress

TGsmSmsTypeOfAddress iTypeOfAddress [protected]

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.