#include <etel3rdparty.h>
| class CTelephony : public CBase |
This class provides a simple interface to the phone's telephony system. It provides two services:
1. You can find out information about the phone. This class provides support for retrieving Phone Settings, Line Information, Call Functionality, Network Information and (basic) Supplementary Service Settings.
2. You can dial, answer and control voice calls. You cannot make fax or data calls.
Architecturally, CTelephony provides an interface to the Telephony Multimode API. This interface exposes only a subset of the complete Multimode functionality.
Note that a CActiveScheduler is required to be installed for all asynchronous CTelephony calls.
| typedef TPckg< TBatteryInfoV1 > | TBatteryInfoV1Pckg |
A typedef'd packaged CTelephony::TBatteryInfoV1 for passing through a generic API method.
| typedef TPckg< TCallBarringSupplServicesV1 > | TCallBarringSupplServicesV1Pckg |
A typedef'd packaged CTelephony::TCallBarringSupplServicesV1 for passing through a generic API method.
| typedef TPckg< TCallCapsV1 > | TCallCapsV1Pckg |
A typedef'd packaged CTelephony::TCallParamsV1 for passing through a generic API method.
| typedef TPckg< TCallForwardingSupplServicesV1 > | TCallForwardingSupplServicesV1Pckg |
A typedef'd packaged CTelephony::TCallForwardingSupplServicesV1 for passing through a generic API method.
| typedef TPckg< TCallInfoV1 > | TCallInfoV1Pckg |
A typedef'd packaged CTelephony::TCallInfoV1 for passing through a generic API method.
| typedef TPckg< TCallParamsV1 > | TCallParamsV1Pckg |
A typedef'd packaged CTelephony::TCallParamsV1 for passing through a generic API method.
| typedef TPckg< TCallSelectionV1 > | TCallSelectionV1Pckg |
A typedef'd packaged CTelephony::TCallSelectionV1 for passing through a generic API method.
| typedef TPckg< TCallStatusV1 > | TCallStatusV1Pckg |
A typedef'd packaged CTelephony::TCallStatusV1 for passing through a generic API method.
| typedef TPckg< TCallWaitingSupplServicesV1 > | TCallWaitingSupplServicesV1Pckg |
A typedef'd packaged CTelephony::TCallWaitingSupplServicesV1 for passing through a generic API method.
| typedef TPckg< TFlightModeV1 > | TFlightModeV1Pckg |
A typedef'd packaged CTelephony::TFlightModeV1 for passing through a generic API method.
| typedef TPckg< TIccLockInfoV1 > | TIccLockInfoV1Pckg |
A typedef'd packaged CTelephony::TIccLockInfoV1 for passing through a generic API method.
| typedef TPckg< TIdentityServiceV1 > | TIdentityServiceV1Pckg |
A typedef'd packaged CTelephony::TIdentityServiceV1 for passing through a generic API method.
| typedef TPckg< TIndicatorV1 > | TIndicatorV1Pckg |
A typedef'd packaged CTelephony::TIndicatorV1 for passing through a generic API method.
| typedef TPckg< TNetworkInfoV1 > | TNetworkInfoV1Pckg |
A typedef'd packaged CTelephony::TNetworkInfoV1 for passing through a generic API method.
| typedef TPckg< TNetworkInfoV2 > | TNetworkInfoV2Pckg |
A typedef'd packaged CTelephony::TNetworkInfoV2 for passing through a generic API method.
| typedef TPckg< TNetworkNameV1 > | TNetworkNameV1Pckg |
A typedef'd packaged CTelephony::TNetworkNameV1 for passing through a generic API method.
| typedef TPckg< TNetworkNameV2 > | TNetworkNameV2Pckg |
A typedef'd packaged CTelephony::TNetworkNameV2 for passing through a generic API method. TNetworkNameV2 differs from Version 1 in that the length of iNetworkName is 20 rather than 16.
| typedef TPckg< TNetworkRegistrationV1 > | TNetworkRegistrationV1Pckg |
A typedef'd packaged CTelephony::TNetworkRegistrationV1 for passing through a generic API method.
| typedef TPckg< TOperatorNameV1 > | TOperatorNameV1Pckg |
A typedef'd packaged CTelephony::TOperatorNameV1 for passing through a generic API method.
| typedef TPckg< TPhoneIdV1 > | TPhoneIdV1Pckg |
A typedef'd packaged CTelephony::TPhoneIdV1 for passing through a generic API method
| typedef TPckg< TRemotePartyInfoV1 > | TRemotePartyInfoV1Pckg |
A typedef'd packaged CTelephony::TRemotePartyInfoV1 for passing through a generic API method.
| typedef TPckg< TSignalStrengthV1 > | TSignalStrengthV1Pckg |
A typedef'd packaged CTelephony::TSignalStrengthV1 for passing through a generic API method.
| typedef TPckg< TSubscriberIdV1 > | TSubscriberIdV1Pckg |
A typedef'd packaged CTelephony::TSubscriberIdV1 for passing through a generic API method.
| typedef TBuf< KMaxTelNumberSize > | TTelNumber |
A typedef to hold the telephone number.
The mobile phone battery status.
Call Barring conditions.
Call Forwarding conditions.
Describes the possible call or line states.
Caller Id restriction settings.
Cancel apending request
Setting of the ICC lock.
| Enumerator | Value | Description |
|---|---|---|
| ELockSetUnknown |
The setting of the lock is unknown. | |
| ELockSetEnabled |
Lock is enabled, and is available for use. Its status may be CTelephony::EStatusLocked, CTelephony::EStatusUnlocked, or CTelephony::EStatusBlocked. The associated security code will be required to unlock the lock the next time the lock's status is CTelephony::EStatusLocked. | |
| ELockSetDisabled |
Lock is disabled. It is not available for use, so its status is always CTelephony::EStatusUnlocked. |
Status of an ICC lock.
| Enumerator | Value | Description |
|---|---|---|
| EStatusLockUnknown |
The status of the lock is unknown. | |
| EStatusLocked |
Lock is closed. User can not access functionality governed by this lock until user correctly enters associated security code. | |
| EStatusUnlocked |
Lock is open. User can access functionality governed by this lock | |
| EStatusBlocked |
Lock is blocked. User should enter the unblocking code to be able to switch back to the unlocked mode. Blocking is enabled after a number of unsuccessful attempts to verify PIN1/2. |
Service status of the Phone ID services.
Mobile call control capabilities.
The access technology that the network is based on.
Mobile phone network band information.
Defines Current Network Modes.
| Enumerator | Value | Description |
|---|---|---|
| ENetworkModeUnknown |
Network mode is unknown. | |
| ENetworkModeUnregistered |
Mobile device is not registered. | |
| ENetworkModeGsm |
GSM/GPRS or DCS1800 network. | |
| ENetworkModeAmps |
AMPS network. | |
| ENetworkModeCdma95 |
CDMA (IS-95) network. | |
| ENetworkModeCdma2000 |
CDMA (cdma2000) network. | |
| ENetworkModeWcdma |
WCDMA (UTRA Frequency Division Duplex (FDD)) network. | |
| ENetworkModeTdcdma |
TD-CDMA (UTRA Time Division Duplex (TDD)) network. |
Notification events
| Enumerator | Value | Description |
|---|---|---|
| EFlightModeChange |
Register interest for receiving a notification for flight mode changes. New flight mode returned in a CTelephony::TFlightModeV1Pckg, a packaged CTelephony::TFlightModeV1. Pass CancelAsync() CTelephony::EFlightModeChangeCancel to cancel.
| |
| EIndicatorChange |
Register interest for receiving a notification for phone indicator changes. New indicators returned in a CTelephony::TIndicatorV1Pckg, a packaged CTelephony::TIndicatorV1. Pass CancelAsync() CTelephony::EIndicatorChangeCancel to cancel.
| |
| EBatteryInfoChange |
Register interest for receiving a notification for Battery information changes. New Battery information returned in a CTelephony::TBatteryInfoV1Pckg, a packaged CTelephony::TBatteryInfoV1. Pass CancelAsync() CTelephony::EBatteryInfoChangeCancel to cancel.
| |
| ESignalStrengthChange |
Register interest for receiving a notification for Signal Strength changes. New Signal Strength returned in a CTelephony::TSignalStrengthV1Pckg, a packaged CTelephony::TSignalStrengthV1. Pass CancelAsync() CTelephony::ESignalStrengthChangeCancel to cancel.
| |
| EPin1LockInfoChange |
Register interest for receiving a notification for Icc Pin1 Lock Information changes. New Icc Pin1 Lock Information returned in a CTelephony::TIccLockInfoV1Pckg, a packaged CTelephony::TIccLockInfoV1. Pass CancelAsync() CTelephony::EPin1LockInfoChangeCancel to cancel.
| |
| EPin2LockInfoChange |
Register interest for receiving a notification for Icc Pin2 Lock Information changes. New Icc Pin2 Lock Information returned in a CTelephony::TIccLockInfoV1Pckg, a packaged CTelephony::TIccLockInfoV1. Pass CancelAsync() CTelephony::EPin2LockInfoChangeCancel to cancel.
| |
| EVoiceLineStatusChange |
Register interest for receiving a notification for Voice Line Status changes. New Voice Line Status returned in a CTelephony::TCallStatusV1Pckg, a packaged CTelephony::TCallStatusV1. Pass CancelAsync() CTelephony::EVoiceLineStatusChangeCancel to cancel.
| |
| EOwnedCall1StatusChange |
Register interest for receiving a notification for owned Call 1 Status changes. New Call 1 Status returned in a CTelephony::TCallStatusV1Pckg, a packaged CTelephony::TCallStatusV1. Pass CancelAsync() CTelephony::EOwnedCall1StatusChangeCancel to cancel.
| |
| EOwnedCall2StatusChange |
Register interest for receiving a notification for owned Call 2 Status changes. New Call 2 Status returned in a CTelephony::TCallStatusV1Pckg, a packaged CTelephony::TCallStatusV1. Pass CancelAsync() CTelephony::EOwnedCall2StatusChangeCancel to cancel.
| |
| EOwnedCall1RemotePartyInfoChange |
Register interest for receiving a notification for Call 1 Remote Party Info changes. New Call 1 Remote Party Info returned in a CTelephony::TRemotePartyInfoV1Pckg, a packaged CTelephony::TRemotePartyInfoV1. Pass CancelAsync() CTelephony::EOwnedCall1RemotePartyInfoChangeCancel to cancel.
| |
| EOwnedCall2RemotePartyInfoChange |
Register interest for receiving a notification for Call 2 Remote Party Info changes. New Call 2 Remote Party Info returned in a CTelephony::TRemotePartyInfoV1Pckg, a packaged CTelephony::TRemotePartyInfoV1. Pass CancelAsync() CTelephony::EOwnedCall2RemotePartyInfoChangeCancel to cancel.
| |
| ENetworkRegistrationStatusChange |
Register interest for receiving a notification for Network registration status changes. New Network registration status returned in a CTelephony::TNetworkRegistrationV1Pckg, a packaged CTelephony::TNetworkRegistrationV1. Pass CancelAsync() CTelephony::ENetworkRegistrationStatusChangeCancel to cancel.
| |
| ECurrentNetworkInfoChange |
Register interest for receiving a notification for Network information changes. New Network information returned in a CTelephony::TNetworkInfoV1Pckg, a packaged CTelephony::TNetworkInfoV1. Pass CancelAsync() CTelephony::ECurrentNetworkInfoChangeCancel to cancel.
| |
| EFaxLineStatusChange |
Register interest for receiving a notification for Fax Line Status changes. New Fax Line Status returned in a CTelephony::TCallStatusV1Pckg, a packaged CTelephony::TCallStatusV1. Pass CancelAsync() CTelephony::EFaxLineStatusChangeCancel to cancel.
| |
| EDataLineStatusChange |
Register interest for receiving a notification for Data Line Status changes. New Data Line Status returned in a CTelephony::TCallStatusV1Pckg, a packaged CTelephony::TCallStatusV1. Pass CancelAsync() CTelephony::EDataLineStatusChangeCancel to cancel.
|
The mobile phone indicators.
The registration status of the phone.
Supplementary Service status.
Number Plan Indicator.
| Enumerator | Value | Description |
|---|---|---|
| EUnknownNumberingPlan | 0 |
User or the network has no knowledge of the numbering plan. |
| EIsdnNumberPlan | 1 |
ISDN/telephony numbering plan. |
| EDataNumberPlan | 3 |
Data numbering plan. |
| ETelexNumberPlan | 4 |
Telex numbering plan. |
| EServiceCentreSpecificPlan1 | 5 |
Service centre specific plan used to indicate a numbering plan specific to external Short Message entities attached to the SMSC. |
| EServiceCentreSpecificPlan2 | 6 |
Service centre specific plan used to indicate a numbering plan specific to external Short Message entities attached to the SMSC. |
| ENationalNumberPlan | 8 |
National numbering plan. |
| EPrivateNumberPlan | 9 |
Private numbering plan. |
| EERMESNumberPlan | 10 |
ERMES numbering plan. |
Address types.
| Enumerator | Value | Description |
|---|---|---|
| EUnknownNumber |
User or the network has no knowledge of the type of number. | |
| EInternationalNumber |
International number. | |
| ENationalNumber |
National number. | |
| ENetworkSpecificNumber |
Administration/service number specific to the serving network, e.g. used to access an operator. | |
| ESubscriberNumber |
Subscriber number. | |
| EAlphanumericNumber |
Alphanumeric number. | |
| EAbbreviatedNumber |
Abbreviated number. |
| IMPORT_C void | AnswerIncomingCall | ( | TRequestStatus & | aReqStatus, |
| TCallId & | aCallId, | |||
| const TPhoneLine | aLine = EVoiceLine | |||
| ) | const | |||
Answers an incoming new voice call. Fax and data calls cannot be answered.
Answering an incoming call is possible only when the voice line status is ringing (CTelephony::EStatusRinging) and RLine::NotifyIncomingCall has completed.
This is an asynchronous method. Upon successful completion of AnswerIncomingCall() a call ID is returned to the client via the aCallId argument. The call identifier is needed to hold, resume, swap, and terminate the call. It is also needed to monitor the status of the call.
This functionality is not available when the phone is in "flight" mode.
See also: DialNewCall() Hold() Resume() Swap() Hangup() GetCallStatus() GetCallDynamicCaps()
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EAnswerIncomingCallCancel to cancel |
| aCallId | On completion, contains the call ID. |
| aLine | Line from which the answer request will attempted. Currently, only the voice line is supported. |
| IMPORT_C TInt | CancelAsync | ( | TCancellationRequest | aCancel | ) | const |
Cancels an outstanding asynchronous request.
The result of the cancellation request will be reflected through the request status of the pending request. A status of KErrCancel denotes that the request has been safely cancelled.
| Parameter | Description |
|---|---|
| aCancel | Canncellation code of request to be cancelled. |
| IMPORT_C void | CancelEstablishDataCall | ( | ) |
This method is no longer supported.
It was used to cancel an outstanding request to establish a circuit-switched data call, but support was removed as functionality was no longer required by licensees. Developers should consider using GPRS via RConnection and RSocket for data functionality instead.
See also: RConnection RSocket RMobilePhone
| IMPORT_C void | CancelReceiveDataCall | ( | ) |
This method is no longer supported.
It was used to cancel an outstanding request to receive a circuit-switched data call, but support was removed as functionality was no longer required by licensees. Developers should consider using GPRS via RConnection and RSocket for data functionality instead.
See also: RConnection RSocket RMobilePhone
| IMPORT_C void | DialNewCall | ( | TRequestStatus & | aStatus, |
| TDes8 & | aCallParams, | |||
| const TTelNumber & | aTelNumber, | |||
| TCallId & | aCallId, | |||
| const TPhoneLine | aLine = EVoiceLine | |||
| ) | const | |||
Initiates a new call.
The client specifies the telephone number via the aTelNumber argument and the desired call parameters via the aCallParams argument.
This is an asynchronous method. After successful completion of the dial request a call identifier is returned back to the client via the aCallId argument. The call identifier is needed to hold, resume, swap, and terminate the call. It is also needed to monitor the status of the call.
This functionality is not available when the phone is in "flight" mode.
See also: AnswerIncomingCall() Hold() Resume() Swap() Hangup() GetCallStatus() GetCallDynamicCaps()
| Parameter | Description |
|---|---|
| aStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EDialNewCallCancel to cancel. |
| aCallParams | The call parameters used by the TSY. Pass a CTelephony::TCallParamsV1Pckg, a packaged CTelephony::TCallParamsV1. |
| aTelNumber | Telephone number to dial. |
| aCallId | Upon completion, contains the call identifier. |
| aLine | Line on which call can be made. Currently, only voice calls are supported. |
This method is no longer supported.
It was used to establish a circuit-switched data call, but support was removed as functionality was no longer required by licensees. Developers should consider using GPRS via RConnection and RSocket for data functionality instead.
See also: RConnection RSocket RMobilePhone
Returns: KErrNotSupported
| IMPORT_C void | EstablishDataCall | ( | TRequestStatus & | aRequestStatus, |
| TInt & | aDataChannel, | |||
| const TDesC & | aDialNumber | |||
| ) | ||||
This method is no longer supported.
It was used to establish a circuit-switched data call, but support was removed as functionality was no longer required by licensees. Developers should consider using GPRS via RConnection and RSocket for data functionality instead.
See also: RConnection RSocket RMobilePhone
| IMPORT_C void | GetBatteryInfo | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aBatteryInfo | |||
| ) | const | |||
Retrieves the status and charge level of the phone battery.
This is an asynchronous method. Upon successful completion of the request the battery information is returned via the packaged aDes argument.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetBatteryInfoCancel to cancel. |
| aBatteryInfo | Contains a CTelephony::TBatteryInfoV1Pckg, a packaged version of the CTelephony::TBatteryInfoV1 class which is filled on completion. |
| IMPORT_C void | GetCallBarringStatus | ( | TRequestStatus & | aRequestStatus, |
| const TCallBarringCondition | aCondition, | |||
| TDes8 & | aSSInfo, | |||
| const TServiceGroup | aServiceGroup = EVoiceService | |||
| ) | const | |||
Interrogate the current status of the call barring services.
Specify the condition for enquiry via the aCondition argument. Upon successful completion the status information is returned via the aSSInfo argument. Support is available only for the voice line.
This functionality is not available when the phone is in "flight" mode.
| Parameter | Description |
|---|---|
| aRequestStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetCallBarringStatusCancel to cancel. |
| aCondition | Call barring condition to be interrogated. |
| aSSInfo | Contains a CTelephony::TCallBarringSupplServicesV1Pckg, a packaged version of the CTelephony::TCallBarringSupplServicesV1 class which is filled on completion. |
| aServiceGroup | Service group to be interrogated. |
Retrieves the dynamic call capabilities for calls you dialled or answered with CTelephony.
The client specifies the call ID via the aCallId argument. Upon successful retrieval the call control capabilities (Hold, Resume and Swap) are returned via the aCaps argument.
This functionality is not available when the phone is in "flight" mode.
| Parameter | Description |
|---|---|
| aCallId | Call ID, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall(). |
| aCallCaps | On completion contains a CTelephony::TCallCapsV1Pckg, a packaged CTelephony::TCallCapsV1 containing the call's dynamic capabilities. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C void | GetCallForwardingStatus | ( | TRequestStatus & | aRequestStatus, |
| const TCallForwardingCondition | aCondition, | |||
| TDes8 & | aSSInfo, | |||
| const TServiceGroup | aServiceGroup = EVoiceService | |||
| ) | const | |||
Interrogates the current status of the call forwarding services.
Specify the condition for enquiry via the aCondition argument.
This is an asynchronous method. Upon successful completion the status information is returned via the aSSInfo argument. Support is available only for the voice line.
This functionality is not available when the phone is in "flight" mode.
Note: This information is only available on GSM/WCDMA networks.
| Parameter | Description |
|---|---|
| aRequestStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetCallForwardingStatusCancel to cancel. |
| aCondition | Call forwarding condition to be interrogated. |
| aSSInfo | Contains a CTelephony::TCallForwardingSupplServicesV1Pckg, a packaged version of the CTelephony::TCallForwardingSupplServicesV1 class which is filled on completion. |
| aServiceGroup | Service group to be interrogated. |
Retrieves information about the call selected by the aCallSelect argument.
If a call with the appropriate status is not available, then KErrNotFound is returned. Upon successful completion the call information will be returned via the aCallInfo and aRemoteCallInfo arguments.
This functionality should be used after a notification of an incoming call, notification of line status change to dialling, or notification of remote party info change. Notification is requested with CTelephony::NotifyChange(). After completion of the notification the client should immediately request information about the call.
| Parameter | Description |
|---|---|
| aCallSelect | Identifies the call for which information is retrieved. |
| aCallInfo | Contains CTelephony::TCallInfoV1Pckg, the packaged CTelephony::TCallInfoV1 parameter class which is filled on completion. |
| aRemoteInfo | Contains CTelephony::TRemotePartyInfoV1Pckg, the packaged CTelephony::TRemotePartyInfoV1 parameter class which is filled on completion. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
Retrieves the status of the selected call specified by the aCallId argument.
The current status of the selected call is returned to the client via the aStatus argument. GetCallStatus is available only for the voice line.
This functionality is not available when the phone is in "flight" mode.
See also: AnswerIncomingCall() DialNewCall() Hold() Resume() Swap() Hangup() GetCallDynamicCaps()
| Parameter | Description |
|---|---|
| aCallId | Call ID, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall(). |
| aCallStatus | On completion contains a CTelephony::TCallStatusV1Pckg, a packaged CTelephony::TCallStatusV1 containing the call status. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C void | GetCallWaitingStatus | ( | TRequestStatus & | aRequestStatus, |
| TDes8 & | aSSInfo, | |||
| const TServiceGroup | aServiceGroup = EVoiceService | |||
| ) | const | |||
Interrogate the current status of the call waiting services.
Upon successful completion the status information is returned via the aSSInfo argument. Support is available only for the voice line.
This functionality is not available when the phone is in "flight" mode.
| Parameter | Description |
|---|---|
| aRequestStatus | Returns the result code after the asynchronous call completes. Pass CCTelephony::ancelAsync() CTelephony::EGetCallWaitingStatusCancel to cancel. |
| aSSInfo | Contains a CTelephony::TCallWaitingSupplServicesV1Pckg, a packaged version of the CTelephony::TCallWaitingSupplServicesV1 class which is filled on completion. |
| aServiceGroup | Service group to be interrogated. |
| IMPORT_C void | GetCurrentNetworkInfo | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aNetworkInfo | |||
| ) | const | |||
Retrieves over-the-air network information about the currently registered mobile network.
This is an asynchronous method. Upon successful completion the network information is returned via the aDes argument.
This functionality is not available when the phone is in "flight" mode.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetCurrentNetworkInfoCancel to cancel. KErrAccessDenied is given to this request status if the device is in flight mode. |
| aNetworkInfo | Contains a CTelephony::TNetworkInfoV1Pckg, a packaged version of the CTelephony::TNetworkInfoV1 class which is filled on completion. |
| IMPORT_C void | GetCurrentNetworkName | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aNetworkName | |||
| ) | const | |||
Retrieves ICC-stored information about the (preferred) name of the currently registered mobile network.
This is an asynchronous method. Upon successful completion the retrieved network name(s) is returned via the aDes argument.
This functionality is not available when the phone is in "flight" mode.
Cancellation of the request can be achieved by passing CTelephony::EGetCurrentNetworkNameCancel to the function CTelephony::CancelAsync().
Note: This information is only available on GSM/WCDMA networks.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. KErrAccessDenied will be returned if the phone is in flight mode. |
| aNetworkName | Contains a CTelephony::TNetworkNameV1Pckg, a packaged version of the CTelephony::TNetworkNameV1 class which is filled on completion. |
| IMPORT_C void | GetFlightMode | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aMode | |||
| ) | const | |||
Retrieves the current flight mode status. The flight mode is returned via the aMode argument.
This is an asynchronous method.
If the flight mode status is set to "off" then all network-related requests are disabled.
If the phone s software does not support this feature then this method returns KErrNotSupported.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetFlightModeCancel to cancel. |
| aMode | Contains a CTelephony::TFlightModeV1Pckg, a packaged version of the CTelephony::TFlightModeV1 class which is filled on completion. |
| IMPORT_C void | GetIdentityServiceStatus | ( | TRequestStatus & | aReqStatus, |
| const TIdentityService & | aService, | |||
| TDes8 & | aStatus | |||
| ) | const | |||
Interrogate the current status of the identity services.
Specify the service for enquiry via the aService argument. Upon successful completion the service status is returned via the aStatus argument.
This functionality is not available when the phone is in "flight" mode.
Note: This information is only available on GSM/WCDMA networks.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetIdentityServiceStatusCancel to cancel. |
| aStatus | Contains a CTelephony::TIdentityServiceV1Pckg, a packaged version of the CTelephony::TIdentityServiceV1 class which is filled on completion. |
| IMPORT_C void | GetIndicator | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aIndicator | |||
| ) | const | |||
Retrieves the battery charging indicator, the network availability indicator and call-in-progress indicator.
This is an asynchronous method. The method returns two flags for each indicator: the first is a capability flag; it says whether the indicator is valid. The second flag is the indicator itself.
For instance, two flags are returned for the battery charging indicator. The capability flag is only set if the phone can detect when a charger is connected. The indicator flag is only set when a charger is actually connected. The indicator flag is only valid when the capability flag is set.
Six flags, two for each indicator, are returned by this method in the packaged aIndicator parameter.
See also: TPhoneIndicators
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetBatteryInfoCancel to cancel. |
| aIndicator | Contains a CTelephony::TIndicatorV1Pckg, a packaged version of the CTelephony::TIndicatorV1 class which is filled on completion. |
| IMPORT_C TInt | GetLineStatus | ( | const TPhoneLine & | aLine, |
| TDes8 & | aStatus | |||
| ) | const | |||
Retrieves the status of the line selected by the aLine argument. The current status of the selected line is returned to the client via the aStatus argument.
When only one call is in progress, the line status is identical to the status of the call.
When two calls are in progress (one active and one on hold) then the status of the most "active" (connected and active or in progress) call is returned.
This functionality is not available when the phone is in "flight" mode.
| Parameter | Description |
|---|---|
| aLine | Identifier to line from which status is to be retrieved. |
| aStatus | On completion contains the current line status in a CTelephony::TCallStatusV1Pckg, a packaged version of CTelephony::TCallStatusV1. |
Returns: KErrNone if successful, otherwise another of the system-wide error codes.
| IMPORT_C void | GetLockInfo | ( | TRequestStatus & | aReqStatus, |
| const TIccLock & | aLock, | |||
| TDes8 & | aLockInfo | |||
| ) | const | |||
Some phones allow users to lock them to prevent unauthorised use. Typically, a code must be entered to unlock the phone.
This method retrieves the state and status of ICC locks PIN1/2. The client selects the lock that it wishes to retrieve the status and state of.
This is an asynchronous method. Upon successful completion of the request the PIN1/2 information is returned via the aDes argument.
Note that this member function does not concern the keypad locks. Nor does it concern the lock that the networks use to prevent a phone from being used on other networks.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetLockInfoCancel to cancel. |
| aLock | Lock to interrogate. Either Pin1 or Pin2. |
| aLockInfo | Contains a CTelephony::TIccLockInfoV1Pckg, a packaged version of the CTelephony::TIccLockInfoV1 class which is filled on completion. |
| IMPORT_C void | GetNetworkRegistrationStatus | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aStatus | |||
| ) | const | |||
Retrieves the current network registration status.
This is an asynchronous method. Upon successful completion of this request the registration status is returned via the aDes argument.
This functionality is not available when the phone is in "flight" mode.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetNetworkRegistrationStatusCancel to cancel. |
| aStatus | Contains a CTelephony::TNetworkRegistrationV1Pckg, a packaged version of the CTelephony::TNetworkRegistrationV1 class which is filled on completion. |
| IMPORT_C void | GetOperatorName | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aOperator | |||
| ) | const | |||
Retrieve ICC stored information about the currently registered mobile network. Upon successful completion the retrieved network name(s) is returned via the aOperator argument.
This functionality is not available when the phone is in "flight" mode.
Cancellation of the request can be achieved by passing CTelephony::EGetOperatorNameCancel to the function CTelephony::CancelAsync().
Note: This information is only available on GSM/WCDMA networks.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. KErrAccessDenied will be returned if the phone is in flight mode. |
| aOperator | Contains a CTelephony::TOperatorNameV1Pckg, a packaged version of the CTelephony::TOperatorNameV1 class which is filled on completion. |
| IMPORT_C void | GetPhoneId | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aId | |||
| ) | const | |||
Retrieves the model information and unique identification of the mobile device.
This is an asynchronous method. Upon successful completion of the request the manufacturer name, model and serial number (IMEI or ESN) are returned back to the client via the aDes argument.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetPhoneIdCancel to cancel. |
| aId | Contains a CTelephony::TPhoneIdV1Pckg, a packaged version of the CTelephony::TPhoneIdV1 class which is filled on completion. |
| IMPORT_C void | GetSignalStrength | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aSignalStrength | |||
| ) | const | |||
Retrieves the phone's current signal strength via the aDes argument.
This is an asynchronous method.
If signal strength information is not supported by the phone the method will return KErrNotSupported. If no signal strength information is currently available the method will return KErrNotFound.
This functionality is not available when the phone is in "flight" mode.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetSignalStrengthCancel to cancel. |
| aSignalStrength | Contains a CTelephony::TSignalStrengthV1Pckg, a packaged version of the CTelephony::TSignalStrengthV1 class which is filled on completion. |
| IMPORT_C void | GetSubscriberId | ( | TRequestStatus & | aReqStatus, |
| TDes8 & | aId | |||
| ) | const | |||
Retrieves information about the mobile device's current subscriber. This will normally identify the SIM card on GSM and WCDMA networks or the R-UIM card on CDMA networks. It is independent of the phone.
This is an asynchronous method. Upon successful completion of the request the serial number of the SIM or R-UIM card is returned back to the client via the aDes argument.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetSubscriberIdCancel to cancel. |
| aId | Contains a CTelephony::TSubscriberIdV1Pckg, a packaged version of the CTelephony::TSubscriberIdV1 class which is filled on completion. |
| IMPORT_C void | Hangup | ( | TRequestStatus & | aReqStatus, |
| const TCallId & | aCallId | |||
| ) | const | |||
Hangs up a call. This is only for calls you dialled or answered with CTelephony.
The client specifies the call ID via the aCallId argument.
This is an asynchronous method. Upon successful completion of Hangup, the line and call status might be affected. Hangup is available only for the voice line.
This functionality is not available when the phone is in "flight" mode.
See also: AnswerIncomingCall() DialNewCall() Hold() Resume() Swap() GetCallStatus() GetCallDynamicCaps()
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EHangupCancel to cancel. |
| aCallId | Call ID, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall(). |
| IMPORT_C void | Hold | ( | TRequestStatus & | aReqStatus, |
| const TCallId & | aCallId | |||
| ) | const | |||
Places a call on hold. This is only for calls you dialled or answered with CTelephony.
The call's dynamic capabilities must allow the Hold operation for this call to have successful completion of this request; see CTelephony::GetCallDynamicCaps().
This is an asynchronous method. Upon successful completion of Hold, line and call status might be affected by this operation. Hold is only available for the voice line.
This functionality is not available when the phone is in "flight" mode.
See also: AnswerIncomingCall() DialNewCall() Resume() Swap() Hangup() GetCallStatus() GetCallDynamicCaps()
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EHoldCancel to cancel. |
| aCallId | Call ID, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall(). |
| IMPORT_C CTelephony * | NewL | ( | ) | [static] |
Constructs a CTelephony object.
No pointer to this object is left on the CleanupStack.
The returned pointer is typically assigned to a pointer-variable stored in the Heap.
Returns: Pointer to a newly created CTelephony object.
| IMPORT_C CTelephony * | NewLC | ( | ) | [static] |
Constructs a CTelephony object.
A pointer to this object is left on the CleanupStack.
The returned pointer is typically assigned to a pointer-variable on the stack.
Returns: Pointer to a newly created CTelephony object.
| IMPORT_C void | NotifyChange | ( | TRequestStatus & | aReqStatus, |
| const TNotificationEvent & | aEvent, | |||
| TDes8 & | aDes | |||
| ) | const | |||
Registers interest in receiving change notifications for events.
Specify the event that you are interested with the aEvent parameter.
Each event is associated with a packaged class. Pass an instance of this class to this method. Then, when the event occurs, information relating to the event is written into it. The description of CTelephony::TNotificationEvent tells you the information class for each event.
This is an asynchronous method. Notification can be cancelled using the cancellation codes specified in CTelephony::TNotificationEvent. Pass the appropriate code to CTelephony::CancelAsync() to cancel the notification request.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. |
| aEvent | Event on which change notification is requested. |
| aDes | Packaged information class. On completion, information relating to the event is written into this class. Until then, this class's data is not valid. |
This method is no longer supported.
It was used to receive a circuit-switched data call, but support was removed as functionality was no longer required by licensees. Developers should consider using GPRS via RConnection and RSocket for data functionality instead.
See also: RConnection RSocket RMobilePhone
Returns: KErrNotSupported
| IMPORT_C void | ReceiveDataCall | ( | TRequestStatus & | aRequestStatus, |
| TInt & | aDataChannel | |||
| ) | ||||
This method is no longer supported.
It was used to receive a circuit-switched data call, but support was removed as functionality was no longer required by licensees. Developers should consider using GPRS via RConnection and RSocket for data functionality instead.
See also: RConnection RSocket RMobilePhone
| IMPORT_C void | Resume | ( | TRequestStatus & | aReqStatus, |
| const TCallId & | aCallId | |||
| ) | const | |||
Resumes a held call. This is only for calls you dialled or answered with CTelephony. The client specifies the call ID via the aCallId argument.
The call's dynamic capabilities must allow the Resume operation for this call to have successful completion of this request; see CTelephony::GetCallDynamicCaps().
This is an asynchronous method. Upon successful completion of Resume, line and call status might be affected by this operation. Resume is only available for the voice line.
This functionality is not available when the phone is in "flight" mode.
See also: AnswerIncomingCall() DialNewCall() Hold() Swap() Hangup() GetCallStatus() GetCallDynamicCaps()
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EResumeCancel to cancel. |
| aCallId | Call ID, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall(). |
| IMPORT_C void | SendDTMFTones | ( | TRequestStatus & | aReqStatus, |
| const TDesC & | aTones | |||
| ) | const | |||
Transmits DTMF tones across all the current active voice calls.
This is an asynchronous method. The request completes when the tones have been sent. The string of DTMF characters is passed via the aTones parameter. The string of DTMF characters can contain one or more DTMF tone(s).
This functionality is not available when the phone is in "flight" mode.
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. use CTelephony::ESendDTMFTonesCancel to cancel. |
| aTones | String containing tones to transmit. It can contain one or more occurance of the numbers 0 to 9, * and #. |
| IMPORT_C void | Swap | ( | TRequestStatus & | aReqStatus, |
| const TCallId & | aCallId1, | |||
| const TCallId & | aCallId2 | |||
| ) | const | |||
Swaps calls. This is only for calls you dialled or answered with CTelephony.
Swap is possible only if both calls are owned by this ISV application. The client specifies the call ids via the aCallId1 and aCallId2 arguments.
This is an asynchronous method.
The calls' dynamic capabilities must allow the Swap operation for this call to have successful completion of this request; see CTelephony::GetCallDynamicCaps().
Swap is only available for the voice line.
This functionality is not available when the phone is in "flight" mode.
See also: AnswerIncomingCall() DialNewCall() Hold() Resume() Hangup() GetCallStatus() GetCallDynamicCaps()
| Parameter | Description |
|---|---|
| aReqStatus | Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::ESwapCancel to cancel. |
| aCallId1 | ID of a call, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall(). |
| aCallId2 | ID of another call, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall(). |
| IMPORT_C TInt | TerminateDataCall | ( | ) |
This method is no longer supported.
It was used to terminate a circuit-switched data call, but support was removed as functionality was no longer required by licensees. Developers should consider using GPRS via RConnection and RSocket for data functionality instead.
See also: RConnection RSocket RMobilePhone
Returns: KErrNotSupported
| TVersion | Version | ( | ) | const [inline] |
Get current CTelephony version
This function returns major, minor, and build version-numbers.
Returns: TVersion object, see E32STD.H