»
Symbian OS v9.2 »
Symbian OS reference »
C++ component reference »
Messaging SMS (8.1) »
CSmsNumber
Location:
SMUTSET.H
Link against: smcm_gsm.lib
Link against: smcm_cdma.lib
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 heapCMsvRecipient - Base class for information relating to a message recipientCSmsNumber - 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(), 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()
Construction and destruction
static IMPORT_C CSmsNumber *NewL();
Description
Return value
static IMPORT_C CSmsNumber *NewL(const CSmsNumber &aSmsNumber);
Description
Parameters
Return value
virtual IMPORT_C ~CSmsNumber();
Description
static IMPORT_C CSmsNumber *NewL();
Description
Creates and allocates a new CSmsNumber object.
Return value
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
virtual IMPORT_C ~CSmsNumber();
Description
Destructor.
virtual IMPORT_C void InternalizeL(RReadStream &aStream);
Description
Parameters
virtual IMPORT_C void ExternalizeL(RWriteStream &aStream) const;
Description
Parameters
IMPORT_C TPtrC Address() const;
Description
Return value
IMPORT_C void SetAddressL(const TDesC &aAddress);
Description
Parameters
IMPORT_C TPtrC Name() const;
Description
Return value
IMPORT_C void SetNameL(const TDesC &aName);
Description
Parameters
inline TLogId LogId() const;
Description
Return value
inline void SetLogId(TLogId aLogId);
Description
Parameters
IMPORT_C CSmsNumber &CopyL(const CSmsNumber &aSmsNumber);
Description
Parameters
Return value
IMPORT_C TSmsAckStatus AckStatus(TSmsAckType aAckType) const;
Description
Parameters
Return value
IMPORT_C void SetAckStatus(TSmsAckType aAckType, TSmsAckStatus aAckStatus);
Description
Parameters
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.
Return value
TPtrC
|
A descriptor with the recipient address. |
|
IMPORT_C void SetAddressL(const TDesC &aAddress);
Description
Sets the recipient address. The address is a telephone number.
Parameters
const TDesC &aAddress |
The recipient address. |
|
Leave codes
KErrTooBig |
When the length of the address is bigger than that supported on the current set of settings |
KErrNoMemory |
When there is not enough memory |
|
See also:
SmsProvisionedSettings::MaxISDNLength
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 SmsProvisionedSettings::MaxNameLength.
Parameters
const TDesC &aName |
The recipient name. |
|
See also:
SmsProvisionedSettings::MaxNameLength
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
Returns the Acknowledgement status for a given acknowledgment type.
Parameters
Return value
TSmsAckStatus
|
Acknowledgement status for the given acknowledgment type. |
|
IMPORT_C TUint8 UserAck() const;
Description
Returns the User acknownledgement Message ID
Return value
IMPORT_C void SetUserAck(TUint8 aUserResponseCode);
Description
Assigns the User acknownledgement Message ID to the recipient it came from
Parameters
IMPORT_C TSmsMessageIdentifier MessageId() const;
Description
Returns the assigned message identifier.
Return value
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. |
|
![[Index]](../../../../_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../_stock/btn_next_wt.gif){kind=small}
![[Top]](../../../../_stock/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../_stock/btn_prev.gif){kind=small}
![[Top]](../../../../_stock/btn_top.gif)
![[Next]](../../../../_stock/btn_next.gif){kind=small}