CTelephony Class Reference

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.

Inherits from

Public Member Functions
~CTelephony ()
IMPORT_C void AnswerIncomingCall ( TRequestStatus &, TCallId &, const TPhoneLine )
IMPORT_C TInt CancelAsync ( TCancellationRequest )
IMPORT_C void CancelEstablishDataCall ()
IMPORT_C void CancelReceiveDataCall ()
IMPORT_C void DialNewCall ( TRequestStatus &, TDes8 &, const TTelNumber &, TCallId &, const TPhoneLine )
IMPORT_C TInt EstablishDataCall ( TInt &, const TDesC &)
IMPORT_C void EstablishDataCall ( TRequestStatus &, TInt &, const TDesC &)
IMPORT_C TInt FindDeviceStatus ( TInt &)
IMPORT_C void GetBatteryInfo ( TRequestStatus &, TDes8 &)
IMPORT_C void GetCallBarringStatus ( TRequestStatus &, const TCallBarringCondition , TDes8 &, const TServiceGroup )
IMPORT_C TInt GetCallDynamicCaps (const TCallId &, TDes8 &)
IMPORT_C void GetCallForwardingStatus ( TRequestStatus &, const TCallForwardingCondition , TDes8 &, const TServiceGroup )
IMPORT_C TInt GetCallInfo ( TDes8 &, TDes8 &, TDes8 &)
IMPORT_C TInt GetCallStatus (const TCallId &, TDes8 &)
IMPORT_C void GetCallWaitingStatus ( TRequestStatus &, TDes8 &, const TServiceGroup )
IMPORT_C void GetCurrentNetworkInfo ( TRequestStatus &, TDes8 &)
IMPORT_C void GetCurrentNetworkName ( TRequestStatus &, TDes8 &)
IMPORT_C void GetFlightMode ( TRequestStatus &, TDes8 &)
IMPORT_C void GetIdentityServiceStatus ( TRequestStatus &, const TIdentityService &, TDes8 &)
IMPORT_C void GetIndicator ( TRequestStatus &, TDes8 &)
IMPORT_C TInt GetLineStatus (const TPhoneLine &, TDes8 &)
IMPORT_C void GetLockInfo ( TRequestStatus &, const TIccLock &, TDes8 &)
IMPORT_C void GetNetworkRegistrationStatus ( TRequestStatus &, TDes8 &)
IMPORT_C void GetOperatorName ( TRequestStatus &, TDes8 &)
IMPORT_C void GetPhoneId ( TRequestStatus &, TDes8 &)
IMPORT_C void GetSignalStrength ( TRequestStatus &, TDes8 &)
IMPORT_C void GetSubscriberId ( TRequestStatus &, TDes8 &)
IMPORT_C void Hangup ( TRequestStatus &, const TCallId &)
IMPORT_C void Hold ( TRequestStatus &, const TCallId &)
IMPORT_C CTelephony * NewL ()
IMPORT_C CTelephony * NewLC ()
IMPORT_C void NotifyChange ( TRequestStatus &, const TNotificationEvent &, TDes8 &)
IMPORT_C TInt ReceiveDataCall ( TInt &)
IMPORT_C void ReceiveDataCall ( TRequestStatus &, TInt &)
IMPORT_C void Resume ( TRequestStatus &, const TCallId &)
IMPORT_C void SendDTMFTones ( TRequestStatus &, const TDesC &)
IMPORT_C void Swap ( TRequestStatus &, const TCallId &, const TCallId &)
IMPORT_C TInt TerminateDataCall ()
TVersion Version ()
Private Member Functions
CTelephony ()
void ConstructL ()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enum anonymous { KEtelISVV1  = 1, KEtelISVV2  = 2 }
enum TBatteryStatus { EPowerStatusUnknown , EPoweredByBattery , EBatteryConnectedButExternallyPowered , ENoBatteryConnected , EPowerFault }
enum TCallBarringCondition { EBarAllIncoming , EBarIncomingRoaming , EBarAllOutgoing , EBarOutgoingInternational , EBarOutgoingInternationalExHC }
enum TCallDirection { EDirectionUnknown , EMobileOriginated , EMobileTerminated }
enum TCallForwardingCondition { ECallForwardingUnconditional , ECallForwardingBusy , ECallForwardingNoReply , ECallForwardingNotReachable }
enum TCallId { EISVCall1 , EISVCall2 , EISVMaxNumOfCalls }
enum TCallRemoteIdentityStatus { ERemoteIdentityUnknown , ERemoteIdentityAvailable , ERemoteIdentitySuppressed }
enum TCallSelect { EActiveCall , EHeldCall , EInProgressCall }
enum TCallStatus {
EStatusUnknown , EStatusIdle , EStatusDialling , EStatusRinging , EStatusAnswering , EStatusConnecting , EStatusConnected , EStatusReconnectPending , EStatusDisconnecting , EStatusHold , EStatusTransferring , EStatusTransferAlerting
}
enum TCallerIdentityRestrict { EIdRestrictDefault , ESendMyId , EDontSendMyId }
enum TCancellationRequest {
EGetPhoneIdCancel , EGetSubscriberIdCancel , EGetFlightModeCancel , EFlightModeChangeCancel , EGetIndicatorCancel , EIndicatorChangeCancel , EGetBatteryInfoCancel , EBatteryInfoChangeCancel , EGetSignalStrengthCancel , ESignalStrengthChangeCancel , EGetLockInfoCancel , EPin1LockInfoChangeCancel , EPin2LockInfoChangeCancel , EVoiceLineStatusChangeCancel , EOwnedCall1StatusChangeCancel , EOwnedCall2StatusChangeCancel , EOwnedCall1RemotePartyInfoChangeCancel , EOwnedCall2RemotePartyInfoChangeCancel , ESendDTMFTonesCancel , EDialNewCallCancel , EHoldCancel , EResumeCancel , ESwapCancel , EHangupCancel , EAnswerIncomingCallCancel , EGetNetworkRegistrationStatusCancel , ENetworkRegistrationStatusChangeCancel , EGetCurrentNetworkInfoCancel , ECurrentNetworkInfoChangeCancel , EGetCurrentNetworkNameCancel , EGetOperatorNameCancel , EGetCallForwardingStatusCancel , EGetCallBarringStatusCancel , EGetCallWaitingStatusCancel , EGetIdentityServiceStatusCancel , EFaxLineStatusChangeCancel , EDataLineStatusChangeCancel
}
enum TFlightModeStatus { EFlightModeOff  = 0, EFlightModeOn  = 1 }
enum TIccLock { ELockPin1 , ELockPin2 }
enum TIccLockSetting { ELockSetUnknown , ELockSetEnabled , ELockSetDisabled }
enum TIccLockStatus { EStatusLockUnknown , EStatusLocked , EStatusUnlocked , EStatusBlocked }
enum TIdentityService { EIdServiceUnspecified , EIdServiceCallerPresentation , EIdServiceCallerRestriction }
enum TIdentityServiceStatus { EIdServiceActivePermanent , EIdServiceActiveDefaultRestricted , EIdServiceActiveDefaultAllowed , EIdServiceNotProvisioned , EIdServiceUnknown }
enum TMobileCallControlCaps { KCapsHold  = 0x00000200, KCapsResume  = 0x00000400, KCapsSwap  = 0x00000800 }
enum TNetworkAccess { ENetworkAccessUnknown , ENetworkAccessGsm , ENetworkAccessGsmCompact , ENetworkAccessUtran }
enum TNetworkBandInfo {
EBandUnknown , E800BandA , E800BandB , E800BandC , E1900BandA , E1900BandB , E1900BandC , E1900BandD , E1900BandE , E1900BandF
}
enum TNetworkMode {
ENetworkModeUnknown , ENetworkModeUnregistered , ENetworkModeGsm , ENetworkModeAmps , ENetworkModeCdma95 , ENetworkModeCdma2000 , ENetworkModeWcdma , ENetworkModeTdcdma
}
enum TNetworkStatus { ENetworkStatusUnknown , ENetworkStatusAvailable , ENetworkStatusCurrent , ENetworkStatusForbidden }
enum TNotificationEvent {
EFlightModeChange , EIndicatorChange , EBatteryInfoChange , ESignalStrengthChange , EPin1LockInfoChange , EPin2LockInfoChange , EVoiceLineStatusChange , EOwnedCall1StatusChange , EOwnedCall2StatusChange , EOwnedCall1RemotePartyInfoChange , EOwnedCall2RemotePartyInfoChange , ENetworkRegistrationStatusChange , ECurrentNetworkInfoChange , EFaxLineStatusChange , EDataLineStatusChange
}
enum TPhoneIndicators { KIndChargerConnected  = 0x00000001, KIndNetworkAvailable  = 0x00000002, KIndCallInProgress  = 0x00000004 }
enum TPhoneLine { EVoiceLine , EDataLine , EFaxLine }
enum TPhoneNetworkSecurity { ECipheringOff , ECipheringGSM , ECipheringWCDMA }
enum TRegistrationStatus {
ERegistrationUnknown , ENotRegisteredNoService , ENotRegisteredEmergencyOnly , ENotRegisteredSearching , ERegisteredBusy , ERegisteredOnHomeNetwork , ERegistrationDenied , ERegisteredRoaming
}
enum TServiceGroup { EVoiceService , EFaxService , EDataService }
enum TSupplServiceStatus { EStatusActive , ENotActive , ENotProvisioned , ENotAvailable , EUnknown }
enum TTelNumberNPI {
EUnknownNumberingPlan  = 0, EIsdnNumberPlan  = 1, EDataNumberPlan  = 3, ETelexNumberPlan  = 4, EServiceCentreSpecificPlan1  = 5, EServiceCentreSpecificPlan2  = 6, ENationalNumberPlan  = 8, EPrivateNumberPlan  = 9, EERMESNumberPlan  = 10
}
enum TTelNumberTON {
EUnknownNumber , EInternationalNumber , ENationalNumber , ENetworkSpecificNumber , ESubscriberNumber , EAlphanumericNumber , EAbbreviatedNumber
}
Public Member Type Definitions
typedef TPckg < TBatteryInfoV1 > TBatteryInfoV1Pckg
typedef TPckg < TCallBarringSupplServicesV1 > TCallBarringSupplServicesV1Pckg
typedef TPckg < TCallCapsV1 > TCallCapsV1Pckg
typedef TPckg < TCallForwardingSupplServicesV1 > TCallForwardingSupplServicesV1Pckg
typedef TPckg < TCallInfoV1 > TCallInfoV1Pckg
typedef TPckg < TCallParamsV1 > TCallParamsV1Pckg
typedef TPckg < TCallSelectionV1 > TCallSelectionV1Pckg
typedef TPckg < TCallStatusV1 > TCallStatusV1Pckg
typedef TPckg < TCallWaitingSupplServicesV1 > TCallWaitingSupplServicesV1Pckg
typedef TPckg < TFlightModeV1 > TFlightModeV1Pckg
typedef TPckg < TIccLockInfoV1 > TIccLockInfoV1Pckg
typedef TPckg < TIdentityServiceV1 > TIdentityServiceV1Pckg
typedef TPckg < TIndicatorV1 > TIndicatorV1Pckg
typedef TPckg < TNetworkInfoV1 > TNetworkInfoV1Pckg
typedef TPckg < TNetworkInfoV2 > TNetworkInfoV2Pckg
typedef TPckg < TNetworkNameV1 > TNetworkNameV1Pckg
typedef TPckg < TNetworkNameV2 > TNetworkNameV2Pckg
typedef TPckg < TNetworkRegistrationV1 > TNetworkRegistrationV1Pckg
typedef TPckg < TOperatorNameV1 > TOperatorNameV1Pckg
typedef TPckg < TPhoneIdV1 > TPhoneIdV1Pckg
typedef TPckg < TRemotePartyInfoV1 > TRemotePartyInfoV1Pckg
typedef TPckg < TSignalStrengthV1 > TSignalStrengthV1Pckg
typedef TPckg < TSubscriberIdV1 > TSubscriberIdV1Pckg
typedef TBuf < KMaxTelNumberSize > TTelNumber
Private Attributes
CTelephonyFunctions * iTelephonyFunctions

Constructor & Destructor Documentation

CTelephony()

CTelephony ( ) [private]

~CTelephony()

~CTelephony ( )

Destructor

Deletes the underlying CTelephonyFunctions object.

Member Functions Documentation

AnswerIncomingCall(TRequestStatus &, TCallId &, const TPhoneLine)

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.

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EAnswerIncomingCallCancel to cancel
TCallId & aCallId On completion, contains the call ID.
const TPhoneLine aLine = EVoiceLine Line from which the answer request will attempted. Currently, only the voice line is supported.

CancelAsync(TCancellationRequest)

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.

capability
None

Parameters

TCancellationRequest aCancel Canncellation code of request to be cancelled.

CancelEstablishDataCall()

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.

RConnection RSocket RMobilePhone

CancelReceiveDataCall()

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.

RConnection RSocket RMobilePhone

ConstructL()

void ConstructL ( ) [private]

DialNewCall(TRequestStatus &, TDes8 &, const TTelNumber &, TCallId &, const TPhoneLine)

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.

Parameters

TRequestStatus & aStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EDialNewCallCancel to cancel.
TDes8 & aCallParams The call parameters used by the TSY. Pass a CTelephony::TCallParamsV1Pckg, a packaged CTelephony::TCallParamsV1.
const TTelNumber & aTelNumber Telephone number to dial.
TCallId & aCallId Upon completion, contains the call identifier.
const TPhoneLine aLine = EVoiceLine Line on which call can be made. Currently, only voice calls are supported.

EstablishDataCall(TInt &, const TDesC &)

IMPORT_C TInt EstablishDataCall ( 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.

RConnection RSocket RMobilePhone

Parameters

TInt & aDataChannel
const TDesC & aDialNumber

EstablishDataCall(TRequestStatus &, TInt &, const TDesC &)

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.

RConnection RSocket RMobilePhone

Parameters

TRequestStatus & aRequestStatus
TInt & aDataChannel
const TDesC & aDialNumber

FindDeviceStatus(TInt &)

IMPORT_C TInt FindDeviceStatus ( TInt & aCallStatus )

This method is no longer supported.

Parameters

TInt & aCallStatus

GetBatteryInfo(TRequestStatus &, TDes8 &)

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.

capability
None

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetBatteryInfoCancel to cancel.
TDes8 & aBatteryInfo Contains a CTelephony::TBatteryInfoV1Pckg, a packaged version of the CTelephony::TBatteryInfoV1 class which is filled on completion.

GetCallBarringStatus(TRequestStatus &, const TCallBarringCondition, TDes8 &, const TServiceGroup)

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.

capability
ReadDeviceData
capability
NetworkServices

Parameters

TRequestStatus & aRequestStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetCallBarringStatusCancel to cancel.
const TCallBarringCondition aCondition Call barring condition to be interrogated.
TDes8 & aSSInfo Contains a CTelephony::TCallBarringSupplServicesV1Pckg, a packaged version of the CTelephony::TCallBarringSupplServicesV1 class which is filled on completion.
const TServiceGroup aServiceGroup = EVoiceService Service group to be interrogated.

GetCallDynamicCaps(const TCallId &, TDes8 &)

IMPORT_C TInt GetCallDynamicCaps ( const TCallId & aCallId,
TDes8 & aCallCaps
) const

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.

capability
None

Parameters

const TCallId & aCallId Call ID, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall().
TDes8 & aCallCaps On completion contains a CTelephony::TCallCapsV1Pckg, a packaged CTelephony::TCallCapsV1 containing the call's dynamic capabilities.

GetCallForwardingStatus(TRequestStatus &, const TCallForwardingCondition, TDes8 &, const TServiceGroup)

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.

capability
ReadDeviceData
capability
NetworkServices

Parameters

TRequestStatus & aRequestStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetCallForwardingStatusCancel to cancel.
const TCallForwardingCondition aCondition Call forwarding condition to be interrogated.
TDes8 & aSSInfo Contains a CTelephony::TCallForwardingSupplServicesV1Pckg, a packaged version of the CTelephony::TCallForwardingSupplServicesV1 class which is filled on completion.
const TServiceGroup aServiceGroup = EVoiceService Service group to be interrogated.

GetCallInfo(TDes8 &, TDes8 &, TDes8 &)

IMPORT_C TInt GetCallInfo ( TDes8 & aCallSelect,
TDes8 & aCallInfo,
TDes8 & aRemoteInfo
) const

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.

capability
ReadUserData

Parameters

TDes8 & aCallSelect Identifies the call for which information is retrieved.
TDes8 & aCallInfo Contains CTelephony::TCallInfoV1Pckg, the packaged CTelephony::TCallInfoV1 parameter class which is filled on completion.
TDes8 & aRemoteInfo Contains CTelephony::TRemotePartyInfoV1Pckg, the packaged CTelephony::TRemotePartyInfoV1 parameter class which is filled on completion.

GetCallStatus(const TCallId &, TDes8 &)

IMPORT_C TInt GetCallStatus ( const TCallId & aCallId,
TDes8 & aCallStatus
) const

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.

Parameters

const TCallId & aCallId Call ID, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall().
TDes8 & aCallStatus On completion contains a CTelephony::TCallStatusV1Pckg, a packaged CTelephony::TCallStatusV1 containing the call status.

GetCallWaitingStatus(TRequestStatus &, TDes8 &, const TServiceGroup)

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.

capability
ReadDeviceData
capability
NetworkServices

Parameters

TRequestStatus & aRequestStatus Returns the result code after the asynchronous call completes. Pass CCTelephony::ancelAsync() CTelephony::EGetCallWaitingStatusCancel to cancel.
TDes8 & aSSInfo Contains a CTelephony::TCallWaitingSupplServicesV1Pckg, a packaged version of the CTelephony::TCallWaitingSupplServicesV1 class which is filled on completion.
const TServiceGroup aServiceGroup = EVoiceService Service group to be interrogated.

GetCurrentNetworkInfo(TRequestStatus &, TDes8 &)

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.

capability
ReadDeviceData because Cell ID is retrieved from the platform.

Parameters

TRequestStatus & 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.
TDes8 & aNetworkInfo Contains a CTelephony::TNetworkInfoV1Pckg, a packaged version of the CTelephony::TNetworkInfoV1 class which is filled on completion.

GetCurrentNetworkName(TRequestStatus &, TDes8 &)

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.

capability
None

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. KErrAccessDenied will be returned if the phone is in flight mode.
TDes8 & aNetworkName Contains a CTelephony::TNetworkNameV1Pckg, a packaged version of the CTelephony::TNetworkNameV1 class which is filled on completion.

GetFlightMode(TRequestStatus &, TDes8 &)

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.

capability
None

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetFlightModeCancel to cancel.
TDes8 & aMode Contains a CTelephony::TFlightModeV1Pckg, a packaged version of the CTelephony::TFlightModeV1 class which is filled on completion.

GetIdentityServiceStatus(TRequestStatus &, const TIdentityService &, TDes8 &)

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.

capability
None

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetIdentityServiceStatusCancel to cancel.
const TIdentityService & aService
TDes8 & aStatus Contains a CTelephony::TIdentityServiceV1Pckg, a packaged version of the CTelephony::TIdentityServiceV1 class which is filled on completion.

GetIndicator(TRequestStatus &, TDes8 &)

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.

TPhoneIndicators
capability
None

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetBatteryInfoCancel to cancel.
TDes8 & aIndicator Contains a CTelephony::TIndicatorV1Pckg, a packaged version of the CTelephony::TIndicatorV1 class which is filled on completion.

GetLineStatus(const TPhoneLine &, TDes8 &)

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.

capability
None

Parameters

const TPhoneLine & aLine Identifier to line from which status is to be retrieved.
TDes8 & aStatus On completion contains the current line status in a CTelephony::TCallStatusV1Pckg, a packaged version of CTelephony::TCallStatusV1.

GetLockInfo(TRequestStatus &, const TIccLock &, TDes8 &)

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.

capability
ReadDeviceData

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetLockInfoCancel to cancel.
const TIccLock & aLock Lock to interrogate. Either Pin1 or Pin2.
TDes8 & aLockInfo Contains a CTelephony::TIccLockInfoV1Pckg, a packaged version of the CTelephony::TIccLockInfoV1 class which is filled on completion.

GetNetworkRegistrationStatus(TRequestStatus &, TDes8 &)

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.

capability
None

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetNetworkRegistrationStatusCancel to cancel.
TDes8 & aStatus Contains a CTelephony::TNetworkRegistrationV1Pckg, a packaged version of the CTelephony::TNetworkRegistrationV1 class which is filled on completion.

GetOperatorName(TRequestStatus &, TDes8 &)

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.

capability
None

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. KErrAccessDenied will be returned if the phone is in flight mode.
TDes8 & aOperator Contains a CTelephony::TOperatorNameV1Pckg, a packaged version of the CTelephony::TOperatorNameV1 class which is filled on completion.

GetPhoneId(TRequestStatus &, TDes8 &)

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.

capability
None

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetPhoneIdCancel to cancel.
TDes8 & aId Contains a CTelephony::TPhoneIdV1Pckg, a packaged version of the CTelephony::TPhoneIdV1 class which is filled on completion.

GetSignalStrength(TRequestStatus &, TDes8 &)

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.

capability
None

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetSignalStrengthCancel to cancel.
TDes8 & aSignalStrength Contains a CTelephony::TSignalStrengthV1Pckg, a packaged version of the CTelephony::TSignalStrengthV1 class which is filled on completion.

GetSubscriberId(TRequestStatus &, TDes8 &)

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.

capability
ReadDeviceData

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EGetSubscriberIdCancel to cancel.
TDes8 & aId Contains a CTelephony::TSubscriberIdV1Pckg, a packaged version of the CTelephony::TSubscriberIdV1 class which is filled on completion.

Hangup(TRequestStatus &, const TCallId &)

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.

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EHangupCancel to cancel.
const TCallId & aCallId Call ID, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall().

Hold(TRequestStatus &, const TCallId &)

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.

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EHoldCancel to cancel.
const TCallId & aCallId Call ID, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall().

NewL()

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.

NewLC()

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.

NotifyChange(TRequestStatus &, const TNotificationEvent &, TDes8 &)

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.

capability
Dependent This function depends on the TNotificationEvent value passed to it.

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes.
const TNotificationEvent & aEvent Event on which change notification is requested.
TDes8 & 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.

ReceiveDataCall(TInt &)

IMPORT_C TInt ReceiveDataCall ( 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.

RConnection RSocket RMobilePhone

Parameters

TInt & aDataChannel

ReceiveDataCall(TRequestStatus &, TInt &)

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.

RConnection RSocket RMobilePhone

Parameters

TRequestStatus & aRequestStatus
TInt & aDataChannel

Resume(TRequestStatus &, const TCallId &)

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.

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::EResumeCancel to cancel.
const TCallId & aCallId Call ID, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall().

SendDTMFTones(TRequestStatus &, const TDesC &)

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.

capability
NetworkServices

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. use CTelephony::ESendDTMFTonesCancel to cancel.
const TDesC & aTones String containing tones to transmit. It can contain one or more occurance of the numbers 0 to 9, * and #.

Swap(TRequestStatus &, const TCallId &, const TCallId &)

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.

Parameters

TRequestStatus & aReqStatus Returns the result code after the asynchronous call completes. Pass CTelephony::CancelAsync() CTelephony::ESwapCancel to cancel.
const TCallId & aCallId1 ID of a call, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall().
const TCallId & aCallId2 ID of another call, as returned by CTelephony::DialNewCall() or CTelephony::AnswerIncomingCall().

TerminateDataCall()

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.

RConnection RSocket RMobilePhone

Version()

TVersion Version ( ) const [inline]

Get current CTelephony version

This function returns major, minor, and build version-numbers.

Member Enumerations Documentation

Enum anonymous

Unique parameter class identifier.

Enumerators

KEtelISVV1 = 1

Unique reference identifier for Etel 3rd Party v1.0 parameter classes.

KEtelISVV2 = 2

Unique reference identifier for Etel 3rd Party v2.0 parameter classes.

Enum TBatteryStatus

The mobile phone battery status.

Enumerators

EPowerStatusUnknown

The phone software can not determine the phone's current power status.

EPoweredByBattery

The phone is powered by the battery.

EBatteryConnectedButExternallyPowered

A battery is connected, but the phone is externally powered.

ENoBatteryConnected

No battery is connected.

EPowerFault

Power fault.

Enum TCallBarringCondition

Call Barring conditions.

Enumerators

EBarAllIncoming

All incoming calls to this subscriber are barred (BAIC).

EBarIncomingRoaming

All incoming calls to this subscriber are barred when roaming outside the home PLMN country (BAIC-roam).

EBarAllOutgoing

All outgoing calls by this subscriber are barred (BAOC).

EBarOutgoingInternational

All outgoing international calls by this subscriber are barred (BOIC).

EBarOutgoingInternationalExHC

All outgoing international calls except those directed to the home PLMN country by this subscriber are barred (BOIC-ExHC).

Enum TCallDirection

The direction of the call.

Enumerators

EDirectionUnknown

The direction of the call is unknown.

EMobileOriginated

The call was originated by this phone, i.e. it is an outgoing call.

EMobileTerminated

The call was terminated by this phone, i.e. it is an incoming call.

Enum TCallForwardingCondition

Call Forwarding conditions.

Enumerators

ECallForwardingUnconditional

All calls to this subscriber are forwarded.

ECallForwardingBusy

Calls are forwarded when this subscriber is busy.

ECallForwardingNoReply

Calls are forwarded when this subscriber does not reply within a timeout period.

ECallForwardingNotReachable

Calls are forwarded when this subscriber is unreachable.

Enum TCallId

Etel 3rd Party owned call identifiers

Enumerators

EISVCall1

Call owned by this ISV application.

EISVCall2

Call owned by this ISV application.

EISVMaxNumOfCalls

Max number of calls supported by Etel 3rd Party.

Enum TCallRemoteIdentityStatus

Remote party identity status.

Enumerators

ERemoteIdentityUnknown

The remote party's identity can not be determined.

ERemoteIdentityAvailable

The remote party's identity is available.

ERemoteIdentitySuppressed

The remote party has suppressed the transmission of its identity.

Enum TCallSelect

Select a call defined by it current stats.

Enumerators

EActiveCall

Currently active call.

EHeldCall

Currently held (applicable only for voice) call.

EInProgressCall

Call during the setup/disconnecting process - (dialling/connecting/answering/hanging up).

Enum TCallStatus

Describes the possible call or line states.

Enumerators

EStatusUnknown

Indicates that the status is unknown.

EStatusIdle

Idle line status (no active calls).

EStatusDialling

Call dialling status .

EStatusRinging

Call ringing status.

EStatusAnswering

Call answering status.

EStatusConnecting

Call connecting status.

EStatusConnected

Call connected status.

EStatusReconnectPending

Call is undergoing temporary channel loss and it may or may not be reconnected.

EStatusDisconnecting

Call disconnecting status.

EStatusHold

Call on hold.

EStatusTransferring

Call is transferring.

EStatusTransferAlerting

Call in transfer is alerting the remote party.

Enum TCallerIdentityRestrict

Caller Id restriction settings.

Enumerators

EIdRestrictDefault

The default setting should be used if the user has not explicitly requested their identity to be restricted/allowed.

ESendMyId

The user has explicitly requested their identity to be sent for this call.

EDontSendMyId

The user has explicitly requested their identity not to be sent for this call.

Enum TCancellationRequest

Cancel apending request

Enumerators

EGetPhoneIdCancel

Cancel a pending GetPhoneId request.

EGetSubscriberIdCancel

Cancel a pending GetSubscriberId request.

EGetFlightModeCancel

Cancel a pending GetFlightMode request.

EFlightModeChangeCancel

Cancel a pending FlightModeChange request.

EGetIndicatorCancel

Cancel a pending GetIndicator request.

EIndicatorChangeCancel

Cancel a pending IndicatorChange request.

EGetBatteryInfoCancel

Cancel a pending GetBatteryInfo request.

EBatteryInfoChangeCancel

Cancel a pending BatteryInfoChange request.

EGetSignalStrengthCancel

Cancel a pending GetSignalStrength request.

ESignalStrengthChangeCancel

Cancel a pending SignalStrengthChange request.

EGetLockInfoCancel

Cancel a pending GetLockInfo request.

EPin1LockInfoChangeCancel

Cancel a pending Pin 1 LockInfoChange request.

EPin2LockInfoChangeCancel

Cancel a pending Pin 2 LockInfoChange request.

EVoiceLineStatusChangeCancel

Cancel a pending VoiceLineStatusChange request.

EOwnedCall1StatusChangeCancel

Cancel a pending Call1StatusChange request.

EOwnedCall2StatusChangeCancel

Cancel a pending Call2StatusChange request.

EOwnedCall1RemotePartyInfoChangeCancel

Cancel a pending OwnedCall1RemotePartyInfoChange request.

EOwnedCall2RemotePartyInfoChangeCancel

Cancel a pending OwnedCall2RemotePartyInfoChange request.

ESendDTMFTonesCancel

Cancel a pending SendDTMFTones request.

EDialNewCallCancel

Cancel a pending DialNewCall request.

EHoldCancel

Cancel a pending Hold request.

EResumeCancel

Cancel a pending Resume request.

ESwapCancel

Cancel a pending Swap request.

EHangupCancel

Cancel a pending Hangup request.

EAnswerIncomingCallCancel

Cancel a pending AnswerIncomingCall request.

EGetNetworkRegistrationStatusCancel

Cancel a pending GetNetworkRegistrationStatus request.

ENetworkRegistrationStatusChangeCancel

Cancel a pending NetworkRegistrationStatusChange request.

EGetCurrentNetworkInfoCancel

Cancel a pending GetCurrentNetworkInfo request.

ECurrentNetworkInfoChangeCancel

Cancel a pending CurrentNetworkInfoChange request.

EGetCurrentNetworkNameCancel

Cancel a pending GetCurrentNetworkName request.

EGetOperatorNameCancel

Cancel a pending GetOperatorName request.

EGetCallForwardingStatusCancel

Cancel a pending GetCallForwardingStatus request.

EGetCallBarringStatusCancel

Cancel a pending GetCallBarringStatus request.

EGetCallWaitingStatusCancel

Cancel a pending GetCallWaitingStatus request.

EGetIdentityServiceStatusCancel

Cancel a pending GetIdentityServiceStatus request.

EFaxLineStatusChangeCancel

Cancel a pending FaxLineStatusChange request.

EDataLineStatusChangeCancel

Cancel a pending DataLineStatusChange request.

Enum TFlightModeStatus

The flight mode status.

Enumerators

EFlightModeOff = 0

Flight mode is off.

EFlightModeOn = 1

Flight mode is on.

Enum TIccLock

Pin 1/Pin 2 security

Enumerators

ELockPin1

Lock PIN1 on the ICC.

ELockPin2

Lock PIN2 on the ICC.

Enum TIccLockSetting

Setting of the ICC lock.

Enumerators

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 .

Enum TIccLockStatus

Status of an ICC lock.

Enumerators

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.

Enum TIdentityService

Phone ID services.

Enumerators

EIdServiceUnspecified

The identity service is unspecified.

EIdServiceCallerPresentation

The caller's ID is presented to the called party.

EIdServiceCallerRestriction

The caller's ID is restricted to the called party.

Enum TIdentityServiceStatus

Service status of the Phone ID services.

Enumerators

EIdServiceActivePermanent

The interrogated identity service is provisioned and permanently active.

EIdServiceActiveDefaultRestricted

The interrogated identity service is provisioned and active. By default, the number is restricted unless overridden by the user.

EIdServiceActiveDefaultAllowed

The interrogated identity service is provisioned and active. By default, the number is displayed unless specifically restricted by the user.

EIdServiceNotProvisioned

The interrogated identity service is not provisioned.

EIdServiceUnknown

The status of the interrogated Identity service is unknown.

Enum TMobileCallControlCaps

Mobile call control capabilities.

Enumerators

KCapsHold = 0x00000200

Indicates that this call can be put on hold. This implies that the call is currently active and that there is no other held call.

KCapsResume = 0x00000400

Indicates that this call can be resumed. This implies that the call is currently on hold and that there is no other active call.

KCapsSwap = 0x00000800

Indicates that this call's state can be swapped to the opposite state. This implies that this call is either active or held. There may be another call in the opposite state and if this is the case then both calls will be simultaneously swapped to their opposite state.

Enum TNetworkAccess

The access technology that the network is based on.

Enumerators

ENetworkAccessUnknown

This is used when there is no network activity and therefore no RAT active.

ENetworkAccessGsm

The access technology is GSM.

ENetworkAccessGsmCompact

The access technology is GSM COMPACT. However GSM COMPACT systems which use GSM frequency bands but with the CBPCCH broadcast channel are considered as a separate access technology from GSM.

ENetworkAccessUtran

The access technology is UTRAN (UMTS Network).

Enum TNetworkBandInfo

Mobile phone network band information.

Enumerators

EBandUnknown

The current band and band class is unknown.

E800BandA

The network operates at 800MHz on Band A.

E800BandB

The network operates at 800MHz on Band B.

E800BandC

The network operates at 800MHz on Band C.

E1900BandA

The network operates at 1900MHz on Band A.

E1900BandB

The network operates at 1900MHz on Band B.

E1900BandC

The network operates at 1900MHz on Band C.

E1900BandD

The network operates at 1900MHz on Band D.

E1900BandE

The network operates at 1900MHz on Band E.

E1900BandF

The network operates at 1900MHz on Band F.

Enum TNetworkMode

Defines Current Network Modes.

Enumerators

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.

Enum TNetworkStatus

Phone network status.

Enumerators

ENetworkStatusUnknown

Status is unknown.

ENetworkStatusAvailable

A network that the mobile device is allowed to register to.

ENetworkStatusCurrent

Currently registered network.

ENetworkStatusForbidden

A network that the ME is not allowed to register to.

Enum TNotificationEvent

Notification events

Enumerators

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.

capability
ReadDeviceData CTelephony::NotifyChange
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.

capability
ReadDeviceData CTelephony::NotifyChange
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.

capability
ReadUserData CTelephony::NotifyChange
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.

capability
ReadUserData CTelephony::NotifyChange
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.

capability
ReadDeviceData CTelephony::NotifyChange
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.

Enum TPhoneIndicators

The mobile phone indicators.

Enumerators

KIndChargerConnected = 0x00000001

If bit-flag is set to '1' indicates that the battery charger is connected to the phone. If bit-flag is set to '0' indicates that the battery charger is disconnected

For capability: If bit-flag is set to '0' indicates that the battery charger indication reporting is unavailable.

KIndNetworkAvailable = 0x00000002

If bit-flag is set to '1' indicates that network service is available. If bit-flag is set to '0' indicates that network service is unavailable

For capability: If bit-flag is set to '0' indicates that the network availability indication reporting is unavailable.

KIndCallInProgress = 0x00000004

If bit-flag is set to '1' indicates that a call is in progress. If set to '0' indicates that a call is not in progress

For capability: If bit-flag is set to '0' indicates that the call is in progress indication reporting is unavailable.

Enum TPhoneLine

Line types

Enumerators

EVoiceLine

Voice line.

EDataLine

Data line.

EFaxLine

Fax line.

Enum TPhoneNetworkSecurity

Enumerated network security types.

Enumerators

ECipheringOff

The encryption level is NONE.

ECipheringGSM

The encryption level is GSM.(standard encryption algorithms for 2nd Generation Mobile networks).

ECipheringWCDMA

The encryption level is WDCMA.(standard encryption algorithms for 3rd Generation Mobile networks).

Enum TRegistrationStatus

The registration status of the phone.

Enumerators

ERegistrationUnknown

Registration status is unknown.

ENotRegisteredNoService

Not registered. The ME can not detect any other networks and is not currently searching a new operator to register to.

ENotRegisteredEmergencyOnly

Not registered. The ME can detect other networks on which it is possible to make emergency calls only.

ENotRegisteredSearching

Not registered, but the ME is currently searching a new operator to register to.

ERegisteredBusy

Registered, network busy.

ERegisteredOnHomeNetwork

Registered on home network.

ERegistrationDenied

Registration denied.

ERegisteredRoaming

Registered, roaming.

Enum TServiceGroup

Service group identifier.

Enumerators

EVoiceService

Voice service group

EFaxService

Fax service group

EDataService

Data service group

Enum TSupplServiceStatus

Supplementary Service status.

Enumerators

EStatusActive

The supplementary service is currently active and operative.

ENotActive

The supplementary service is currently deactivated or quiescent.

ENotProvisioned

In GSM/WCDMA mode, the supplementary service is not provisioned. In CDMA mode, this value has no meaning.

ENotAvailable

In GSM/WCDMA mode, the supplementary service is not available in serving network. In CDMA mode, the supplementary service is not available in the phone.

EUnknown

The phone can not determine supplementary service status.

Enum TTelNumberNPI

Number Plan Indicator.

Enumerators

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.

Enum TTelNumberTON

Address types.

Enumerators

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.

Member Type Definitions Documentation

Typedef TBatteryInfoV1Pckg

typedef TPckg < TBatteryInfoV1 > TBatteryInfoV1Pckg

A typedef'd packaged CTelephony::TBatteryInfoV1 for passing through a generic API method.

Typedef TCallBarringSupplServicesV1Pckg

typedef TPckg < TCallBarringSupplServicesV1 > TCallBarringSupplServicesV1Pckg

A typedef'd packaged CTelephony::TCallBarringSupplServicesV1 for passing through a generic API method.

Typedef TCallCapsV1Pckg

typedef TPckg < TCallCapsV1 > TCallCapsV1Pckg

A typedef'd packaged CTelephony::TCallParamsV1 for passing through a generic API method.

Typedef TCallForwardingSupplServicesV1Pckg

typedef TPckg < TCallForwardingSupplServicesV1 > TCallForwardingSupplServicesV1Pckg

A typedef'd packaged CTelephony::TCallForwardingSupplServicesV1 for passing through a generic API method.

Typedef TCallInfoV1Pckg

typedef TPckg < TCallInfoV1 > TCallInfoV1Pckg

A typedef'd packaged CTelephony::TCallInfoV1 for passing through a generic API method.

Typedef TCallParamsV1Pckg

typedef TPckg < TCallParamsV1 > TCallParamsV1Pckg

A typedef'd packaged CTelephony::TCallParamsV1 for passing through a generic API method.

Typedef TCallSelectionV1Pckg

typedef TPckg < TCallSelectionV1 > TCallSelectionV1Pckg

A typedef'd packaged CTelephony::TCallSelectionV1 for passing through a generic API method.

Typedef TCallStatusV1Pckg

typedef TPckg < TCallStatusV1 > TCallStatusV1Pckg

A typedef'd packaged CTelephony::TCallStatusV1 for passing through a generic API method.

Typedef TCallWaitingSupplServicesV1Pckg

typedef TPckg < TCallWaitingSupplServicesV1 > TCallWaitingSupplServicesV1Pckg

A typedef'd packaged CTelephony::TCallWaitingSupplServicesV1 for passing through a generic API method.

Typedef TFlightModeV1Pckg

typedef TPckg < TFlightModeV1 > TFlightModeV1Pckg

A typedef'd packaged CTelephony::TFlightModeV1 for passing through a generic API method.

Typedef TIccLockInfoV1Pckg

typedef TPckg < TIccLockInfoV1 > TIccLockInfoV1Pckg

A typedef'd packaged CTelephony::TIccLockInfoV1 for passing through a generic API method.

Typedef TIdentityServiceV1Pckg

typedef TPckg < TIdentityServiceV1 > TIdentityServiceV1Pckg

A typedef'd packaged CTelephony::TIdentityServiceV1 for passing through a generic API method.

Typedef TIndicatorV1Pckg

typedef TPckg < TIndicatorV1 > TIndicatorV1Pckg

A typedef'd packaged CTelephony::TIndicatorV1 for passing through a generic API method.

Typedef TNetworkInfoV1Pckg

typedef TPckg < TNetworkInfoV1 > TNetworkInfoV1Pckg

A typedef'd packaged CTelephony::TNetworkInfoV1 for passing through a generic API method.

Typedef TNetworkInfoV2Pckg

typedef TPckg < TNetworkInfoV2 > TNetworkInfoV2Pckg

A typedef'd packaged CTelephony::TNetworkInfoV2 for passing through a generic API method.

Typedef TNetworkNameV1Pckg

typedef TPckg < TNetworkNameV1 > TNetworkNameV1Pckg

A typedef'd packaged CTelephony::TNetworkNameV1 for passing through a generic API method.

Typedef TNetworkNameV2Pckg

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 TNetworkRegistrationV1Pckg

typedef TPckg < TNetworkRegistrationV1 > TNetworkRegistrationV1Pckg

A typedef'd packaged CTelephony::TNetworkRegistrationV1 for passing through a generic API method.

Typedef TOperatorNameV1Pckg

typedef TPckg < TOperatorNameV1 > TOperatorNameV1Pckg

A typedef'd packaged CTelephony::TOperatorNameV1 for passing through a generic API method.

Typedef TPhoneIdV1Pckg

typedef TPckg < TPhoneIdV1 > TPhoneIdV1Pckg

A typedef'd packaged CTelephony::TPhoneIdV1 for passing through a generic API method

Typedef TRemotePartyInfoV1Pckg

typedef TPckg < TRemotePartyInfoV1 > TRemotePartyInfoV1Pckg

A typedef'd packaged CTelephony::TRemotePartyInfoV1 for passing through a generic API method.

Typedef TSignalStrengthV1Pckg

typedef TPckg < TSignalStrengthV1 > TSignalStrengthV1Pckg

A typedef'd packaged CTelephony::TSignalStrengthV1 for passing through a generic API method.

Typedef TSubscriberIdV1Pckg

typedef TPckg < TSubscriberIdV1 > TSubscriberIdV1Pckg

A typedef'd packaged CTelephony::TSubscriberIdV1 for passing through a generic API method.

Typedef TTelNumber

typedef TBuf < KMaxTelNumberSize > TTelNumber

A typedef to hold the telephone number.

Member Data Documentation

CTelephonyFunctions * iTelephonyFunctions

CTelephonyFunctions * iTelephonyFunctions [private]