CSmsPDU Class Reference

#include <gsmupdu.h>

Link against: gsmu.lib

class CSmsPDU : public CBase

Inherits from

  • CSmsPDU
    Protected Attributes
    CSmsAddress *iServiceCenterAddress
    Public Member Enumerations
    enumTSmsPDUType { ESmsDeliver, ESmsDeliverReport, ESmsSubmit, ESmsSubmitReport, ..., ESmsCommand }
    Public Member Functions
    IMPORT_C TSmsDataCodingScheme::TSmsAlphabetAlphabet()
    IMPORT_C TBoolApplicationPortAddressing(TInt &, TInt &, TBool *)
    IMPORT_C TSmsDataCodingScheme::TSmsDCSBits7To4Bits7To4()
    IMPORT_C TBoolClass(TSmsDataCodingScheme::TSmsClass &)
    IMPORT_C TIntConcatenatedMessagePDUIndex()
    IMPORT_C TIntConcatenatedMessageReference()
    IMPORT_C TBoolDataCodingSchemePresent()
    pure virtual voidDecodeL(TGsmuLex8 &)
    IMPORT_C CSmsPDU *DuplicateL()
    IMPORT_C voidEncodeMessagePDUL(TGsmSms &)
    voidEncodeMessagePDUL(TGsmSms &, const TEncodeParams *)
    IMPORT_C voidExternalizeL(RWriteStream &)
    IMPORT_C TSmsDataCodingScheme::TSmsIndicationStateIndicationState()
    IMPORT_C TSmsDataCodingScheme::TSmsIndicationTypeIndicationType()
    IMPORT_C TSmsEncodingNationalLanguageEncoding()
    IMPORT_C CSmsPDU *NewL(RReadStream &, CCnvCharacterSetConverter &, RFs &)
    IMPORT_C CSmsPDU *NewL(const TGsmSms &, CCnvCharacterSetConverter &, RFs &, TBool, TBool)
    IMPORT_C CSmsPDU *NewL(TSmsPDUType, CCnvCharacterSetConverter &, RFs &, TBool)
    IMPORT_C TIntNumConcatenatedMessagePDUs()
    IMPORT_C TSmsProtocolIdentifier::TSmsPIDTypePIDType()
    IMPORT_C voidParsedServiceCenterAddress(TGsmSmsTelNumber &)
    IMPORT_C voidParsedToFromAddress(TGsmSmsTelNumber &)
    IMPORT_C TBoolProtocolIdentifierPresent()
    IMPORT_C TPtrCServiceCenterAddress()
    IMPORT_C voidSetAlphabet(TSmsDataCodingScheme::TSmsAlphabet)
    IMPORT_C voidSetApplicationPortAddressingL(TBool, TInt, TInt, TBool)
    IMPORT_C voidSetBits7To4(TSmsDataCodingScheme::TSmsDCSBits7To4)
    IMPORT_C voidSetClass(TBool, TSmsDataCodingScheme::TSmsClass)
    IMPORT_C voidSetConcatenatedMessagePDUIndex(TInt)
    IMPORT_C voidSetConcatenatedMessageReference(TInt)
    IMPORT_C voidSetDataCodingSchemePresent(TBool)
    IMPORT_C voidSetIndicationState(TSmsDataCodingScheme::TSmsIndicationState)
    IMPORT_C voidSetIndicationType(TSmsDataCodingScheme::TSmsIndicationType)
    IMPORT_C voidSetNationalLanguageEncodingL(TSmsEncoding)
    IMPORT_C voidSetNumConcatenatedMessagePDUs(TInt)
    IMPORT_C voidSetPIDType(TSmsProtocolIdentifier::TSmsPIDType)
    IMPORT_C voidSetParsedServiceCenterAddressL(const TGsmSmsTelNumber &)
    IMPORT_C voidSetParsedToFromAddressL(const TGsmSmsTelNumber &)
    IMPORT_C voidSetProtocolIdentifierPresent(TBool)
    IMPORT_C voidSetServiceCenterAddressL(const TDesC &)
    IMPORT_C voidSetShortMessageType(TSmsProtocolIdentifier::TSmsShortMessageType)
    IMPORT_C voidSetTelematicDeviceIndicator(TSmsProtocolIdentifier::TSmsTelematicDeviceIndicator)
    IMPORT_C voidSetTelematicDeviceType(TSmsProtocolIdentifier::TSmsTelematicDeviceType)
    IMPORT_C voidSetTextCompressed(TBool)
    IMPORT_C voidSetTextConcatenatedL(TBool, TBool)
    IMPORT_C voidSetToFromAddressL(const TDesC &)
    IMPORT_C voidSetUserDataPresent(TBool)
    IMPORT_C TSmsProtocolIdentifier::TSmsShortMessageTypeShortMessageType()
    IMPORT_C TSmsProtocolIdentifier::TSmsTelematicDeviceIndicatorTelematicDeviceIndicator()
    IMPORT_C TSmsProtocolIdentifier::TSmsTelematicDeviceTypeTelematicDeviceType()
    IMPORT_C TBoolTextCompressed()
    IMPORT_C TBoolTextConcatenated(TBool *)
    IMPORT_C TPtrCToFromAddress()
    TSmsPDUType Type()
    voidUpdateConcatenationDataL(TInt, TInt, TInt)
    voidUpdateEmailHeaderDataL(TInt &)
    TBool UpdateSMSCCtrlParameterL(const TUint8)
    TBool UpdateTPSRRL(TSmsFirstOctet)
    IMPORT_C CSmsUserData &UserData()
    IMPORT_C const CSmsUserData &UserData()
    IMPORT_C TBoolUserDataPresent()
    Protected Member Functions
    CSmsPDU(TSmsPDUType)
    pure virtual voidConstructL(CCnvCharacterSetConverter &, RFs &)
    virtual const TSmsDataCodingScheme *DataCodingScheme()
    pure virtual TUint8 *EncodeL(TUint8 *)
    pure virtual TUint8 *EncodeL(TUint8 *, const TEncodeParams *)
    pure virtual voidExternalizeMessagePDUL(RWriteStream &)
    pure virtual voidInternalizeMessagePDUL(RReadStream &)
    virtual const TSmsParameterIndicator *ParameterIndicator()
    virtual const TSmsProtocolIdentifier *ProtocolIdentifier()
    virtual const CSmsAddress *ToFromAddressPtr()
    virtual const CSmsUserData *UserDataPtr()
    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()

    Detailed Description

    A generic interface to a GSM SMS PDU.

    The class can be used on its own to encode GSM SMS PDUs. It is also the base class for the six real implementations of GSM SMS PDUs. The derived classes are built up from the elements defined in gsmuelem.h according to the ETSI GSM 03.40. All the SMS elements have generic encode and decode functions so that each PDU type knows how to encode and decode itself into a TGsmSms.

    CSmsPDU and derived classes provide a human readable interface to a GSM SMS PDU, for example setting the destination address on a SUBMIT (CSmsSubmit). All the factory functions for CSmsPDUs are provided in the base class.

    Member Attribute Documentation

    iServiceCenterAddress

    CSmsAddress *iServiceCenterAddress[protected]

    Member Enumeration Documentation

    Enum TSmsPDUType

    Flags for the 6 basic PDU types in GSM SMS messaging.

    EnumeratorValueDescription
    ESmsDeliver0
    ESmsDeliverReport1
    ESmsSubmit2
    ESmsSubmitReport3
    ESmsStatusReport4
    ESmsCommand5

    Constructor & Destructor Documentation

    CSmsPDU ( TSmsPDUType )

    CSmsPDU(TSmsPDUTypeaSmsPDUType)[protected]

    Member Function Documentation

    Alphabet ( )

    IMPORT_C TSmsDataCodingScheme::TSmsAlphabetAlphabet()const

    Gets the alphabet encoded in the data coding scheme.

    The function panics if the data coding scheme is not present.

    capability
    None

    Returns: Alphabet

    ApplicationPortAddressing ( TInt &, TInt &, TBool * )

    IMPORT_C TBoolApplicationPortAddressing(TInt &aDestination,
    TInt &aOriginator,
    TBool *aIs16Bit = NULL
    )const

    Gets application port addressing information in the user data.

    capability
    None
    ParameterDescription
    aDestinationThe destination port address
    aOriginatorThe originating port address
    aIs16BitSet to true if the addressing is 16 bit. Default is null.

    Returns: True if there is an application port addressing information element in the user data

    Bits7To4 ( )

    IMPORT_C TSmsDataCodingScheme::TSmsDCSBits7To4Bits7To4()const

    Gets bits 7 to 4 on the data coding scheme.

    The value of bits 7 to 4 effects the meaning of the lower order bits.

    The function panics if the data coding scheme is not present.

    capability
    None

    Returns: Bits 7 to 4

    Class ( TSmsDataCodingScheme::TSmsClass & )

    IMPORT_C TBoolClass(TSmsDataCodingScheme::TSmsClass &aClass)const

    Gets the GSM SMS PDU class in the data coding scheme.

    The function panics if the data coding scheme is not present.

    capability
    None
    ParameterDescription
    aClassSms class 0 - 3 encoded in the data coding scheme

    Returns: True if SMS class is defined, else false

    ConcatenatedMessagePDUIndex ( )

    IMPORT_C TIntConcatenatedMessagePDUIndex()const

    Gets the index of the PDU within the Concatenated Message.

    The function panics if the PDU is not concatenated.

    capability
    None

    Returns: Index of the PDU within the Concatenated Message

    ConcatenatedMessageReference ( )

    IMPORT_C TIntConcatenatedMessageReference()const

    Gets the reference contained in the Concatenation Information Element.

    capability
    None

    Returns: Reference contained in the Concatenation Information Element

    ConstructL ( CCnvCharacterSetConverter &, RFs & )

    voidConstructL(CCnvCharacterSetConverter &aCharacterSetConverter,
    RFs &aFs
    )[protected, pure virtual]

    DataCodingScheme ( )

    const TSmsDataCodingScheme *DataCodingScheme()const [protected, virtual]

    DataCodingSchemePresent ( )

    IMPORT_C TBoolDataCodingSchemePresent()const

    Tests if data coding scheme is present.

    Panics if PDU type is unsupported.

    capability
    None

    Returns: True if data coding scheme is present

    DecodeL ( TGsmuLex8 & )

    voidDecodeL(TGsmuLex8 &aPdu)[pure virtual]

    DuplicateL ( )

    IMPORT_C CSmsPDU *DuplicateL()const

    Allocates and constructs a CSmsPDU as a copy of another CSmsPDU.

    capability
    None

    Returns: Newly constructed CSmsPDU-derived object

    EncodeL ( TUint8 * )

    TUint8 *EncodeL(TUint8 *aPtr)const [protected, pure virtual]

    EncodeL ( TUint8 *, const TEncodeParams * )

    TUint8 *EncodeL(TUint8 *aPtr,
    const TEncodeParams *aEncodeParams
    )const [protected, pure virtual]

    EncodeMessagePDUL ( TGsmSms & )

    IMPORT_C voidEncodeMessagePDUL(TGsmSms &aGsmSms)const

    Encodes a TGsmSms for the given type of CSmsPDU.

    capability
    None
    ParameterDescription
    aGsmSmsOn return, encoded GSM SMS PDU

    EncodeMessagePDUL ( TGsmSms &, const TEncodeParams * )

    voidEncodeMessagePDUL(TGsmSms &aGsmSms,
    const TEncodeParams *aEncodeParams
    )const

    ExternalizeL ( RWriteStream & )

    IMPORT_C voidExternalizeL(RWriteStream &aStream)const

    Externalises the object.

    capability
    None
    ParameterDescription
    aStreamStream to write to

    ExternalizeMessagePDUL ( RWriteStream & )

    voidExternalizeMessagePDUL(RWriteStream &aStream)const [protected, pure virtual]

    IndicationState ( )

    IMPORT_C TSmsDataCodingScheme::TSmsIndicationStateIndicationState()const

    Gets the Indication State encoded in the data coding scheme.

    The function panics if the data coding scheme is not present.

    capability
    None

    Returns: Indication State

    IndicationType ( )

    IMPORT_C TSmsDataCodingScheme::TSmsIndicationTypeIndicationType()const

    Gets the Indication Type encoded in the data coding scheme.

    The function panics if the data coding scheme is not present.

    capability
    None

    Returns: Indication Type

    InternalizeMessagePDUL ( RReadStream & )

    voidInternalizeMessagePDUL(RReadStream &aStream)[protected, pure virtual]

    NationalLanguageEncoding ( )

    IMPORT_C TSmsEncodingNationalLanguageEncoding()const

    NewL ( RReadStream &, CCnvCharacterSetConverter &, RFs & )

    IMPORT_C CSmsPDU *NewL(RReadStream &aStream,
    CCnvCharacterSetConverter &aCharacterSetConverter,
    RFs &aFs
    )[static]

    Restores a CSmsPDU from a stream where the object has bean previously persisted.

    The type is determined from the first byte in the stream.

    capability
    None
    ParameterDescription
    aStreamStream from which to restore this CSmsPDU
    aCharacterSetConverterCharacter converter utility, required for encoding and decoding this PDU
    aFsFile system handle, required for encoding and decoding this PDU

    Returns: Newly constructed CSmsPDU-derived object restored from aStream

    NewL ( const TGsmSms &, CCnvCharacterSetConverter &, RFs &, TBool, TBool )

    IMPORT_C CSmsPDU *NewL(const TGsmSms &aGsmSms,
    CCnvCharacterSetConverter &aCharacterSetConverter,
    RFs &aFs,
    TBoolaIsRPError = EFalse,
    TBoolaIsMobileTerminated = ETrue
    )[static]

    Allocates and constructs a CSmsPDU from a TGsmSms.

    The type of SMS to construct is determined from the first octet in aGsmSms and whether the SMS is mobile terminated.

    capability
    None
    ParameterDescription
    aGsmSmsEncoded (raw) GSM SMS PDU
    aCharacterSetConverterCharacter converter utility, required for encoding and decoding this PDU
    aFsFile system handle, required for encoding and decoding this PDU
    aIsRPErrorTrue if the PDU is part of an RP Error. This is used only for SUBMIT REPORT (CSmsSubmitReport) and DELIVER REPORT (CSmsDeliverReport), as the format of these PDUs differs depending on whether the PDU is part of an RP Ack or RP Error.
    aIsMobileTerminatedUsed to determine (with the first octet in aGsmSms) the TSmsPDUType

    Returns: Newly constructed CSmsPDU-derived object restored from aGsmSms

    NewL ( TSmsPDUType, CCnvCharacterSetConverter &, RFs &, TBool )

    IMPORT_C CSmsPDU *NewL(TSmsPDUTypeaType,
    CCnvCharacterSetConverter &aCharacterSetConverter,
    RFs &aFs,
    TBoolaIsRPError = EFalse
    )[static]

    Allocates and constructs a CSmsPDU, with the type specified by a TSmsPDUType.

    capability
    None
    ParameterDescription
    aTypeThe PDU type to construct
    aCharacterSetConverterCharacter converter utility, required for encoding and decoding this PDU
    aFsFile system handle, required for encoding and decoding this PDU
    aIsRPErrorTrue if the PDU is part of an RP Error. This is used only for SUBMIT REPORT (CSmsSubmitReport) and DELIVER REPORT (CSmsDeliverReport), as the format of these PDUs differs depending on whether the PDU is part of an RP Ack or RP Error.

    Returns: Newly constructed CSmsPDU-derived object

    NumConcatenatedMessagePDUs ( )

    IMPORT_C TIntNumConcatenatedMessagePDUs()const

    Gets the number of PDU's in a Concatenated Message.

    The function panics if the PDU is not concatenated.

    capability
    None

    Returns: Number of PDU's in a Concatenated Message

    PIDType ( )

    IMPORT_C TSmsProtocolIdentifier::TSmsPIDTypePIDType()const

    Gets key bits 7 and 6 of the PID field.

    capability
    None

    Returns: Bits 7 and 6 of the PID field

    ParameterIndicator ( )

    const TSmsParameterIndicator *ParameterIndicator()const [protected, virtual]

    ParsedServiceCenterAddress ( TGsmSmsTelNumber & )

    IMPORT_C voidParsedServiceCenterAddress(TGsmSmsTelNumber &aParsedAddress)const

    Gets the service center address in a TGsmSmsTelNumber object.

    A prepended '+', spaces and aphabetic characters are removed.

    capability
    None
    ParameterDescription
    aParsedAddressService center address

    ParsedToFromAddress ( TGsmSmsTelNumber & )

    IMPORT_C voidParsedToFromAddress(TGsmSmsTelNumber &aParsedAddress)const

    Gets the "to from" in a TGsmSmsTelNumber object.

    A prepended '+', spaces and aphabetic characters are removed.

    capability
    None
    ParameterDescription
    aParsedAddressThe destination or sender address

    ProtocolIdentifier ( )

    const TSmsProtocolIdentifier *ProtocolIdentifier()const [protected, virtual]

    ProtocolIdentifierPresent ( )

    IMPORT_C TBoolProtocolIdentifierPresent()const

    Tests if Protocol Identifier is present.

    It panics if the PDU type is unsupported.

    capability
    None

    Returns: True if Protocol Identifier is present

    ServiceCenterAddress ( )

    IMPORT_C TPtrCServiceCenterAddress()const

    Gets the service center address.

    It is assumed that the address is Unicode, and can contain spaces and alphabetic characters.

    capability
    None

    Returns: Service center address

    SetAlphabet ( TSmsDataCodingScheme::TSmsAlphabet )

    IMPORT_C voidSetAlphabet(TSmsDataCodingScheme::TSmsAlphabetaAlphabet)

    Sets the alphabet encoded in the data coding scheme.

    The function panics if the data coding scheme is not present.

    capability
    None
    ParameterDescription
    aAlphabetAlphabet

    SetApplicationPortAddressingL ( TBool, TInt, TInt, TBool )

    IMPORT_C voidSetApplicationPortAddressingL(TBoolaAddressing,
    TIntaDestination,
    TIntaOriginator,
    TBoolaIs16Bit = EFalse
    )

    Sets application port addressing information in the user data.

    capability
    None
    ParameterDescription
    aAddressingIf true, set application port addressing in the PDU. If false, removes addressing if it's already set
    aDestinationThe destination port address to set in the PDU
    aOriginatorThe originating port address to set in the PDU
    aIs16BitTrue if the addresses are 16 bit, false if 8 bit

    SetBits7To4 ( TSmsDataCodingScheme::TSmsDCSBits7To4 )

    IMPORT_C voidSetBits7To4(TSmsDataCodingScheme::TSmsDCSBits7To4aBits7To4)

    Sets key bits 7 to 4 of the data coding scheme.

    This is designed to be used for message waiting indication, as it is not needed for the normal type of data coding scheme where the alphabet and class are defined in the lower order bits.

    The function panics if the data coding scheme is not present.

    capability
    None
    ParameterDescription
    aBits7To4Bits 7 to 4

    SetClass ( TBool, TSmsDataCodingScheme::TSmsClass )

    IMPORT_C voidSetClass(TBoolaClassDefined,
    TSmsDataCodingScheme::TSmsClassaClass
    )

    Sets the GSM SMS PDU class in the data coding scheme.

    The function panics if the data coding scheme is not present.

    capability
    None
    ParameterDescription
    aClassDefinedTrue if SMS class is defined, else false
    aClassSms class 0 - 3 encoded in the data coding scheme

    SetConcatenatedMessagePDUIndex ( TInt )

    IMPORT_C voidSetConcatenatedMessagePDUIndex(TIntaIndex)

    Sets the index of the PDU within the Concatenated Message.

    The function panics if the PDU is not concatenated or aIndex is out of range.

    capability
    None
    ParameterDescription
    aIndexIndex of the PDU within the Concatenated Message

    SetConcatenatedMessageReference ( TInt )

    IMPORT_C voidSetConcatenatedMessageReference(TIntaReference)

    Sets the reference contained in the Concatenation Information Element.

    The function panics if aReference is out of range for the message type.

    capability
    None
    ParameterDescription
    aReferenceValue to set the Concatenated Message Reference.

    SetDataCodingSchemePresent ( TBool )

    IMPORT_C voidSetDataCodingSchemePresent(TBoolaPresent)

    Sets if data coding scheme is present.

    capability
    None
    ParameterDescription
    aPresentTrue if data coding scheme is present

    SetIndicationState ( TSmsDataCodingScheme::TSmsIndicationState )

    IMPORT_C voidSetIndicationState(TSmsDataCodingScheme::TSmsIndicationStateaState)

    Sets the Indication State encoded in the data coding scheme.

    The function panics if the data coding scheme is not present.

    capability
    None
    ParameterDescription
    aStateIndication State

    SetIndicationType ( TSmsDataCodingScheme::TSmsIndicationType )

    IMPORT_C voidSetIndicationType(TSmsDataCodingScheme::TSmsIndicationTypeaType)

    Sets the Indication Type encoded in the data coding scheme.

    The function panics if the data coding scheme is not present.

    capability
    None
    ParameterDescription
    aTypeIndication Type

    SetNationalLanguageEncodingL ( TSmsEncoding )

    IMPORT_C voidSetNationalLanguageEncodingL(TSmsEncodingaEncoding)

    SetNumConcatenatedMessagePDUs ( TInt )

    IMPORT_C voidSetNumConcatenatedMessagePDUs(TIntaNum)

    Sets the number of PDU's in a Concatenated Message.

    The function panics if the PDU is not concatenated or if aNum is out of range.

    capability
    None
    ParameterDescription
    aNumNumber of PDU's in a Concatenated Message

    SetPIDType ( TSmsProtocolIdentifier::TSmsPIDType )

    IMPORT_C voidSetPIDType(TSmsProtocolIdentifier::TSmsPIDTypeaSmsPIDType)

    Sets key bits 7 and 6 of the PID field.

    capability
    None
    ParameterDescription
    aSmsPIDTypeBits 7 and 6 of the PID field

    SetParsedServiceCenterAddressL ( const TGsmSmsTelNumber & )

    IMPORT_C voidSetParsedServiceCenterAddressL(const TGsmSmsTelNumber &aParsedAddress)

    Sets the service center address through a TGsmSmsTelNumber object.

    These functions panic for a DELIVER REPORT (CSmsDeliverReport) or a SUBMIT REPORT (CSmsSubmitReport).

    capability
    None
    ParameterDescription
    aParsedAddressService center address

    SetParsedToFromAddressL ( const TGsmSmsTelNumber & )

    IMPORT_C voidSetParsedToFromAddressL(const TGsmSmsTelNumber &aParsedAddress)

    Sets the "to from" with a TGsmSmsTelNumber object.

    capability
    None
    ParameterDescription
    aParsedAddressThe destination or sender address

    SetProtocolIdentifierPresent ( TBool )

    IMPORT_C voidSetProtocolIdentifierPresent(TBoolaPresent)

    Sets if Protocol Identifier is present.

    It panics if the PDU type is unsupported.

    capability
    None
    ParameterDescription
    aPresentTrue if Protocol Identifier is present

    SetServiceCenterAddressL ( const TDesC & )

    IMPORT_C voidSetServiceCenterAddressL(const TDesC &aAddress)

    Sets the service center address.

    A prepended '+' is used to indicate an international number.

    capability
    None
    ParameterDescription
    aAddressService center address

    SetShortMessageType ( TSmsProtocolIdentifier::TSmsShortMessageType )

    IMPORT_C voidSetShortMessageType(TSmsProtocolIdentifier::TSmsShortMessageTypeaShortMessageType)

    Sets the Short Message Type in the PID field.

    capability
    None
    ParameterDescription
    aShortMessageTypeShort Message Type

    SetTelematicDeviceIndicator ( TSmsProtocolIdentifier::TSmsTelematicDeviceIndicator )

    IMPORT_C voidSetTelematicDeviceIndicator(TSmsProtocolIdentifier::TSmsTelematicDeviceIndicatoraIndicator)

    Sets the Telematic device indicator from the PID field.

    capability
    None
    ParameterDescription
    aIndicatorTelematic device indicator

    SetTelematicDeviceType ( TSmsProtocolIdentifier::TSmsTelematicDeviceType )

    IMPORT_C voidSetTelematicDeviceType(TSmsProtocolIdentifier::TSmsTelematicDeviceTypeaDeviceType)

    Sets the Telematic device type in the PID field.

    capability
    None
    ParameterDescription
    aDeviceTypeTelematic device type

    SetTextCompressed ( TBool )

    IMPORT_C voidSetTextCompressed(TBoolaCompressed)

    Set to encode Text Compressed in the data coding scheme.

    The function panics if the data coding scheme is not present.

    capability
    None
    ParameterDescription
    aCompressedTrue to encode Text Compressed

    SetTextConcatenatedL ( TBool, TBool )

    IMPORT_C voidSetTextConcatenatedL(TBoolaConcatenated,
    TBoolaIs16Bit = EFalse
    )

    Sets whether the PDU is part of a concatenated message or not.

    It is a leaving function as it is inserting an information element into the user data.

    capability
    None
    ParameterDescription
    aConcatenatedTrue if message is concatenated
    aIs16BitTrue if type of Concatenation Information Element is 16 bit

    SetToFromAddressL ( const TDesC & )

    IMPORT_C voidSetToFromAddressL(const TDesC &aAddress)

    Sets the "to from" address.

    The function panics for a DELIVER REPORT (CSmsDeliverReport) or a SUBMIT REPORT (CSmsSubmitReport).

    A prepended '+' is used to indicate an international number.

    capability
    None
    ParameterDescription
    aAddressThe destination or sender address

    SetUserDataPresent ( TBool )

    IMPORT_C voidSetUserDataPresent(TBoolaPresent)

    Sets or unsets the User Data Header Indicator.

    It panics if PDU type is unsupported.

    capability
    None
    ParameterDescription
    aPresentTrue to set the User Data Header Indicator

    ShortMessageType ( )

    IMPORT_C TSmsProtocolIdentifier::TSmsShortMessageTypeShortMessageType()const

    Gets the Short Message Type in the PID field.

    capability
    None

    Returns: Short Message Type

    TelematicDeviceIndicator ( )

    IMPORT_C TSmsProtocolIdentifier::TSmsTelematicDeviceIndicatorTelematicDeviceIndicator()const

    Gets the Telematic device indicator from the PID field.

    capability
    None

    Returns: Telematic device indicator

    TelematicDeviceType ( )

    IMPORT_C TSmsProtocolIdentifier::TSmsTelematicDeviceTypeTelematicDeviceType()const

    Gets the Telematic device type in the PID field.

    capability
    None

    Returns: Telematic device type

    TextCompressed ( )

    IMPORT_C TBoolTextCompressed()const

    True if Text Compressed is encoded in the data coding scheme.

    The function panics if the data coding scheme is not present.

    capability
    None

    Returns: True if Text Compressed is encoded

    TextConcatenated ( TBool * )

    IMPORT_C TBoolTextConcatenated(TBool *aIs16Bit = NULL)const

    Tests if the PDU is part of a concatenated message.

    capability
    None
    ParameterDescription
    aIs16BitContent is set true if Concatenation Information Element is 16-bit. Default is null.

    Returns: True if the PDU is part of a concatenated message.

    ToFromAddress ( )

    IMPORT_C TPtrCToFromAddress()const

    Gets the "to from" address.

    This address is the original (sender's) address for a DELIVER (CSmsDeliver), the destination address for a SUBMIT (CSmsSubmit), the recipient (sender's) address for a STATUS REPORT (CSmsStatusReport) and the destination address for a COMMAND (CSmsCommand).

    The function panics for a DELIVER REPORT (CSmsDeliverReport) or a SUBMIT REPORT (CSmsSubmitReport).

    It is assumed that the address is Unicode, and can contain spaces and alphabetic characters.

    capability
    None

    Returns: The destination or sender address

    ToFromAddressPtr ( )

    const CSmsAddress *ToFromAddressPtr()const [protected, virtual]

    Type ( )

    TSmsPDUType Type()const [inline]

    UpdateConcatenationDataL ( TInt, TInt, TInt )

    voidUpdateConcatenationDataL(TIntaRef,
    TIntaPduIndex,
    TIntaMaxPdu
    )

    Updates the three pieces of concatenation data (reference number, pdu index and max pdu number) in this PDU.

    ParameterDescription
    aRefReference number.
    aPduIndexCurrent PDU number.
    aMaxPduTotal PDU number.

    UpdateEmailHeaderDataL ( TInt & )

    voidUpdateEmailHeaderDataL(TInt &aEmailOverallHeaderLength)

    Updates the email header data in this PDU.

    ParameterDescription
    aEmailOverallHeaderLengthLength of the email header.

    UpdateSMSCCtrlParameterL ( const TUint8 )

    TBool UpdateSMSCCtrlParameterL(const TUint8aOctet)

    Updates the SMSC control parameter in this PDU.

    ParameterDescription
    aOctetValue to store in the SMSC control parameter.

    UpdateTPSRRL ( TSmsFirstOctet )

    TBool UpdateTPSRRL(TSmsFirstOctetaSmsReportRequest)

    Updates the TPSRRL control parameter in this PDU.

    ParameterDescription
    aSmsReportRequestStatus Report Request setting.

    Returns: Always returns ETrue.

    UserData ( )

    IMPORT_C CSmsUserData &UserData()

    Gets User Data (non-const).

    capability
    None

    Returns: User Data

    UserData ( )

    IMPORT_C const CSmsUserData &UserData()const

    Gets User Data (const).

    capability
    None

    Returns: User Data

    UserDataPresent ( )

    IMPORT_C TBoolUserDataPresent()const

    Tests if the User Data Header Indicator is set.

    It panics if PDU type is unsupported.

    capability
    None

    Returns: True if the User Data Header Indicator is set

    UserDataPtr ( )

    const CSmsUserData *UserDataPtr()const [protected, virtual]
    © Nokia 2011.