Class CSmsNumber

class CSmsNumber : public CMsvRecipient;

Description

Recipient information for an SMS message.

A SMS-SUBMIT message may have several recipients

Derivation

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

• CMsvRecipient - Base class for information relating to a message recipient

• CSmsNumber - Recipient information for an SMS message

Members

Defined in CSmsNumber:
AckStatus(), AckStatus(), Address(), Address(), CopyL(), CopyL(), EAckError, EAckError, EAckSuccessful, EAckSuccessful, ENoAckRequested, ENoAckRequested, EPendingAck, EPendingAck, ExternalizeL(), ExternalizeL(), InternalizeL(), InternalizeL(), LogId(), LogId(), MessageId(), Name(), Name(), NewL(), NewL(), NewL(), NewL(), SetAckStatus(), SetAckStatus(), SetAddressL(), SetAddressL(), SetLogId(), SetLogId(), SetNameL(), SetNameL(), SetUserAck(), TSmsAckStatus, TSmsAckStatus, UserAck(), ValidateAddress(), ~CSmsNumber(), ~CSmsNumber()

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

Inherited from CMsvRecipient:
EFailedToSend, ENotYetSent, ESentSuccessfully, Error(), IncreaseRetries(), ResetRetries(), Retries(), SetError(), SetStatus(), Status(), TRecipientStatus, Time()

static IMPORT_C CSmsNumber *NewL();

Description

Creates and allocates a new CSmsNumber object.

Return value

CSmsNumber * The new object.

static IMPORT_C CSmsNumber *NewL(const CSmsNumber &aSmsNumber);

Description

Creates and allocates a new CSmsNumber object, copying an existing object.

Parameters

const CSmsNumber &aSmsNumber The object to be copied.

Return value

CSmsNumber * The new object.

virtual IMPORT_C ~CSmsNumber();

Description

Destructor.

static IMPORT_C CSmsNumber *NewL();

Description

Return value

CSmsNumber *

static IMPORT_C CSmsNumber *NewL(const CSmsNumber &aSmsNumber);

Description

Parameters

const CSmsNumber &aSmsNumber

Return value

CSmsNumber *

virtual IMPORT_C ~CSmsNumber();

Description

virtual IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises the object from a read stream.

Parameters

RReadStream &aStream The stream from which the object should be internalised.

virtual IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the object to a write stream.

Parameters

RWriteStream &aStream The stream to which the object should be externalised.

IMPORT_C TPtrC Address() const;

Description

Gets the recipient address.

The address is a telephone number. It is limited to a maximum length specified by KSmcmSmsNumberMaxNumberLength.

Return value

TPtrC A descriptor with the recipient address.

See also:

• KSmcmSmsNumberMaxNumberLength

IMPORT_C void SetAddressL(const TDesC &aAddress);

Description

Sets the recipient address.

The address is a telephone number. It is limited to a maximum length specified by KSmcmSmsNumberMaxNumberLength.

Parameters

const TDesC &aAddress The recipient address.

See also:

• KSmcmSmsNumberMaxNumberLength

IMPORT_C TPtrC Name() const;

Description

Gets the recipient name.

Return value

TPtrC A descriptor with the recipient name.

IMPORT_C void SetNameL(const TDesC &aName);

Description

Sets the recipient name.

The name is limited to a maximum length specified by KSmcmSmsNumberMaxNameLength.

Parameters

const TDesC &aName The recipient name.

See also:

• KSmcmSmsNumberMaxNameLength

inline TLogId LogId() const;

Description

Gets the ID by which to identify the SMS-DELIVER message PDU for this recipient.

Return value

TLogId The log ID for this recipient.

inline void SetLogId(TLogId aLogId);

Description

Sets the ID by which to identify the SMS-DELIVER message PDU for this recipient.

Parameters

TLogId aLogId The log ID for this recipient.

IMPORT_C CSmsNumber &CopyL(const CSmsNumber &aSmsNumber);

Description

Copies settings from another CSmsNumber object.

Parameters

const CSmsNumber &aSmsNumber The object to be copied.

Return value

CSmsNumber & This object with the updated settings.

IMPORT_C TSmsAckStatus AckStatus(TSmsAckType aAckType) const;

Description

Gets the delivery status for this recipient.

Parameters

TSmsAckType aAckType

Return value

TSmsAckStatus The current delivery status for this recipient.

IMPORT_C void SetAckStatus(TSmsAckType aAckType, TSmsAckStatus aAckStatus);

Description

Sets the delivery status for this recipient.

Parameters

TSmsAckType aAckType TSmsAckStatus aAckStatus

virtual IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Parameters

RReadStream &aStream

virtual IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Parameters

RWriteStream &aStream

IMPORT_C TPtrC Address() const;

Description

Return value

TPtrC

IMPORT_C void SetAddressL(const TDesC &aAddress);

Description

Parameters

const TDesC &aAddress

IMPORT_C TPtrC Name() const;

Description

Return value

TPtrC

IMPORT_C void SetNameL(const TDesC &aName);

Description

Parameters

const TDesC &aName

inline TLogId LogId() const;

Description

Return value

TLogId

inline void SetLogId(TLogId aLogId);

Description

Parameters

TLogId aLogId

IMPORT_C CSmsNumber &CopyL(const CSmsNumber &aSmsNumber);

Description

Parameters

const CSmsNumber &aSmsNumber

Return value

CSmsNumber &

IMPORT_C TSmsAckStatus AckStatus(TSmsAckType aAckType) const;

Description

Parameters

TSmsAckType aAckType

Return value

TSmsAckStatus

IMPORT_C void SetAckStatus(TSmsAckType aAckType, TSmsAckStatus aAckStatus);

Description

Parameters

TSmsAckType aAckType TSmsAckStatus aAckStatus

IMPORT_C TUint8 UserAck() const;

Description

Returns the User acknownledgement Message ID

Return value

TUint8

IMPORT_C void SetUserAck(TUint8 aUserResponseCode);

Description

Assigns the User acknownledgement Message ID to the recipient it came from

Parameters

TUint8 aUserResponseCode

IMPORT_C TSmsMessageIdentifier MessageId() const;

Description

Returns the assigned message identifier.

Return value

TSmsMessageIdentifier Message identifier

IMPORT_C TBool ValidateAddress() const;

Description

Validate the address

Return value

TBool ETrue if the address is valid; EFalse if the address is invalid, or if the address type is not ISDN or EMail.

TSmsAckStatus

Description

Defines the status of an acknowledgement for a recipient.

ENoAckRequested An acknowledgement for this recipient has not been requested. EPendingAck The delivery status for this recipient has been requested, but the status report has not yet been received. EAckSuccessful A successful acknowledgement for this recipient has been received. EAckError A failed acknowledgement for this recipient has been received.

TSmsAckStatus

Description

Defines the status of an acknowledgement for a recipient.

ENoAckRequested An acknowledgement for this recipient has not been requested. EPendingAck The delivery status for this recipient has been requested, but the status report has not yet been received. EAckSuccessful A successful acknowledgement for this recipient has been received. EAckError A failed acknowledgement for this recipient has been received.