Collapse all Symbian^3 Application Developer Library

RMmCustomAPI Class Reference

class RMmCustomAPI : public RTelSubSessionBase

RMmCustomAPI contains multimode API's vendor specific functionality. RMmCustomAPI is a subsession extension i.e. it derives from RtelSubSessionBase class.

Notice that Custom TSY is able to handle only one instance of each Custom API Set-method call at a time. Overlapping Set-method calls occurs if same Set-method is called from an other instance of RMmCustomAPI object. Through one RMmCustomAPI object overlapping calls are not allowed

trying this will panic Etel Server. For each overlapping request to the client is returned error code KErrServerBusy either as a return value in case of synchronous call or in a variable of type TRequestStatus in case of an asynchronous call. This rule applies also in a situation where previous identical request has been cancelled by client but the triggered operation on DOS side has not been completed yet.

On the other hand Custom TSY is able to handle several instances of each Get-method call at a time. Again overlapping Get-method call can be activated only from an other instance of RMmCustomAPI object.

Consider carefully consequences and implications of request cancellations. If a request has triggered an operation on DOS side, the subsequent calcellation of the request will not undo the operation on DOS side. It is the responsibility of the Custom API's client to undo the operation if necessary. Cancel request completes only when awaited DOS side response arrives. Then if it is an OK-response, the request is completed normally with error code KErrNone. . Or if the response is a FAILURE, the request is completed with error code KErrCancel.

APDU functionality: Etel Server and Custom TSY are able to handle multiple SendAPDUReq calls simultaneously. However each RMmCustoAPI instance can have only one request active at a time.

Packet data related functionality: Custom TSY implements functionality that is not supported by the packetAPI.

Call realted functionality: Custom TSY implements functionality that is not supported by the MM ETEL API.

Inherits from

RMmCustomAPI
- RTelSubSessionBase
  - RSubSessionBase

Nested Classes and Structures

Public Member Functions
	RMmCustomAPI ()
IMPORT_C TInt	ActivateSimLock (const TSimLockPassword &, const TLockNumber )
IMPORT_C void	ActivateSimLock ( TRequestStatus &, const TSimLockPassword &, const TLockNumber )
IMPORT_C TInt	CallOrigin ( TName &, TCallOrigin &)
IMPORT_C TInt	CancelUssdSession ()
IMPORT_C void	CancelUssdSession ( TRequestStatus &)
IMPORT_C TInt	CheckAlsPpSupport ( TAlsSupport &)
IMPORT_C void	CheckAlsPpSupport ( TRequestStatus &, TAlsSupport &)
IMPORT_C TInt	CheckEmergencyNumber ( TEmerNumberCheckMode &, TBool &)
IMPORT_C void	CheckEmergencyNumber ( TRequestStatus &, TEmerNumberCheckMode &, TBool &)
IMPORT_C TInt	CheckSecurityCode (const TSecurityCodeType )
IMPORT_C void	CheckSecurityCode ( TRequestStatus &, const TSecurityCodeType )
IMPORT_C TInt	CheckTwoDigitDialSupport ( TTwoDigitDialSupport &)
IMPORT_C void	CheckTwoDigitDialSupport ( TRequestStatus &, TTwoDigitDialSupport &)
IMPORT_C void	ClearCallBlackList ( TRequestStatus &)
IMPORT_C TInt	ClearCallBlackList ()
IMPORT_C void	Close ()
IMPORT_C TInt	DeActivateSimLock (const TSimLockPassword &, const TLockNumber )
IMPORT_C void	DeActivateSimLock ( TRequestStatus &, const TSimLockPassword &, const TLockNumber )
IMPORT_C TInt	DeleteSimCbTopic (const TUint &)
IMPORT_C void	DeleteSimCbTopic ( TRequestStatus &, const TUint &)
IMPORT_C void	DisablePhoneLock ( TRequestStatus &, RMobilePhone::TMobilePassword &)
IMPORT_C void	Get3GPBInfo ( TRequestStatus &, T3GPBInfo &)
IMPORT_C void	GetATR ( TRequestStatus &, TDes8 &)
IMPORT_C void	GetActivePin ( RMobilePhone::TMobilePhoneSecurityCode &)
IMPORT_C TInt	GetAirTimeDuration ( TTimeIntervalSeconds &)
IMPORT_C TInt	GetAlsBlocked ( TGetAlsBlockStatus &)
IMPORT_C void	GetAlsBlocked ( TRequestStatus &, TGetAlsBlockStatus &)
IMPORT_C void	GetCellInfo ( TRequestStatus &, TDes8 &)
IMPORT_C TInt	GetCipheringInfo ( TCipheringInfo &)
IMPORT_C void	GetCipheringInfo ( TRequestStatus &, TCipheringInfo &)
IMPORT_C TInt	GetCurrentSystemNetworkModes ( TUint32 &)
IMPORT_C void	GetCurrentSystemNetworkModes ( TRequestStatus &, TUint32 &)
IMPORT_C TInt	GetDiagnosticInfo ( TName &)
IMPORT_C void	GetEGprsInfo ( TRequestStatus &, TDes8 &)
IMPORT_C void	GetIccCallForwardingIndicatorStatus ( TRequestStatus &, TDes8 &)
IMPORT_C TInt	GetLifeTime ( TDes8 &)
IMPORT_C void	GetLifeTime ( TRequestStatus &, TDes8 &)
IMPORT_C TInt	GetNetworkProviderName ( TDes &)
IMPORT_C void	GetNetworkProviderName ( TRequestStatus &, TDes &)
IMPORT_C TInt	GetNextSimCbTopic ( TSimCbTopic &)
IMPORT_C void	GetNextSimCbTopic ( TRequestStatus &, TSimCbTopic &)
IMPORT_C void	GetOperatorName ( TRequestStatus &, TOperatorNameInfo &)
IMPORT_C void	GetPndCacheStatus ( TRequestStatus &, RMmCustomAPI::TPndCacheStatus &, const TName &)
IMPORT_C void	GetProgrammableOperatorLogo ( TRequestStatus &, TOperatorId &, TOperatorLogo &)
IMPORT_C TInt	GetRemoteAlertingToneStatus ( TRemoteAlertingToneStatus &)
IMPORT_C void	GetSimCardReaderStatus ( TRequestStatus &, TSimCardReaderStatus &)
IMPORT_C TInt	GetSystemNetworkBand ( TBandSelection &, TNetworkModeCaps &)
IMPORT_C void	GetSystemNetworkBand ( TRequestStatus &, TBandSelection &, TNetworkModeCaps &)
IMPORT_C TInt	GetSystemNetworkModes ( TUint32 &)
IMPORT_C void	GetSystemNetworkModes ( TRequestStatus &, TUint32 &)
IMPORT_C void	GetUSIMServiceSupport ( TRequestStatus &, TAppSupport &)
IMPORT_C void	GetWlanSimAuthenticationData ( TRequestStatus &, TDes8 &)
IMPORT_C TInt	IsBlocked ( TSecurityCodeType &, TBool &)
IMPORT_C void	NetWakeup ( TRequestStatus &)
IMPORT_C void	NotifyAlsBlockedChanged ( TRequestStatus &, TGetAlsBlockStatus &)
IMPORT_C void	NotifyCellInfoChange ( TRequestStatus &, TDes8 &)
IMPORT_C void	NotifyCipheringInfoChange ( TRequestStatus &, TCipheringInfo &)
IMPORT_C void	NotifyDtmfEvent ( TRequestStatus &, TDtmfInfo &)
IMPORT_C void	NotifyEGprsInfoChange ( TRequestStatus &, TDes8 &)
IMPORT_C void	NotifyHSxPAStatus ( TRequestStatus &, THSxPAStatus &)
IMPORT_C void	NotifyIccCallForwardingStatusChange ( TRequestStatus &, TDes8 &)
IMPORT_C void	NotifyNSPSStatus ( TRequestStatus &, TNspsStatus &)
IMPORT_C void	NotifyNetworkConnectionFailure ( TRequestStatus &)
IMPORT_C void	NotifyPndCacheReady ( TRequestStatus &, TName &)
IMPORT_C void	NotifyProgrammableOperatorLogoChange ( TRequestStatus &, TOperatorId &)
IMPORT_C void	NotifyRauEvent ( TRequestStatus &, TRauEventStatus &)
IMPORT_C void	NotifyRemoteAlertingToneStatusChange ( TRequestStatus &, TRemoteAlertingToneStatus &)
IMPORT_C void	NotifySimCardStatus ( TRequestStatus &, TSIMCardStatus &)
IMPORT_C void	NotifySsNetworkEvent ( TRequestStatus &, TSsTypeAndMode &, TSsInfo &)
IMPORT_C TInt	Open ( RMobilePhone &)
IMPORT_C void	PowerSimOff ( TRequestStatus &)
IMPORT_C void	PowerSimOn ( TRequestStatus &)
IMPORT_C void	ReadHSxPAStatus ( TRequestStatus &, THSxPAStatus &)
IMPORT_C void	ReadSimFile ( TRequestStatus &, TDes8 &, TDes8 &)
IMPORT_C TInt	ReadViagHomeZoneCache ( TViagCacheRecordId &, TViagCacheRecordContent &)
IMPORT_C void	ReadViagHomeZoneCache ( TRequestStatus &, TViagCacheRecordId &, TViagCacheRecordContent &)
IMPORT_C TInt	ReadViagHomeZoneParams ( TViagParams &, TViagElements &)
IMPORT_C void	ReadViagHomeZoneParams ( TRequestStatus &, TViagParams &, TViagElements &)
IMPORT_C void	ReleaseFile ( TRequestStatus &, const TDesC &)
IMPORT_C void	ResetNetServer ()
IMPORT_C void	ResetNetServer ( TRequestStatus &)
IMPORT_C void	RestartFile ( TRequestStatus &, const TDesC &)
IMPORT_C void	SatRefreshCompleteNotification ( TRequestStatus &)
IMPORT_C TInt	SendAPDUReq ( TApdu &)
IMPORT_C void	SendAPDUReq ( TRequestStatus &, TApdu &)
IMPORT_C void	SendAPDUReq ( TRequestStatus &, TApduParameters &)
IMPORT_C TInt	SetAlsBlocked (const TSetAlsBlock )
IMPORT_C void	SetAlsBlocked ( TRequestStatus &, const TSetAlsBlock )
IMPORT_C void	SetAlwaysOn ( TRequestStatus &, TSetAlwaysOnMode &)
IMPORT_C void	SetDriveMode ( TRequestStatus &, const TSetDriveMode )
IMPORT_C void	SetSimMessageStatusRead ( TTime &, TInt &)
IMPORT_C TInt	SetSystemNetworkBand (const TBandSelection , const TNetworkModeCaps )
IMPORT_C void	SetSystemNetworkBand ( TRequestStatus &, const TBandSelection , const TNetworkModeCaps )
IMPORT_C TInt	SetSystemNetworkMode (const TNetworkModeCaps )
IMPORT_C void	SetSystemNetworkMode ( TRequestStatus &, const TNetworkModeCaps )
IMPORT_C void	SimWarmReset ( TRequestStatus &)
IMPORT_C void	SsAdditionalInfoNotification ( TRequestStatus &, TSsAdditionalInfo &)
IMPORT_C void	SsRequestCompleteNotification ( TRequestStatus &, TInt &)
IMPORT_C TInt	StartSimCbTopicBrowsing ()
IMPORT_C TInt	TerminateCall ( TName &)
IMPORT_C void	TerminateCall ( TRequestStatus &, TName &)
IMPORT_C void	WriteHSxPAStatus ( TRequestStatus &, THSxPAStatus &)
IMPORT_C TInt	WriteViagHomeZoneCache (const TViagCacheRecordId &, const TViagCacheRecordContent &)
IMPORT_C void	WriteViagHomeZoneCache ( TRequestStatus &, const TViagCacheRecordId &, const TViagCacheRecordContent &)
IMPORT_C TInt	WriteViagHomeZoneUHZIUESettings ( TViagUHZIUESettings &)
IMPORT_C void	WriteViagHomeZoneUHZIUESettings ( TRequestStatus &, TViagUHZIUESettings &)

Protected Member Functions
IMPORT_C void	ConstructL ()
IMPORT_C void	Destruct ()

Private Member Functions
	RMmCustomAPI (const RMmCustomAPI &)

Inherited Functions
	RSubSessionBase::CloseSubSession(TInt)
	RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::RSubSessionBase()
	RSubSessionBase::Send(TInt)const
	RSubSessionBase::Send(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt)const
	RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSubSessionBase::Session()const
	RSubSessionBase::SubSessionHandle()const
	RTelSubSessionBase::Blank(const TInt,TReqPriorityType)const
	RTelSubSessionBase::Blank(const TInt,TRequestStatus &,TReqPriorityType)const
	RTelSubSessionBase::CancelAsyncRequest(TInt)const
	RTelSubSessionBase::CancelReq(const TInt,const TInt)const
	RTelSubSessionBase::CancelSubSession()const
	RTelSubSessionBase::Get(const TInt,TDes16 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TDes8 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TDes8 &,TDes8 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TDes8 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TRequestStatus &,TDes16 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TRequestStatus &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TRequestStatus &,TDes8 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TRequestStatus &,TDes8 &,TDes8 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TRequestStatus &,TDes8 &,TReqPriorityType)const
	RTelSubSessionBase::RTelSubSessionBase()
	RTelSubSessionBase::ResetSessionHandle()
	RTelSubSessionBase::SessionHandle()const
	RTelSubSessionBase::Set(const TInt,TRequestStatus &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,TRequestStatus &,const TDesC16 &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,TRequestStatus &,const TDesC8 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,TRequestStatus &,const TDesC8 &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,TRequestStatus &,const TDesC8 &,const TDesC8 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const RFile &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const TDesC16 &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const TDesC8 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const TDesC8 &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const TDesC8 &,const TDesC8 &,TReqPriorityType)const
	RTelSubSessionBase::SetAndGet(const TInt,TRequestStatus &,TDes8 &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::SetAndGet(const TInt,TRequestStatus &,const TDesC16 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::SetAndGet(const TInt,TRequestStatus &,const TDesC8 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::SetAndGet(const TInt,TRequestStatus &,const TDesC8 &,TDes8 &,TReqPriorityType)const
	RTelSubSessionBase::SetSessionHandle(RSessionBase &)
	RTelSubSessionBase::SubSessionHandle()

Public Member Enumerations
enum	anonymous { KRemoteAddressSize = 64 }
enum	TActiveFlag { ENotActive , EHomeZone , ECityZone }
enum	TAlsSupport { EAlsSupportOn , EAlsSupportOff }
enum	TBandSelection { ENetworkBandUmts850 = 0x01, ENetworkBandUmts2100 = 0x02, ENetworkBandAny = 0x03 }
enum	TCallOrigin { EUnknown , EETelCall , EOutsider }
enum	TCheckMode { EEmerNumberCheckNormal , EEmerNumberCheckAdvanced }
enum	TDtmfEvent { EDtmfStart , EDtmfStop , EDtmfAbort }
enum	TDtmfEventType { EDtmfManual , EDtmfSequence }
enum	TGetAlsBlockStatus { EBlockStatusNotSupported , EBlockStatusActive , EBlockStatusInactive , EBlockStatusUnknown }
enum	TGprsInformationType { EGprs = 0, EEdgeGprs = 1 }
enum	THSxPAStatus { EHSxPADisabled , EHSxPAEnabled }
enum	TLockNumber { EOperator = 1, EGid1 , EGid2 , EImsi , EOperator_Gid1 , EOperator_Gid2 , EGlobalUnlock }
enum	TMultimodeETelCustomV1Api { KETelCustomExtMultimodeV1 = 10000, KETelCustomExtCustomCallParamsV3 }
enum	TMultipleSubscriberProfileID { KProfileIdentityOne = 0x01, KProfileIdentityTwo = 0x02, KProfileIdentityThree = 0x03, KProfileIdentityFour = 0x04 }
enum	TNetworkModeCaps { KCapsNetworkModeUnknown = 0x00, KCapsNetworkModeGsm = 0x01, KCapsNetworkModeUmts = 0x02, KCapsNetworkModeDual = 0x04 }
enum	TNspsStatus { ENspsOn , ENspsOff }
enum	TOperatorNameType { EOperatorNameNitzFull , EOperatorNameNitzShort , EOperatorNameProgrammableUcs2 , EOperatorNameProgrammableLatin , EOperatorNameHardcodedUcs2 , EOperatorNameHardcodedLatin , EOperatorNameCountryMcn , EOperatorNameMccMnc , EOperatorNameFlexiblePlmn , EOperatorNameHighestPriority }
enum	TPndCacheStatus { ECacheNotReady , ECacheReady , ECacheNotUsed , ECacheFailed }
enum	TProgrammableOperatorLogoDepth { EBitPerPixel1 , EBitPerPixel2 , EBitPerPixel4 , EBitPerPixel8 }
enum	TRauEventStatus { ERauEventActive , ERauEventResumed }
enum	TRemoteAlertingToneStatus { EUiNoTone , EUiRbtTone , EUiStopTone }
enum	TSIMCardStatus { SimCardUnknowError = 0x00, SimCardResetPerformed , SimCardNotAccessible , SimCardRemoved , SimCardInserted , SimCardRecovered }
enum	TSecurityCodeType { ESecurityCodePin1 , ESecurityCodePin2 , ESecurityUniversalPin , ESecurityCodePuk1 , ESecurityCodePuk2 , ESecurityCodePassPhrase }
enum	TSetAlsBlock { EDeactivateBlock , EActivateBlock }
enum	TSetAlwaysOnMode { EAlwaysModeHPLMN , EAlwaysModeVPLMN , EAlwaysModeBoth , EAlwaysModeNeither }
enum	TSetDriveMode { EDeactivateDriveMode , EActivateDriveMode }
enum	TSsChoice { ESsPresAllowed , ESsPresRestricted , ESsNumberNotAvailable , ESsPresRestrictedAddress , ESsChoiceUnknown }
enum	TSsEctState { ESsEctActive , ESsEctAlerting , ESsEctNotActive }
enum	TSsForwMode { ESsIncCallIsForw , ESsIncCallForwToC , ESsOutCallForwToC , EForwNotActive }
enum	TSsHoldMode { ESsHoldActive , ESsHoldResume , ESsHoldNotActive }
enum	TSsMode { ESsModeActive , ESsModeNotActive , ESsModeNotRegistered , ESsModeNotProvisioned , ESsModeNotAvailable , ESsModeUnknown }
enum	TSsStatus { KSsStatusGsmActive = 0x01, KSsStatusGsmRegistered = 0x02, KSsStatusGsmProvisioned = 0x04, KSsStatusGsmQuiescent = 0x08, KSsStatusReturnError = 0xFFFF, KSsStatusNetworkFailure = 0xFFFE }
enum	TSsType { ESsAllSs = 0, ESsAllForwardings = 2, ESsForwUncond = 21, ESsForwBusy = 67, ESsForwNoReply = 61, ESsForwNoReach = 62, ESsAllBarrings = 330, ESsBarrAllOut = 33, ESsBarrOutInter = 331, ESsBarrOutInterExcHome = 332, ESsBarrAllIn = 35, ESsBarrAllInRoam = 351, ESsOutgoingBarrServ = 333, ESsIncomingBarrServ = 353, ESsCallWaiting = 43, ESsClip = 30, ESsClir = 31, ESsColp = 76, ESsColr = 77, ESsCnap = 300, ESsAllCondForwardings = 4, ESsRegPassword = 3 }
enum	TTwoDigitDialSupport { ETwoDigitDialSupportOn , ETwoDigitDialSupportOff }
enum	TViagDataType { KViagParamNbrSize = 15, KViagElemNameSize = 13, KViagElementCount = 4 }

Inherited Enumerations
	RTelSubSessionBase:TReqPriorityType

Public Member Type Definitions
typedef	TPckg < TSimAuthenticationEapAka > TAkaDataPckg
typedef	TBuf8 < KMaxAuthenticationParameterLength > TAuthenticationParameter
typedef	TPckg < TCFIndicators > TCFIndicatorsPckg
typedef	TPckg < TCustomCallParams > TCustomCallParamsPckg
typedef	TPckg < TSimAuthenticationGbaBootstrap > TGbaBootstrapDataPckg
typedef	TPckg < TSimAuthenticationGbaBootstrapUpdate > TGbaBootstrapUpdateDataPckg
typedef	TPckg < TSimAuthenticationGbaNafDerivation > TGbaNafDerivationDataPckg
typedef	TPckg < TGprsInformation > TGprsInformationPckg
typedef	TBuf8 < KMaxKeyDomainIdLength > TKeyDomainId
typedef	TBuf8 < KMaxKeyGroupIdLength > TKeyGroupId
typedef	TPckg < TLifeTimeData > TLifeTimeDataPckg
typedef	TPckg < TSimAuthenticationMgvMskDeletion > TMgvMskDeletionDataPckg
typedef	TPckg < TSimAuthenticationMgvMtkGeneration > TMgvMtkGenerationDataPckg
typedef	TBuf8 < KMaxMikeyLength > TMikey
typedef	TPckg < TMmCellInfo > TMmCellInfoPckg
typedef	TBuf < RMobilePhone::KMaxMobileTelNumberSize > TMobileTelNumber
typedef	TBuf8 < KMaxParametersLength > TParameter
typedef	TBuf8 < KMaxKeyDomainIdLength > TParentalControl
typedef	TBuf8 < KMaxKeyGroupIdLength > TParentalRating
typedef	TPckg < TSimAuthenticationMgvMskUpdate > TSimAuthenticationMgvMskUpdatePckg
typedef	TPckg < TSimAuthenticationEapSim > TSimDataPckg
typedef	TPckg < TSimFileInfo > TSimFileInfoPckg
typedef	TBuf8 < KSimFilePathLength > TSimFilePath
typedef	TBuf < KSimLockMaxPasswordSize > TSimLockPassword
typedef	CArrayFixFlat < TViagElement > TViagElements

Private Attributes
CMmCustomPtrHolder *	iCustomPtrHolder

Inherited Attributes
	RTelSubSessionBase::iPtrHolder

Constructor & Destructor Documentation

RMmCustomAPI()

IMPORT_C

RMmCustomAPI

(

)

Default constructor

RMmCustomAPI(const RMmCustomAPI &)

RMmCustomAPI

(

const RMmCustomAPI &

aCustomAPI

)

[private]

Copy constructor

Parameters

const RMmCustomAPI & aCustomAPI

Custom API handle

Member Functions Documentation

ActivateSimLock(const TSimLockPassword &, const TLockNumber)

IMPORT_C TInt	ActivateSimLock	(	const TSimLockPassword &	aPassWord,
			const TLockNumber	aNumber
		)	const

Activate SIMLock synchronously

Parameters

const TSimLockPassword & aPassWord	Lock specific password used to activate the SIMLock
const TLockNumber aNumber	Number of lock to be activated

ActivateSimLock(TRequestStatus &, const TSimLockPassword &, const TLockNumber)

IMPORT_C void	ActivateSimLock	(	TRequestStatus &	aStatus,
			const TSimLockPassword &	aPassWord,
			const TLockNumber	aNumber
		)	const

Activate SIMLock asynchronously

Parameters

TRequestStatus & aStatus	Request status
const TSimLockPassword & aPassWord	Lock specific password used to activate the SIMLock
const TLockNumber aNumber	Number of lock to be activated

CallOrigin(TName &, TCallOrigin &)

IMPORT_C TInt	CallOrigin	(	TName &	aCallName,
			TCallOrigin &	aOrigin
		)	const

Returns the origin of the call, defined by aCallName parameter

Parameters

TName & aCallName	call name
TCallOrigin & aOrigin	call origin

CancelUssdSession()

IMPORT_C TInt

CancelUssdSession

(

)

const

Cancels active ussd session synchronously

CancelUssdSession(TRequestStatus &)

IMPORT_C void

CancelUssdSession

(

TRequestStatus &

aStatus

)

Cancels active ussd session asynchronously

Parameters

TRequestStatus & aStatus

Request status

CheckAlsPpSupport(TAlsSupport &)

IMPORT_C TInt

CheckAlsPpSupport

(

TAlsSupport &

aSupport

)

const

Checks the status of the ALS in the product profile synchronously

Parameters

TAlsSupport & aSupport

Als support Status

CheckAlsPpSupport(TRequestStatus &, TAlsSupport &)

IMPORT_C void	CheckAlsPpSupport	(	TRequestStatus &	aStatus,
			TAlsSupport &	aSupport
		)

Checks the status of the ALS in the product profile asynchronously

Parameters

TRequestStatus & aStatus	Request status
TAlsSupport & aSupport	Als support Status

CheckEmergencyNumber(TEmerNumberCheckMode &, TBool &)

IMPORT_C TInt	CheckEmergencyNumber	(	TEmerNumberCheckMode &	aNumMode,
			TBool &	aResult
		)	const

Checks the given number against emergency number list sychronously

Parameters

TEmerNumberCheckMode & aNumMode	Number and check mode
TBool & aResult	Result of query

CheckEmergencyNumber(TRequestStatus &, TEmerNumberCheckMode &, TBool &)

IMPORT_C void	CheckEmergencyNumber	(	TRequestStatus &	aStatus,
			TEmerNumberCheckMode &	aNumMode,
			TBool &	aResult
		)

Checks the given number against emergency number list asychronously

Parameters

TRequestStatus & aStatus	Request status
TEmerNumberCheckMode & aNumMode	Number and check mode
TBool & aResult	Result of query

CheckSecurityCode(const TSecurityCodeType)

IMPORT_C TInt

CheckSecurityCode

(

const TSecurityCodeType

aCode

)

This method activates syncronously the security code request and triggers the security server to prompt PIN-code from client.

Parameters

const TSecurityCodeType aCode

Security code type

CheckSecurityCode(TRequestStatus &, const TSecurityCodeType)

IMPORT_C void	CheckSecurityCode	(	TRequestStatus &	aStatus,
			const TSecurityCodeType	aCode
		)

This method activates asyncronously the security code request and triggers the security server to prompt PIN-code from client.

Parameters

TRequestStatus & aStatus	Request status
const TSecurityCodeType aCode	Security code type

CheckTwoDigitDialSupport(TTwoDigitDialSupport &)

IMPORT_C TInt

CheckTwoDigitDialSupport

(

TTwoDigitDialSupport &

aSupport

)

const

Checks two digit dial support synchronously

Parameters

TTwoDigitDialSupport & aSupport

two digit dial support status

CheckTwoDigitDialSupport(TRequestStatus &, TTwoDigitDialSupport &)

IMPORT_C void	CheckTwoDigitDialSupport	(	TRequestStatus &	aStatus,
			TTwoDigitDialSupport &	aSupport
		)

Checks two digit dial support asynchronously

Parameters

TRequestStatus & aStatus	Request status
TTwoDigitDialSupport & aSupport	two digit dial support status

ClearCallBlackList(TRequestStatus &)

IMPORT_C void

ClearCallBlackList

(

TRequestStatus &

aStatus

)

Clears Call Blacklist asynchronously

Parameters

TRequestStatus & aStatus

Request status

ClearCallBlackList()

IMPORT_C TInt

ClearCallBlackList

(

)

const

Clears Call Blacklist synchronously

Close()

IMPORT_C void

(

)

Closes the subsession.

ConstructL()

IMPORT_C void

ConstructL

(

)

[protected]

2nd phase constructor.

DeActivateSimLock(const TSimLockPassword &, const TLockNumber)

IMPORT_C TInt	DeActivateSimLock	(	const TSimLockPassword &	aPassWord,
			const TLockNumber	aNumber
		)	const

Deactivate SIMLock synchronously

Parameters

const TSimLockPassword & aPassWord	Lock specific password used to Deactivate the SIMLock
const TLockNumber aNumber	Number of lock to be activated

DeActivateSimLock(TRequestStatus &, const TSimLockPassword &, const TLockNumber)

IMPORT_C void	DeActivateSimLock	(	TRequestStatus &	aStatus,
			const TSimLockPassword &	aPassWord,
			const TLockNumber	aNumber
		)	const

Deactivate SIMLock asynchronously

Parameters

TRequestStatus & aStatus	Request status
const TSimLockPassword & aPassWord	Lock specific password used to Deactivate the SIMLock
const TLockNumber aNumber	Number of lock to be activated

DeleteSimCbTopic(const TUint &)

IMPORT_C TInt

DeleteSimCbTopic

(

const TUint &

aSimCbTopicNumber

)

Delete SIM CB Topic synchronously

Parameters

const TUint & aSimCbTopicNumber

topic to be deleted

DeleteSimCbTopic(TRequestStatus &, const TUint &)

IMPORT_C void	DeleteSimCbTopic	(	TRequestStatus &	aStatus,
			const TUint &	aSimCbTopicNumber
		)

Delete SIM CB Topic asynchronously. This asynchronous request can not be cancelled.

Parameters

TRequestStatus & aStatus	request status
const TUint & aSimCbTopicNumber

Destruct()

IMPORT_C void

Destruct

(

)

[protected]

Destructor

DisablePhoneLock(TRequestStatus &, RMobilePhone::TMobilePassword &)

IMPORT_C void	DisablePhoneLock	(	TRequestStatus &	aStatus,
			RMobilePhone::TMobilePassword &	aVerifyCode
		)	const

Disables phone lock

Parameters

TRequestStatus & aStatus	Request status
RMobilePhone::TMobilePassword & aVerifyCode	Password for verification

Get3GPBInfo(TRequestStatus &, T3GPBInfo &)

IMPORT_C void	Get3GPBInfo	(	TRequestStatus &	aStatus,
			T3GPBInfo &	aInfo
		)	const

Gets phonebook 3G information

Parameters

TRequestStatus & aStatus	Request status
T3GPBInfo & aInfo	reference to class containing phonebook 3G information

GetATR(TRequestStatus &, TDes8 &)

IMPORT_C void	GetATR	(	TRequestStatus &	aStatus,
			TDes8 &	aATR
		)

Get Answer To Reset

Parameters

TRequestStatus & aStatus	Request status
TDes8 & aATR	reference containing Answer To Reset bytes from ICC

GetActivePin(RMobilePhone::TMobilePhoneSecurityCode &)

IMPORT_C void

GetActivePin

(

RMobilePhone::TMobilePhoneSecurityCode &

aActivePin

)

This function retrieves syncronously the currently active PIN code

Parameters

RMobilePhone::TMobilePhoneSecurityCode & aActivePin

Currently active PIN

GetAirTimeDuration(TTimeIntervalSeconds &)

IMPORT_C TInt

GetAirTimeDuration

(

TTimeIntervalSeconds &

aTime

)

const

Get the air time use duration synchronously

Parameters

TTimeIntervalSeconds & aTime

air time duration in seconds.

GetAlsBlocked(TGetAlsBlockStatus &)

IMPORT_C TInt

GetAlsBlocked

(

TGetAlsBlockStatus &

aBlockStatus

)

const

Gets the alternating line service block status

Parameters

TGetAlsBlockStatus & aBlockStatus

als block status

GetAlsBlocked(TRequestStatus &, TGetAlsBlockStatus &)

IMPORT_C void	GetAlsBlocked	(	TRequestStatus &	aStatus,
			TGetAlsBlockStatus &	aBlockStatus
		)

Gets the alternating line service block status

Parameters

TRequestStatus & aStatus	Request status
TGetAlsBlockStatus & aBlockStatus	als block status

GetCellInfo(TRequestStatus &, TDes8 &)

IMPORT_C void	GetCellInfo	(	TRequestStatus &	aStatus,
			TDes8 &	aCellInfo
		)	const

Get GSM/WCDMA cell(s) info

Parameters

TRequestStatus & aStatus	Request status
TDes8 & aCellInfo

GetCipheringInfo(TCipheringInfo &)

IMPORT_C TInt

GetCipheringInfo

(

TCipheringInfo &

aInfo

)

Gets the ciphering information synchronously

Parameters

TCipheringInfo & aInfo

GetCipheringInfo(TRequestStatus &, TCipheringInfo &)

IMPORT_C void	GetCipheringInfo	(	TRequestStatus &	aStatus,
			TCipheringInfo &	aInfo
		)

Gets the ciphering info asynchronously

Parameters

TRequestStatus & aStatus	Request status
TCipheringInfo & aInfo	Ciphering information

GetCurrentSystemNetworkModes(TUint32 &)

IMPORT_C TInt

GetCurrentSystemNetworkModes

(

TUint32 &

aCurrentNetworkModes

)

const

This method gets current network system mode synchronously.

Parameters

TUint32 & aCurrentNetworkModes

Current networkmodes

GetCurrentSystemNetworkModes(TRequestStatus &, TUint32 &)

IMPORT_C void	GetCurrentSystemNetworkModes	(	TRequestStatus &	aStatus,
			TUint32 &	aCurrentNetworkModes
		)	const

This method gets current system mode asynchronously.

Parameters

TRequestStatus & aStatus	Request status
TUint32 & aCurrentNetworkModes	Current networkmodes

GetDiagnosticInfo(TName &)

IMPORT_C TInt

GetDiagnosticInfo

(

TName &

aCallName

)

const

Return diagnostics info

Parameters

TName & aCallName

call name

GetEGprsInfo(TRequestStatus &, TDes8 &)

IMPORT_C void	GetEGprsInfo	(	TRequestStatus &	aStatus,
			TDes8 &	aGprsInfo
		)	const

Gets EGPRS information

Parameters

TRequestStatus & aStatus	Request status
TDes8 & aGprsInfo	is a reference to a TGprsInformation class packaged inside a TPckg<> class.

GetIccCallForwardingIndicatorStatus(TRequestStatus &, TDes8 &)

IMPORT_C void	GetIccCallForwardingIndicatorStatus	(	TRequestStatus &	aReqStatus,
			TDes8 &	aCFIndicators
		)	const

Get ICC call forwarding status

Parameters

TRequestStatus & aReqStatus	Request status
TDes8 & aCFIndicators	refrence to class CFIndicators

GetLifeTime(TDes8 &)

IMPORT_C TInt

GetLifeTime

(

TDes8 &

aLifeTimeInfo

)

const

Gets the life time synchronously

Parameters

TDes8 & aLifeTimeInfo

reference to class containing Life time information

GetLifeTime(TRequestStatus &, TDes8 &)

IMPORT_C void	GetLifeTime	(	TRequestStatus &	aStatus,
			TDes8 &	aLifeTimeInfo
		)	const

Gets the life time asynchronously

Parameters

TRequestStatus & aStatus	Request status
TDes8 & aLifeTimeInfo	reference to class containing Life time information

GetNetworkProviderName(TDes &)

IMPORT_C TInt

GetNetworkProviderName

(

TDes &

aNetworkProviderName

)

const

Gets network provider name synchronously

Parameters

TDes & aNetworkProviderName

Network provider name

GetNetworkProviderName(TRequestStatus &, TDes &)

IMPORT_C void	GetNetworkProviderName	(	TRequestStatus &	aStatus,
			TDes &	aNetworkProviderName
		)

Gets network provider name asynchronously

Parameters

TRequestStatus & aStatus	Request status
TDes & aNetworkProviderName	Network provider name

GetNextSimCbTopic(TSimCbTopic &)

IMPORT_C TInt

GetNextSimCbTopic

(

TSimCbTopic &

aSimCbTopic

)

Get next SIM CB Topic synchronously

Parameters

TSimCbTopic & aSimCbTopic

requested topic

GetNextSimCbTopic(TRequestStatus &, TSimCbTopic &)

IMPORT_C void	GetNextSimCbTopic	(	TRequestStatus &	aStatus,
			TSimCbTopic &	aSimCbTopic
		)

Get next SIM CB Topic asynchronously

Parameters

TRequestStatus & aStatus	request status
TSimCbTopic & aSimCbTopic	requested topic

GetOperatorName(TRequestStatus &, TOperatorNameInfo &)

IMPORT_C void	GetOperatorName	(	TRequestStatus &	aStatus,
			TOperatorNameInfo &	aOperatorNameInfo
		)

Gets the operator name of the current network

Parameters

TRequestStatus & aStatus	Request status
TOperatorNameInfo & aOperatorNameInfo	Operator name info

GetPndCacheStatus(TRequestStatus &, RMmCustomAPI::TPndCacheStatus &, const TName &)

IMPORT_C void	GetPndCacheStatus	(	TRequestStatus &	aStatus,
			RMmCustomAPI::TPndCacheStatus &	aPndStatus,
			const TName &	aPndName
		)	const

Gets current cache status

Parameters

TRequestStatus & aStatus	Request status
RMmCustomAPI::TPndCacheStatus & aPndStatus	cache status
const TName & aPndName	phonebook name

GetProgrammableOperatorLogo(TRequestStatus &, TOperatorId &, TOperatorLogo &)

IMPORT_C void	GetProgrammableOperatorLogo	(	TRequestStatus &	aStatus,
			TOperatorId &	aOperatorId,
			TOperatorLogo &	aLogo
		)

Gets the programmable operator logo of the current network

This API is no longer supported!

Parameters

TRequestStatus & aStatus	Request status
TOperatorId & aOperatorId	operator Id
TOperatorLogo & aLogo	operator logo

GetRemoteAlertingToneStatus(TRemoteAlertingToneStatus &)

IMPORT_C TInt

GetRemoteAlertingToneStatus

(

TRemoteAlertingToneStatus &

aToneStatus

)

const

Reads the remote alerting tone status

Parameters

TRemoteAlertingToneStatus & aToneStatus

alerting tone status

GetSimCardReaderStatus(TRequestStatus &, TSimCardReaderStatus &)

IMPORT_C void	GetSimCardReaderStatus	(	TRequestStatus &	aStatus,
			TSimCardReaderStatus &	aCardReaderStatus
		)

Get Card Reader Status

Parameters

TRequestStatus & aStatus	Request status
TSimCardReaderStatus & aCardReaderStatus

GetSystemNetworkBand(TBandSelection &, TNetworkModeCaps &)

IMPORT_C TInt	GetSystemNetworkBand	(	TBandSelection &	aSupportedNetworkBand,
			TNetworkModeCaps &	aNetworkMode
		)	const

This method reads network system band synchronously.

Parameters

TBandSelection & aSupportedNetworkBand	supported networkband
TNetworkModeCaps & aNetworkMode

GetSystemNetworkBand(TRequestStatus &, TBandSelection &, TNetworkModeCaps &)

IMPORT_C void	GetSystemNetworkBand	(	TRequestStatus &	aStatus,
			TBandSelection &	aSupportedNetworkBand,
			TNetworkModeCaps &	aNetworkMode
		)	const

This method reads network system band asynchronously.

Parameters

TRequestStatus & aStatus	Request status
TBandSelection & aSupportedNetworkBand
TNetworkModeCaps & aNetworkMode

GetSystemNetworkModes(TUint32 &)

IMPORT_C TInt

GetSystemNetworkModes

(

TUint32 &

aSupportedNetworkModes

)

const

This method reads all network system modes synchronously.

Parameters

TUint32 & aSupportedNetworkModes

supported networkmodes

GetSystemNetworkModes(TRequestStatus &, TUint32 &)

IMPORT_C void	GetSystemNetworkModes	(	TRequestStatus &	aStatus,
			TUint32 &	aSupportedNetworkModes
		)	const

This method reads all network system modes asynchronously.

Parameters

TRequestStatus & aStatus	Request status
TUint32 & aSupportedNetworkModes	supported networkmodes

GetUSIMServiceSupport(TRequestStatus &, TAppSupport &)

IMPORT_C void	GetUSIMServiceSupport	(	TRequestStatus &	aStatus,
			TAppSupport &	aParams
		)	const

Get service table availability on USIM

Since: S60 v3.2

Parameters

TRequestStatus & aStatus	Request status
TAppSupport & aParams	aServiceNum. A service support in service table specified by the client

GetWlanSimAuthenticationData(TRequestStatus &, TDes8 &)

IMPORT_C void	GetWlanSimAuthenticationData	(	TRequestStatus &	aReqStatus,
			TDes8 &	aAuthenticationData
		)	const

Get WLAN SIM Authentication Data

Parameters

TRequestStatus & aReqStatus
TDes8 & aAuthenticationData	Authentication Data

IsBlocked(TSecurityCodeType &, TBool &)

IMPORT_C TInt	IsBlocked	(	TSecurityCodeType &	aType,
			TBool &	aIsBlocked
		)

This function retrieves syncronously the information if the security code is blocked or not.

Parameters

TSecurityCodeType & aType	Security code type
TBool & aIsBlocked	Code blocking status

NetWakeup(TRequestStatus &)

IMPORT_C void

NetWakeup

(

TRequestStatus &

aStatus

)

This function wake ups the net server from the NSPS state

Parameters

TRequestStatus & aStatus

Request status

NotifyAlsBlockedChanged(TRequestStatus &, TGetAlsBlockStatus &)

IMPORT_C void	NotifyAlsBlockedChanged	(	TRequestStatus &	aStatus,
			TGetAlsBlockStatus &	aBlockStatus
		)

Notifies a client of changed Als blocked status

Parameters

TRequestStatus & aStatus	Request status
TGetAlsBlockStatus & aBlockStatus	ALS block status

NotifyCellInfoChange(TRequestStatus &, TDes8 &)

IMPORT_C void	NotifyCellInfoChange	(	TRequestStatus &	aStatus,
			TDes8 &	aCellInfo
		)	const

Notify Cell info change

Parameters

TRequestStatus & aStatus	Request status
TDes8 & aCellInfo

NotifyCipheringInfoChange(TRequestStatus &, TCipheringInfo &)

IMPORT_C void	NotifyCipheringInfoChange	(	TRequestStatus &	aStatus,
			TCipheringInfo &	aInfo
		)

This function notifies a client of ciphering info change

Parameters

TRequestStatus & aStatus	Request status
TCipheringInfo & aInfo	Ciphering information

NotifyDtmfEvent(TRequestStatus &, TDtmfInfo &)

IMPORT_C void	NotifyDtmfEvent	(	TRequestStatus &	aStatus,
			TDtmfInfo &	aInfo
		)

Notify a DTMF event

Parameters

TRequestStatus & aStatus	Request status
TDtmfInfo & aInfo	DTMF Info

NotifyEGprsInfoChange(TRequestStatus &, TDes8 &)

IMPORT_C void	NotifyEGprsInfoChange	(	TRequestStatus &	aStatus,
			TDes8 &	aGprsInfo
		)	const

Notifies an EGPRS information change

Parameters

TRequestStatus & aStatus	Request status
TDes8 & aGprsInfo	is a reference to a TGprsInformation class packaged inside a TPckg<> class.

NotifyHSxPAStatus(TRequestStatus &, THSxPAStatus &)

IMPORT_C void	NotifyHSxPAStatus	(	TRequestStatus &	aStatus,
			THSxPAStatus &	aHSxPAStatus
		)

Notify HSxPA Status change

Parameters

TRequestStatus & aStatus	Request status
THSxPAStatus & aHSxPAStatus

NotifyIccCallForwardingStatusChange(TRequestStatus &, TDes8 &)

IMPORT_C void	NotifyIccCallForwardingStatusChange	(	TRequestStatus &	aReqStatus,
			TDes8 &	aCFIndicators
		)

Notify ICC call forwarding status change

Parameters

TRequestStatus & aReqStatus	Request status
TDes8 & aCFIndicators	refrence to class CFIndicators

NotifyNSPSStatus(TRequestStatus &, TNspsStatus &)

IMPORT_C void	NotifyNSPSStatus	(	TRequestStatus &	aStatus,
			TNspsStatus &	aNspsStatus
		)

Notifies a client of a change in NSPS (No Service Power Save)

Parameters

TRequestStatus & aStatus	Request status
TNspsStatus & aNspsStatus	status of the NSPS (on/off)

NotifyNetworkConnectionFailure(TRequestStatus &)

IMPORT_C void

NotifyNetworkConnectionFailure

(

TRequestStatus &

aStatus

)

Notifies of a network connection failure. This failure is so sever that the only way to recover is to restart the phone.

Parameters

TRequestStatus & aStatus

Request status

NotifyPndCacheReady(TRequestStatus &, TName &)

IMPORT_C void	NotifyPndCacheReady	(	TRequestStatus &	aStatus,
			TName &	aPndName
		)

Notify a client when phonebook caching is ready

Parameters

TRequestStatus & aStatus	Request status
TName & aPndName	Returns the name of phonebook having ready cache

NotifyProgrammableOperatorLogoChange(TRequestStatus &, TOperatorId &)

IMPORT_C void	NotifyProgrammableOperatorLogoChange	(	TRequestStatus &	aStatus,
			TOperatorId &	aOperatorId
		)

Notifies of the change in the operator logo of the current network

Parameters

TRequestStatus & aStatus	Request status
TOperatorId & aOperatorId	Id of the operator

NotifyRauEvent(TRequestStatus &, TRauEventStatus &)

IMPORT_C void	NotifyRauEvent	(	TRequestStatus &	aStatus,
			TRauEventStatus &	aEventStatus
		)

Request notification of RAU event

Parameters

TRequestStatus & aStatus	reuquest status
TRauEventStatus & aEventStatus	RAU event status

NotifyRemoteAlertingToneStatusChange(TRequestStatus &, TRemoteAlertingToneStatus &)

IMPORT_C void	NotifyRemoteAlertingToneStatusChange	(	TRequestStatus &	aStatus,
			TRemoteAlertingToneStatus &	aToneStatus
		)

This function notifies a client of RemoteAlertingToneStatus change

Parameters

TRequestStatus & aStatus	Request status
TRemoteAlertingToneStatus & aToneStatus	RemoteAlertingTone status

NotifySimCardStatus(TRequestStatus &, TSIMCardStatus &)

IMPORT_C void	NotifySimCardStatus	(	TRequestStatus &	aStatus,
			TSIMCardStatus &	aCardStatus
		)

Notify SIM Card Status

Parameters

TRequestStatus & aStatus	Request status
TSIMCardStatus & aCardStatus	Card status

NotifySsNetworkEvent(TRequestStatus &, TSsTypeAndMode &, TSsInfo &)

IMPORT_C void	NotifySsNetworkEvent	(	TRequestStatus &	aStatus,
			TSsTypeAndMode &	aSsTypeAndMode,
			TSsInfo &	aSsInfo
		)

Notifies the client about a network generated SS event

Parameters

TRequestStatus & aStatus	Request status
TSsTypeAndMode & aSsTypeAndMode	Type and mode
TSsInfo & aSsInfo	SS info

Open(RMobilePhone &)

IMPORT_C TInt

Open

(

RMobilePhone &

aPhone

)

Opens a subsession.

Parameters

RMobilePhone & aPhone

reference to a Mobile Phone object

PowerSimOff(TRequestStatus &)

IMPORT_C void

PowerSimOff

(

TRequestStatus &

aStatus

)

Power SIM OFF.

Parameters

TRequestStatus & aStatus

Request status

PowerSimOn(TRequestStatus &)

IMPORT_C void

PowerSimOn

(

TRequestStatus &

aStatus

)

Power SIM ON.

Parameters

TRequestStatus & aStatus

Request status

ReadHSxPAStatus(TRequestStatus &, THSxPAStatus &)

IMPORT_C void	ReadHSxPAStatus	(	TRequestStatus &	aStatus,
			THSxPAStatus &	aHSxPAStatus
		)

Read HSxPA Status

Parameters

TRequestStatus & aStatus	Request status
THSxPAStatus & aHSxPAStatus

ReadSimFile(TRequestStatus &, TDes8 &, TDes8 &)

IMPORT_C void	ReadSimFile	(	TRequestStatus &	aStatus,
			TDes8 &	aSimFileInfo,
			TDes8 &	aResponseBytes
		)	const

Reads information from a SIM file asynchronously

Parameters

TRequestStatus & aStatus	Request status
TDes8 & aSimFileInfo	reference to class containing SIM File's info
TDes8 & aResponseBytes	reference to buffer in which store SIM File's data

ReadViagHomeZoneCache(TViagCacheRecordId &, TViagCacheRecordContent &)

IMPORT_C TInt	ReadViagHomeZoneCache	(	TViagCacheRecordId &	aId,
			TViagCacheRecordContent &	aRecord
		)	const

Read VIAG Cache asynchronously

Parameters

TViagCacheRecordId & aId	VIAG Home Zone Record Id to read from
TViagCacheRecordContent & aRecord

ReadViagHomeZoneCache(TRequestStatus &, TViagCacheRecordId &, TViagCacheRecordContent &)

IMPORT_C void	ReadViagHomeZoneCache	(	TRequestStatus &	aStatus,
			TViagCacheRecordId &	aId,
			TViagCacheRecordContent &	aRecord
		)

Read VIAG Cache asynchronously

Parameters

TRequestStatus & aStatus	Request status KErrNone if successful
TViagCacheRecordId & aId	VIAG Home Zone Record Id to read from
TViagCacheRecordContent & aRecord

ReadViagHomeZoneParams(TViagParams &, TViagElements &)

IMPORT_C TInt	ReadViagHomeZoneParams	(	TViagParams &	aParam,
			TViagElements &	aElems
		)	const

Read VIAG Parameters synchronously

Parameters

TViagParams & aParam	VIAG Home Zone Pararmeters
TViagElements & aElems	VIAG Home Zone Elements

ReadViagHomeZoneParams(TRequestStatus &, TViagParams &, TViagElements &)

IMPORT_C void	ReadViagHomeZoneParams	(	TRequestStatus &	aStatus,
			TViagParams &	aParam,
			TViagElements &	aElems
		)

Read VIAG Parameters asynchronously

Parameters

TRequestStatus & aStatus	Request status KErrNone if successful
TViagParams & aParam
TViagElements & aElems

ReleaseFile(TRequestStatus &, const TDesC &)

IMPORT_C void	ReleaseFile	(	TRequestStatus &	aStatus,
			const TDesC &	aFileName
		)

Releases CommDB file

Parameters

TRequestStatus & aStatus	Request status
const TDesC & aFileName	File to be released

ResetNetServer()

IMPORT_C void

ResetNetServer

(

)

const

This function resets the net server

ResetNetServer(TRequestStatus &)

IMPORT_C void

ResetNetServer

(

TRequestStatus &

aStatus

)

This function resets the net server

Parameters

TRequestStatus & aStatus

Request status

RestartFile(TRequestStatus &, const TDesC &)

IMPORT_C void	RestartFile	(	TRequestStatus &	aStatus,
			const TDesC &	aFileName
		)

Restarts reading CommDB file

Parameters

TRequestStatus & aStatus	Request status
const TDesC & aFileName	File to be restarted

SatRefreshCompleteNotification(TRequestStatus &)

IMPORT_C void

SatRefreshCompleteNotification

(

TRequestStatus &

aStatus

)

Notifies a client of SAT refresh

Parameters

TRequestStatus & aStatus

SendAPDUReq(TApdu &)

IMPORT_C TInt

SendAPDUReq

(

TApdu &

anAPDUReq

)

Send APDU request and wait for response synchronously

Parameters

TApdu & anAPDUReq

reference to structure containing APDU request's details

SendAPDUReq(TRequestStatus &, TApdu &)

IMPORT_C void	SendAPDUReq	(	TRequestStatus &	aStatus,
			TApdu &	anAPDUReq
		)

Send APDU request asynchronously

Parameters

TRequestStatus & aStatus	Request status
TApdu & anAPDUReq	reference to structure containing APDU request's details

SendAPDUReq(TRequestStatus &, TApduParameters &)

IMPORT_C void	SendAPDUReq	(	TRequestStatus &	aStatus,
			TApduParameters &	aParams
		)

Send APDU Request to APDU server

Parameters

TRequestStatus & aStatus	Request status
TApduParameters & aParams

SetAlsBlocked(const TSetAlsBlock)

IMPORT_C TInt

SetAlsBlocked

(

const TSetAlsBlock

aBlockStatus

)

const

Sets the alternating line service block status using the aBlockStatus variable

Parameters

const TSetAlsBlock aBlockStatus

als block status

SetAlsBlocked(TRequestStatus &, const TSetAlsBlock)

IMPORT_C void	SetAlsBlocked	(	TRequestStatus &	aStatus,
			const TSetAlsBlock	aBlockStatus
		)

Sets the alternating line service block status using the aBlockStatus variable

Parameters

TRequestStatus & aStatus	Request status
const TSetAlsBlock aBlockStatus	als block status

SetAlwaysOn(TRequestStatus &, TSetAlwaysOnMode &)

IMPORT_C void	SetAlwaysOn	(	TRequestStatus &	aStatus,
			TSetAlwaysOnMode &	aMode
		)	const

Set the "always on" mode

Parameters

TRequestStatus & aStatus
TSetAlwaysOnMode & aMode	Desired "always on" mode

SetDriveMode(TRequestStatus &, const TSetDriveMode)

IMPORT_C void	SetDriveMode	(	TRequestStatus &	aStatus,
			const TSetDriveMode	aModeStatus
		)

Sets Drive Mode status using the aModeStatus variable

Parameters

TRequestStatus & aStatus	Request status
const TSetDriveMode aModeStatus	Drive mode status

SetSimMessageStatusRead(TTime &, TInt &)

IMPORT_C void	SetSimMessageStatusRead	(	TTime &	aTime,
			TInt &	aTimezoneDiff
		)	const

Sets "storage status" byte of a SIM-stored SMS message to "read". Parameters are SM service center timestamp (as of 3GPP TS 23.040).

Parameters

TTime & aTime	time
TInt & aTimezoneDiff	timezone (difference to GMT, in quarters of an hour)

SetSystemNetworkBand(const TBandSelection, const TNetworkModeCaps)

IMPORT_C TInt	SetSystemNetworkBand	(	const TBandSelection	aNetworkBand,
			const TNetworkModeCaps	aNetworkMode
		)

This method sets network system band synchronously.

Parameters

const TBandSelection aNetworkBand	system networkband
const TNetworkModeCaps aNetworkMode

SetSystemNetworkBand(TRequestStatus &, const TBandSelection, const TNetworkModeCaps)

IMPORT_C void	SetSystemNetworkBand	(	TRequestStatus &	aStatus,
			const TBandSelection	aNetworkBand,
			const TNetworkModeCaps	aNetworkMode
		)

This method sets network system band asynchronously.

Parameters

TRequestStatus & aStatus	Request status
const TBandSelection aNetworkBand
const TNetworkModeCaps aNetworkMode	used network mode

SetSystemNetworkMode(const TNetworkModeCaps)

IMPORT_C TInt

SetSystemNetworkMode

(

const TNetworkModeCaps

aNetworkMode

)

This method sets network system mode synchronously.

Parameters

const TNetworkModeCaps aNetworkMode

system networkmode

SetSystemNetworkMode(TRequestStatus &, const TNetworkModeCaps)

IMPORT_C void	SetSystemNetworkMode	(	TRequestStatus &	aStatus,
			const TNetworkModeCaps	aNetworkMode
		)

This method sets network system mode asynchronously.

Parameters

TRequestStatus & aStatus	Request status
const TNetworkModeCaps aNetworkMode

SimWarmReset(TRequestStatus &)

IMPORT_C void

SimWarmReset

(

TRequestStatus &

aStatus

)

Perform Warm Reset to SIM.

Parameters

TRequestStatus & aStatus

Request status

SsAdditionalInfoNotification(TRequestStatus &, TSsAdditionalInfo &)

IMPORT_C void	SsAdditionalInfoNotification	(	TRequestStatus &	aStatus,
			TSsAdditionalInfo &	aSsAdditionalInfo
		)

Notification request for additionalinfo message

Parameters

TRequestStatus & aStatus	Request status
TSsAdditionalInfo & aSsAdditionalInfo	SS additional information

SsRequestCompleteNotification(TRequestStatus &, TInt &)

IMPORT_C void	SsRequestCompleteNotification	(	TRequestStatus &	aStatus,
			TInt &	aSsStatus
		)

Notify a client of the success of the sent SS command

Parameters

TRequestStatus & aStatus	Request status
TInt & aSsStatus	SS status

StartSimCbTopicBrowsing()

IMPORT_C TInt

StartSimCbTopicBrowsing

(

)

Start Sim CB Topic Browsing

TerminateCall(TName &)

IMPORT_C TInt

TerminateCall

(

TName &

aCallName

)

const

Terminates a call synchronously

Parameters

TName & aCallName

call name

TerminateCall(TRequestStatus &, TName &)

IMPORT_C void	TerminateCall	(	TRequestStatus &	aStatus,
			TName &	aCallName
		)

Terminates a call asynchronously

Parameters

TRequestStatus & aStatus	Request status
TName & aCallName	call name

WriteHSxPAStatus(TRequestStatus &, THSxPAStatus &)

IMPORT_C void	WriteHSxPAStatus	(	TRequestStatus &	aStatus,
			THSxPAStatus &	aHSxPAStatus
		)

Write HSxPA Status

Parameters

TRequestStatus & aStatus	Request status
THSxPAStatus & aHSxPAStatus

WriteViagHomeZoneCache(const TViagCacheRecordId &, const TViagCacheRecordContent &)

IMPORT_C TInt	WriteViagHomeZoneCache	(	const TViagCacheRecordId &	aId,
			const TViagCacheRecordContent &	aRecord
		)	const

Write VIAG Cache asynchronously

Parameters

const TViagCacheRecordId & aId	VIAG Home Zone Record Id to write to
const TViagCacheRecordContent & aRecord

WriteViagHomeZoneCache(TRequestStatus &, const TViagCacheRecordId &, const TViagCacheRecordContent &)

IMPORT_C void	WriteViagHomeZoneCache	(	TRequestStatus &	aStatus,
			const TViagCacheRecordId &	aId,
			const TViagCacheRecordContent &	aRecord
		)

Write VIAG Cache asynchronously

Parameters

TRequestStatus & aStatus
const TViagCacheRecordId & aId	VIAG Home Zone Record Id to write to
const TViagCacheRecordContent & aRecord

WriteViagHomeZoneUHZIUESettings(TViagUHZIUESettings &)

IMPORT_C TInt

WriteViagHomeZoneUHZIUESettings

(

TViagUHZIUESettings &

aSettings

)

const

This method writes specified VIAG Home Zone UHZIUE settings synchronously.

U-HZI-UE settings field is coded as follow:

------------------------- |b8|b7|b6|b5|b4|b3|b2|b1| ------------------------- <-0:The U-HZI-UE is deactivated 1:The U-HZI-UE is activated

<----0:The CB-HZI-UE is deactivated 1:The CB-HZI-UE is activated

Constants RMmCustomAPI::KUHziUeActive and RMmCustomAPI::HCbHziUeActive can be used to determine and modificate states of different activation bits.

For example:

if ( iEfUHziUeSettings.settings & KUHziUeActive ) then U-HZI-UE is activated

Activate: iEfUHziUeSettings.settings |= KUHziUeActive;

Deactivate: iEfUHziUeSettings.settings &= ~KUHziUeActive;

Parameters

TViagUHZIUESettings & aSettings

Settings

WriteViagHomeZoneUHZIUESettings(TRequestStatus &, TViagUHZIUESettings &)

IMPORT_C void	WriteViagHomeZoneUHZIUESettings	(	TRequestStatus &	aStatus,
			TViagUHZIUESettings &	aSettings
		)	const

This method writes specified VIAG Home Zone UHZIUE settings asynchronously.

Parameters

TRequestStatus & aStatus	Request status
TViagUHZIUESettings & aSettings	Settings

Member Enumerations Documentation

Enum anonymous

Remote Address Size

Enumerators

KRemoteAddressSize = 64

Remote Address Size

Enum TActiveFlag

Active Flag values

Enumerators

ENotActive	Not active
EHomeZone	Home Zone
ECityZone	City Zone

Enum TAlsSupport

ALS Support values

Enumerators

EAlsSupportOn	ALS Support is On
EAlsSupportOff	ALS Support if Off

Enum TBandSelection

Band Selection

Enumerators

ENetworkBandUmts850 = 0x01	UMTS 850
ENetworkBandUmts2100 = 0x02	UMTS 2100
ENetworkBandAny = 0x03	Any band

Enum TCallOrigin

Origin of the call

Enumerators

EUnknown	Unknown
EETelCall	ETel call
EOutsider	Outside

Enum TCheckMode

Emergency number check modes

Enumerators

EEmerNumberCheckNormal	Normal
EEmerNumberCheckAdvanced	Advanced

Enum TDtmfEvent

DTMF events

Enumerators

EDtmfStart	Start
EDtmfStop	Stop
EDtmfAbort	Abort

Enum TDtmfEventType

DTMF Event types

Enumerators

EDtmfManual	Manual
EDtmfSequence	Sequence

Enum TGetAlsBlockStatus

ALS block status values

Enumerators

EBlockStatusNotSupported	Not supported
EBlockStatusActive	Active
EBlockStatusInactive	Inactive
EBlockStatusUnknown	Unknown

Enum TGprsInformationType

Gprs type info

Enumerators

EGprs = 0	GPRS
EEdgeGprs = 1	EDGE GPRS

Enum THSxPAStatus

High speed channel status

Enumerators

EHSxPADisabled	Disabled HSxPA
EHSxPAEnabled	Enabled HSxPA

Enum TLockNumber

TLockNumber defines SIMLock types to be used

Enumerators

EOperator = 1	Operator
EGid1	GID1
EGid2	GID2
EImsi	IMSI
EOperator_Gid1	Operator GID1
EOperator_Gid2	Operator GID2
EGlobalUnlock	Global unlock

Enum TMultimodeETelCustomV1Api

Enumerates the Custom API version number.

Enumerators

KETelCustomExtMultimodeV1 = 10000	Version of Custom API extension
KETelCustomExtCustomCallParamsV3	Version of TTCustomCallParams

Enum TMultipleSubscriberProfileID

Possible values for Multiple Subscriber Profile IDs

Enumerators

KProfileIdentityOne = 0x01	Multiple Subscriber Profile ID 1
KProfileIdentityTwo = 0x02	Multiple Subscriber Profile ID 2
KProfileIdentityThree = 0x03	Multiple Subscriber Profile ID 3
KProfileIdentityFour = 0x04	Multiple Subscriber Profile ID 4

Enum TNetworkModeCaps

System network mode

Enumerators

KCapsNetworkModeUnknown = 0x00	Unknown mode
KCapsNetworkModeGsm = 0x01	GSM mode
KCapsNetworkModeUmts = 0x02	UMTS mode
KCapsNetworkModeDual = 0x04	Dual mode (GPRS/UMTS)

Enum TNspsStatus

Status of the No Service Power Save state

Enumerators

ENspsOn	No Service Power Save is ON
ENspsOff	No Service Power Save is OFF

Enum TOperatorNameType

Operator name types

Enumerators

EOperatorNameNitzFull	NITZ Full
EOperatorNameNitzShort	NITZ Short
EOperatorNameProgrammableUcs2	Programmable UCS2
EOperatorNameProgrammableLatin	Programmable Latin
EOperatorNameHardcodedUcs2	Hardcoded UCS2
EOperatorNameHardcodedLatin	Hardcoded Latin
EOperatorNameCountryMcn	Country MNC
EOperatorNameMccMnc	MCC MNC
EOperatorNameFlexiblePlmn	Flexible PLMN
EOperatorNameHighestPriority	Highest Priority

Enum TPndCacheStatus

Caching status

Enumerators

ECacheNotReady	Not ready
ECacheReady	Ready
ECacheNotUsed	Not used
ECacheFailed	Failed

Enum TProgrammableOperatorLogoDepth

Programmable operator logo depth

Enumerators

EBitPerPixel1	1 bit per pixel
EBitPerPixel2	2 bits per pixel
EBitPerPixel4	4 bits per pixel
EBitPerPixel8	8 bits per pixel

Enum TRauEventStatus

RAU event status values

Enumerators

ERauEventActive	Active
ERauEventResumed	Resumed

Enum TRemoteAlertingToneStatus

Remote alerting tone status

Enumerators

EUiNoTone	No Tone
EUiRbtTone	RBT Tone
EUiStopTone	Stop Tone

Enum TSIMCardStatus

SIM Card status

Enumerators

SimCardUnknowError = 0x00	Error
SimCardResetPerformed	Reset
SimCardNotAccessible	Not Accessible
SimCardRemoved	Removed
SimCardInserted	Inserted
SimCardRecovered	Recovered

Enum TSecurityCodeType

Security code types

Enumerators

ESecurityCodePin1	PIN1 code
ESecurityCodePin2	PIN2 code
ESecurityUniversalPin	Universal PIN code
ESecurityCodePuk1	PUK1 code
ESecurityCodePuk2	PUK2 code
ESecurityCodePassPhrase	Phone SIM lock and phone device lock codes

Enum TSetAlsBlock

ALS block status values

Enumerators

EDeactivateBlock	Deactivate
EActivateBlock	Activate

Enum TSetAlwaysOnMode

Always On modes

Enumerators

EAlwaysModeHPLMN	HPLMN
EAlwaysModeVPLMN	VPLMN
EAlwaysModeBoth	Both modes (HPLMN/VPLMN)
EAlwaysModeNeither	Neither mode

Enum TSetDriveMode

Drive mode status

Enumerators

EDeactivateDriveMode	Drive Mode active
EActivateDriveMode	Drive Mode inactive

Enum TSsChoice

Call Name Presentation choice

Enumerators

ESsPresAllowed	Presentation allowed
ESsPresRestricted	Presentation restricted
ESsNumberNotAvailable	Number not available
ESsPresRestrictedAddress	Restricted address
ESsChoiceUnknown	Choice unknown

Enum TSsEctState

Explicit call transfer (ECT) state

Enumerators

ESsEctActive	ECT active
ESsEctAlerting	ECT alerting
ESsEctNotActive	ECT not active

Enum TSsForwMode

Forwarding mode

Enumerators

ESsIncCallIsForw	Incoming call is forwarded
ESsIncCallForwToC
ESsOutCallForwToC
EForwNotActive	Not Active

Enum TSsHoldMode

Hold mode

Enumerators

ESsHoldActive	Active
ESsHoldResume	Resume
ESsHoldNotActive	Not active

Enum TSsMode

State of the SS feature

Enumerators

ESsModeActive	Active
ESsModeNotActive	Not active
ESsModeNotRegistered	Not registered
ESsModeNotProvisioned	Not provisioned
ESsModeNotAvailable	Not available
ESsModeUnknown	Unknown state

Enum TSsStatus

Defines SS statuses to be used

Enumerators

KSsStatusGsmActive = 0x01	Active status
KSsStatusGsmRegistered = 0x02	Registered status
KSsStatusGsmProvisioned = 0x04	Provisioned status
KSsStatusGsmQuiescent = 0x08	Quiescent status
KSsStatusReturnError = 0xFFFF	Error status
KSsStatusNetworkFailure = 0xFFFE	Network failure

Enum TSsType

Type of SS

Enumerators

ESsAllSs = 0
ESsAllForwardings = 2
ESsForwUncond = 21
ESsForwBusy = 67
ESsForwNoReply = 61
ESsForwNoReach = 62
ESsAllBarrings = 330
ESsBarrAllOut = 33
ESsBarrOutInter = 331
ESsBarrOutInterExcHome = 332
ESsBarrAllIn = 35
ESsBarrAllInRoam = 351
ESsOutgoingBarrServ = 333
ESsIncomingBarrServ = 353
ESsCallWaiting = 43
ESsClip = 30
ESsClir = 31
ESsColp = 76
ESsColr = 77
ESsCnap = 300
ESsAllCondForwardings = 4
ESsRegPassword = 3

Enum TTwoDigitDialSupport

Two Digit Dial Support values

Enumerators

ETwoDigitDialSupportOn	On
ETwoDigitDialSupportOff	Off

Enum TViagDataType

Constants for VIAG Home Zone data

Enumerators

KViagParamNbrSize = 15	NBR size
KViagElemNameSize = 13	Name size
KViagElementCount = 4	Element count

Member Type Definitions Documentation

Typedef TAkaDataPckg

typedef TPckg < TSimAuthenticationEapAka >

TAkaDataPckg

Package buffer to hold TSimAuthenticationEapAka objects

Typedef TAuthenticationParameter

typedef TBuf8 < KMaxAuthenticationParameterLength >

TAuthenticationParameter

Typedef TCFIndicatorsPckg

typedef TPckg < TCFIndicators >

TCFIndicatorsPckg

Package buffer to hold TCFIndicators objects

Typedef TCustomCallParamsPckg

typedef TPckg < TCustomCallParams >

TCustomCallParamsPckg

Package buffer for TCustomCallParams objects

Typedef TGbaBootstrapDataPckg

typedef TPckg < TSimAuthenticationGbaBootstrap >

TGbaBootstrapDataPckg

Typedef TGbaBootstrapUpdateDataPckg

typedef TPckg < TSimAuthenticationGbaBootstrapUpdate >

TGbaBootstrapUpdateDataPckg

Typedef TGbaNafDerivationDataPckg

typedef TPckg < TSimAuthenticationGbaNafDerivation >

TGbaNafDerivationDataPckg

Typedef TGprsInformationPckg

typedef TPckg < TGprsInformation >

TGprsInformationPckg

Package buffer for TGprsInformation objects

Typedef TKeyDomainId

typedef TBuf8 < KMaxKeyDomainIdLength >

TKeyDomainId

Typedef TKeyGroupId

typedef TBuf8 < KMaxKeyGroupIdLength >

TKeyGroupId

Typedef TLifeTimeDataPckg

typedef TPckg < TLifeTimeData >

TLifeTimeDataPckg

Package buffer for TLifeTimeData objects

Typedef TMgvMskDeletionDataPckg

typedef TPckg < TSimAuthenticationMgvMskDeletion >

TMgvMskDeletionDataPckg

Typedef TMgvMtkGenerationDataPckg

typedef TPckg < TSimAuthenticationMgvMtkGeneration >

TMgvMtkGenerationDataPckg

Typedef TMikey

typedef TBuf8 < KMaxMikeyLength >

TMikey

Typedef TMmCellInfoPckg

typedef TPckg < TMmCellInfo >

TMmCellInfoPckg

Package buffer to hold TMmCellInfo objects

Typedef TMobileTelNumber

typedef TBuf < RMobilePhone::KMaxMobileTelNumberSize >

TMobileTelNumber

Buffer for telephone number

Typedef TParameter

typedef TBuf8 < KMaxParametersLength >

TParameter

Parameter buffer

Typedef TParentalControl

typedef TBuf8 < KMaxKeyDomainIdLength >

TParentalControl

Typedef TParentalRating

typedef TBuf8 < KMaxKeyGroupIdLength >

TParentalRating

Typedef TSimAuthenticationMgvMskUpdatePckg

typedef TPckg < TSimAuthenticationMgvMskUpdate >

TSimAuthenticationMgvMskUpdatePckg

Typedef TSimDataPckg

typedef TPckg < TSimAuthenticationEapSim >

TSimDataPckg

Package buffer to hold TSimAuthenticationEapSim objects

Typedef TSimFileInfoPckg

typedef TPckg < TSimFileInfo >

TSimFileInfoPckg

Package buffer for TSimFileInfo objects

Typedef TSimFilePath

typedef TBuf8 < KSimFilePathLength >

TSimFilePath

Package buffer for SIM File paths

Typedef TSimLockPassword

typedef TBuf < KSimLockMaxPasswordSize >

TSimLockPassword

Package buffer to hold TSimLockPassword objects

Typedef TViagElements

typedef CArrayFixFlat < TViagElement >

TViagElements

Array of TViagElement objects

Member Data Documentation

CMmCustomPtrHolder * iCustomPtrHolder

CMmCustomPtrHolder *

iCustomPtrHolder

[private]