| class RMobileUssdMessaging : public RTelSubSessionBase |
Provides client access to USSD functionality provided by TSY.
| Public Member Functions | |
|---|---|
| RMobileUssdMessaging () | |
| IMPORT_C void | Close () |
| IMPORT_C TInt | GetCaps ( TDes8 &) |
| IMPORT_C void | NotifyNetworkRelease ( TRequestStatus &, TDes8 &) |
| IMPORT_C void | NotifyNetworkRelease ( TRequestStatus &, TDes8 &, TDes8 &) |
| IMPORT_C TInt | Open ( RMobilePhone &) |
| IMPORT_C void | ReceiveMessage ( TRequestStatus &, TDes8 &, TDes8 &) |
| IMPORT_C void | SendMessage ( TRequestStatus &, const TDesC8 &, const TDesC8 &) |
| IMPORT_C void | SendMessageNoFdnCheck ( TRequestStatus &, const TDesC8 &, const TDesC8 &) |
| IMPORT_C void | SendRelease ( TRequestStatus &, TDes8 &) |
| Protected Member Functions | |
|---|---|
| IMPORT_C void | ConstructL () |
| IMPORT_C void | Destruct () |
| Private Member Functions | |
|---|---|
| RMobileUssdMessaging (const RMobileUssdMessaging &) | |
| Public Member Enumerations | |
|---|---|
| enum | anonymous { KGsmUssdDataSize = 160 } |
| enum | TMobileUssdAttributeFlags { KUssdDataFormat = 0x00000001, KUssdMessageType = 0x00000002, KUssdMessageDcs = 0x00000004 } |
| enum | TMobileUssdDataFormat { EFormatUnspecified , EFormatPackedString } |
| enum | TMobileUssdFormatCaps { KCapsPackedString = 0x00000001 } |
| enum |
TMobileUssdMessageType
{
EUssdUnknown , EUssdMORequest , EUssdMOReply , EUssdMTNotify , EUssdMTRequest , EUssdMTReply , EUssdMOAcknowledgement } |
| enum | TMobileUssdTypeCaps { KCapsMOUssd = 0x00000001, KCapsMTUssd = 0x00000002 } |
| Inherited Enumerations | |
|---|---|
| RTelSubSessionBase:TReqPriorityType | |
| Public Member Type Definitions | |
|---|---|
| typedef | TBuf8 < KGsmUssdDataSize > TGsmUssdMessageData |
| typedef | TPckg < TMobileUssdAttributesV1 > TMobileUssdAttributesV1Pckg |
| typedef | TPckg < TMobileUssdCapsV1 > TMobileUssdCapsV1Pckg |
| Private Attributes | |
|---|---|
| CUssdMessagingPtrHolder * | iUssdMessagingPtrHolder |
| Inherited Attributes | |
|---|---|
| RTelSubSessionBase::iPtrHolder | |
| RMobileUssdMessaging | ( | const RMobileUssdMessaging & | ) | [private] |
| const RMobileUssdMessaging & |
| IMPORT_C void | Close | ( | ) |
| IMPORT_C TInt | GetCaps | ( | TDes8 & | aCaps | ) | const |
This member function returns a class that reflects the USSD messaging capabilities of the phone.
| TDes8 & aCaps | On completion, a TMobileUssdCapsV1Pckg with the current USSD messaging capabilities. |
| IMPORT_C void | NotifyNetworkRelease | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aReturnResult | |||
| ) | const | |||
Notifies the client of a MT USSD release message to the mobile device. The notification completes when a release message to terminate the session has been received and successfully acknowledged. NB: This fucntion has been deprecated and it is not recommended for future development work.
| TRequestStatus & aReqStatus | Returns the result code after the asynchronous call completes. |
| TDes8 & aReturnResult | A packaged instance of the RMobilePhone::TMobilePhoneSendSSRequestV3 class containing the result of the release. |
| IMPORT_C void | NotifyNetworkRelease | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aMsgData, | |||
| TDes8 & | aMsgAttributes | |||
| ) | const | |||
Notifies the client of a MT USSD release message to the mobile device. The notification completes when a release message to terminate the session has been received and successfully acknowledged.
| TRequestStatus & aReqStatus | Returns the result code after the asynchronous call completes. |
| TDes8 & aMsgData | A packaged instance of the RMobilePhone::TMobilePhoneSendSSRequestV3 class containing the result of the release. |
| TDes8 & aMsgAttributes | A packaged instance of the TMobileUssdAttributesV1Pckg class containing the message attributes. |
| IMPORT_C TInt | Open | ( | RMobilePhone & | aPhone | ) |
This member function opens a USSD messaging sub-session. The name of the sub-session opened in the TSY will equal the string defined by the KETelUssdMessaging LIT definition.
| RMobilePhone & aPhone | An existing RMobilePhone session. |
| IMPORT_C void | ReceiveMessage | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aMsgData, | |||
| TDes8 & | aMsgAttributes | |||
| ) | const | |||
This member function enables the client to receive the next incoming USSD message from the network. The request will be completed when a new message arrives.
Use RTelSubSessionBase::CancelAsyncRequest(EMobileUssdMessagingReceiveMessage) to cancel a previously placed asynchronous ReceiveMessage() request.
| TRequestStatus & aReqStatus | On return, KErrNone if successful. |
| TDes8 & aMsgData | A descriptor large enough to hold the returned USSD message data. For GSM/ WCDMA USSD messages this will be a buffer of 160 bytes and the clients are provided with a typedef called RMobileUssdMessaging::TGsmUssdMessageData. |
| TDes8 & aMsgAttributes | On completion, the TMobileUssdAttributesV1Pckg with the message attributes. |
| IMPORT_C void | SendMessage | ( | TRequestStatus & | aReqStatus, |
| const TDesC8 & | aMsgData, | |||
| const TDesC8 & | aMsgAttributes | |||
| ) | const | |||
This member function sends a USSD message to the network.
See 3GPP spec. 04.90 for more details on expected responses from the network.
Use RTelSubSessionBase::CancelAsyncRequest(EMobileUssdMessagingSendMessage) to cancel a previously placed asynchronous SendMessage() request.
| TRequestStatus & aReqStatus | On return, KErrNone if successful. |
| const TDesC8 & aMsgData | The message data. |
| const TDesC8 & aMsgAttributes | The TMobileUssdAttributesV1Pckg with the message attributes. |
| IMPORT_C void | SendMessageNoFdnCheck | ( | TRequestStatus & | aReqStatus, |
| const TDesC8 & | aMsgData, | |||
| const TDesC8 & | aMsgAttributes | |||
| ) | const | |||
Sends an outgoing USSD to the network.
The number used for sending the SMS is not checked against those in the Fixed Dialling Number list even if the FDN service is enabled.
| TRequestStatus & aReqStatus | |
| const TDesC8 & aMsgData | Supplies the USSD message data to send |
| const TDesC8 & aMsgAttributes | Supplies the attributes of the outgoing USSD |
| IMPORT_C void | SendRelease | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aReturnResult | |||
| ) | const | |||
Sends a USSD release message to the network. This request can terminate an ongoing "dialogue" (send-receive) at any time.
| TRequestStatus & aReqStatus | Returns the result code after the asynchronous call completes. |
| TDes8 & aReturnResult | A packaged instance of the RMobilePhone::TMobilePhoneSendSSRequestV3 class containing the result of the release. |
| KUssdDataFormat = 0x00000001 |
The iFormat field is valid in the attribute class. |
| KUssdMessageType = 0x00000002 |
The iType field is valid in the attribute class. |
| KUssdMessageDcs = 0x00000004 |
The iDcs field is valid in the attribute class. |
Defines the USSD Data Formats.
Modes: Common
| EFormatUnspecified |
The message data format is unspecified. Modes: Common |
| EFormatPackedString |
The message data format complies to a USSD coded as 160 octets as defined for a ussd-String within GSM 04.80 and GSM 03.38. Modes: GSM/WCDMA |
Defines the USSD Messaging Format Capabilities.
Modes: GSM/WCDMA
| KCapsPackedString = 0x00000001 |
USSD messages coded as a packed string within 160 octets, as defined for a ussd-String within GSM 04.80 and GSM 03.38. Modes: GSM/WCDMA |
Defines the USSD Message Types.
Modes: GSM/WCDMA
| EUssdUnknown |
Message is an unknown type. |
| EUssdMORequest |
Message is a mobile originated USSD request. The MS expects the network to send a USSD MT reply. |
| EUssdMOReply |
Message is a reply to a previously received network initiated USSD request. It is a USSD MO reply. |
| EUssdMTNotify |
Message is a one-off network initiated USSD notification. The network expects the MS to send a USSD MO acknowledgement with empty message content. |
| EUssdMTRequest |
Message is a network initiated USSD request. The network expects the MS to send a USSD MO reply. |
| EUssdMTReply |
Message is a network initiated reply to a previously sent MO USSD request. |
| EUssdMOAcknowledgement |
For acknowledging MT USSD notifications (empty message content). |
Defines the USSD Messaging Type Capabilities.
Modes: GSM/WCDMA
| KCapsMOUssd = 0x00000001 |
Outgoing USSD messages are supported. Modes: GSM/WCDMA |
| KCapsMTUssd = 0x00000002 |
Incoming USSD messages are supported. Modes: GSM/WCDMA |
| typedef TBuf8 < KGsmUssdDataSize > | TGsmUssdMessageData |
A typedef'd buffer to hold the message data.
| typedef TPckg < TMobileUssdAttributesV1 > | TMobileUssdAttributesV1Pckg |
A typedef'd packaged TMobileUssdAttributesV1 for passing through a generic API member function.
| typedef TPckg < TMobileUssdCapsV1 > | TMobileUssdCapsV1Pckg |
A typedef'd packaged TMobileUssdCapsV1 for passing through a generic API member function.
| CUssdMessagingPtrHolder * | iUssdMessagingPtrHolder | [private] |
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.