![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
RTelSubSessionBase |
Base class. Defines telephony sub-session. |
etelbgsm.h
gsmbas.lib
This class encapsulates the SMS messaging functionality associated with the phone.
Using this class, clients can send and receive SMS messages, change the mode of SMS messages, access SMS store information, and set/query the phones service centre number.
This class is not intended for user derivation
RSmsMessaging();
The default C++ constructor constructs a messaging object.
TInt Open(RPhone& aPhone);
This function opens a SMS Messaging subsession.
RPhone& aPhone |
The phone session in which the messaging subsession is opened. |
TInt |
An error code: see System error codes. |
void Close();
This function closes an SMS messaging subsession.
TInt GetCaps(TCaps& aCaps) const;
This function retrieves the SMS messaging capabilities of the phone.
TCaps& aCaps |
On return, contains the phones messaging capabilities. |
TInt |
An error code: see System error codes. |
TInt RegisterReadSmsMessage(const TSms::TFormat aFormat,const TInt aBufferSize) const;
This function causes the server to create a memory buffer to hold outstanding SMS messages, and to maintain an outstanding ReadSmsMessage() request on the TSY. Messages are placed in the buffer and the oldest one is completed when the client next calls ReadSmsMessage().
This function reduces the possibility of new messages being over-written before the client can re-post ReadSmsMessage().
const TSms::TFormat aFormat |
The format of the messages to be buffered; PDU or text. |
const TInt aBufferSize |
The size of the buffer that the server should create to hold SMS messages. |
TInt |
An error code: see System error codes. |
TInt DeregisterReadSmsMessage() const;
This function cancels a previously registered interest in buffering SMS messages. The buffer is destroyed but outstanding ReadSmsMessage() requests remain outstanding.
TInt |
An error code: see System error codes. |
void ReadSmsMessage(TRequestStatus& aStatus, TMsgLocation& aMsgLocation, TSms& aMsg);
This function requests notification when a new message arrives from the network, and retrieves the message information.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TMsgLocation& aMsgLocation |
On request completion, contains the location of the message in the message store if the message storage is enabled. |
TSms& aMsg |
On return, contains the new message. |
void ReadSmsMessageCancel() const;
This function cancels an outstanding SMS message read request, placed using the ReadSmsMessage() function.
void NotifySmsMessageArrived(TRequestStatus& aStatus) const;
This function provides notification of the arrival of a new SMS message. The request completes when the new message has arrived.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
void NotifySmsMessageArrivedCancel() const;
This function cancels an outstanding request for notification of SMS message arrival, placed using the NotifySmsMessageArrived() function.
TInt GetDefaultSCAddress(TGsmTelNumber& aSCAddress) const;
This synchronous function reads the default service centre telephone number from the SIM.
TGsmTelNumber& aSCAddress |
On return, contains the default service centre number. |
TInt |
An error code: see System error codes. |
void GetDefaultSCAddress(TRequestStatus& aStatus, TGsmTelNumber& aSCAddress) const;
This asynchronous function reads the default service centre telephone number from the SIM.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TGsmTelNumber& aSCAddress |
On request completion, contains the default service centre number. |
void GetDefaultSCAddressCancel() const;
This function cancels an outstanding request to read the default service centre number from the SIM, placed using the asynchronous variant of the GetDefaultSCAddress() function.
TInt SetDefaultSCAddress(const TGsmTelNumber& aSCAddress) const;
This synchronous function sets the default service centre telephone number (in the SIM).
const TGsmTelNumber& aSCAddress |
The new default service centre telephone number. |
TInt |
An error code: see System error codes. |
void SetDefaultSCAddress(TRequestStatus& aStatus, const TGsmTelNumber& aSCAddress);
This asynchronous function sets the default service centre telephone number (in the SIM).
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TGsmTelNumber& aSCAddress |
The new default service centre telephone number. |
void SetDefaultSCAddressCancel() const;
This function cancels an outstanding request to set the default service centre number, placed using the asynchronous variant of the SetDefaultSCAddress() function.
void SendMessage(TRequestStatus& aStatus, TUint& aMsgRef, TSms& aMsg);
This function sends an SMS message.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
TUint& aMsgRef |
On request completion, contains an SMS message reference number assigned by the network. |
TSms& aMsg |
The SMS message to be sent. |
void SendMessageCancel() const;
This function cancels an outstanding message transmission request, placed using the SendMessage() function.
TInt GetMode(TMode& aMode) const;
This function retrieves the current messaging mode.
TMode& aMode |
On return, contains the current messaging mode. |
TInt |
An error code: see System error codes. |
TInt SetMode(const TMode& aMode) const;
This synchronous function sets the current messaging mode PDU or Text.
const TMode& aMode |
The new messaging mode. |
TInt |
An error code: see System error codes. |
void SetMode(TRequestStatus& aStatus, const TMode& aMode) const;
This asynchronous function sets the current messaging mode PDU or Text.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TMode& aMode |
The new messaging mode. |
void SetModeCancel() const;
This function cancels an outstanding request to set the messaging mode, placed using the asynchronous variant of the SetMode() function.
TInt EnumerateMessageStores(TInt& aCount) const;
This function retrieves the number of message stores supported by the phone.
TInt& aCount |
On return, contains the number of message stores supported by the phone. |
TInt |
An error code: see System error codes. |
TInt GetMessageStoreInfo(const TInt aIndex,TStoreInfo& aInfo) const;
This synchronous function retrieves information about a specified message store.
const TInt aIndex |
The index of the store for which information is required. Valid values lie between 0 and (n-1), where n is given by the EnumerateMessageStores() function. |
TStoreInfo& aInfo |
On return, contains the message store information. |
TInt |
An error code: see System error codes. |
void GetMessageStoreInfo(TRequestStatus& aStatus,const TInt aIndex,TStoreInfo& aInfo) const;
This asynchronous function retrieves information about a specified message store.
TRequestStatus& aStatus |
A variable that indicates the completion status of the request. |
const TInt aIndex |
The index of the store for which information is required. Valid values lie between 0 and (n-1), where n is given by the EnumerateMessageStores() function. |
TStoreInfo& aInfo |
On request completion, contains the message store information. |
void GetMessageStoreInfoCancel() const;
This function cancels an outstanding request to get message store information, placed using the asynchronous variant of the GetMessageStoreInfo() function.
Command mode PDU messaging is supported. |
|
Command mode Text messaging is supported. |
|
Block mode PDU messaging is supported. |
|
Read without storage is supported. |
|
Read with storage is supported. |
SMS reception is supported. |
|
Cell broadcast reception is supported. |
|
Status report reception is supported. |
|
SMS transmission is supported. |
PDU command messaging mode. |
|
Text command messaging mode. |
|
PDU block messaging mode. |
SMS messages are not stored in phone or SIM based storage. |
|
SMS messages are stored before being passed to client(s). Messages are passed with a storage reference number. |
Memory which supports reading and deleting messages. |
|
Memory in which messages can be written and from which operations can be sent. |
|
This store contains cell broadcast messages. |
TUint iSmsMode |
Bit mask of the messaging mode capability flags defined in the enumerations section above. |
TUint iSmsMsgTypes |
Bit mask of the messaging type capability flags defined in the enumerations section above. |
TInt iIndex |
The index number indicating where the SMS message is stored. If the messaging mode is Read Without Storage then the value is set to KErrNotFound (-1). |
TName iStore |
The message store name. |
TSmsMode iMessagingMode |
Selects the messaging mode. |
TStorageMode iStorageMode |
Selects the message storage mode. |
TName iName |
The name of the message store. For a valid list of names see SMS Phone store types. |
TUint iTotal |
Indicates the total number of messages that may be stored in this store. |
TUint iUsed |
Indicates the current number of messages stored in this store. |
TUint32 iFlags |
Indicates the type of message store. Bitmask of the message store information flags defined in the enumerations section. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |