CISVAPIBase Class Reference

Inherited by CISVAPIAsync, and CISVAPISync.

List of all members.

Public Member Functions
	CISVAPIBase (MExecController *aController, TTelISVExampleType aExampleType)
void	StartRequestL ()
void	StartRequestL (CTelephony::TCallId aCallId)
void	StartRequestL (CTelephony::TCallId aCallId1, CTelephony::TCallId aCallId2)
void	StartRequestL (const TDesC &aTones)
void	RequestNotificationL ()
void	AppTerminate ()
void	RetrieveTelephonyObject ()
void	RetrieveConsole ()
TTelISVExampleType	GetExampleType () const
Protected Member Functions
virtual void	DoStartRequestL ()
virtual void	DoStartRequestL (CTelephony::TCallId aCallId)
virtual void	DoStartRequestL (CTelephony::TCallId aCallId1, CTelephony::TCallId aCallId2)
virtual void	DoStartRequestL (const TDesC &aNumber)
virtual void	DoRequestNotificationL ()
Protected Attributes
MExecController *	iController
CTelephony *	iTelephony
CConsoleBase *	iConsole

---

Detailed Description

Base class providing functionality for objects to make Etel 3rd party function calls and interact with their owning class.

Definition at line 138 of file CISVAPIBase.h.

---

Constructor & Destructor Documentation

CISVAPIBase::CISVAPIBase	(	MExecController *	aController,
		TTelISVExampleType	aExampleType
	)

Default constructor.

Parameters:

	aController	iController is set to point to this object
	aExampleType	The type of the derived class that has extended the functionality of this class

Definition at line 25 of file CISVAPIBase.cpp.

---

Member Function Documentation

void CISVAPIBase::StartRequestL

(

)

Make an Etel 3rd Party request and wait for its completion.

Reimplemented in CNetworkRegInfo.

Definition at line 57 of file CISVAPIBase.cpp.

void CISVAPIBase::StartRequestL

(

CTelephony::TCallId

aCallId

)

As StartRequestL()

Parameters:

aCallId

A call identifier to perform Etel Third Party operations on

Definition at line 78 of file CISVAPIBase.cpp.

void CISVAPIBase::StartRequestL	(	CTelephony::TCallId	aCallId1,
		CTelephony::TCallId	aCallId2
	)

As StartRequestL()

Parameters:

	aCallId1	A call identifier to perform Etel Third Party operations on
	aCallId2	A call identifier to perform Etel Third Party operations on

Definition at line 125 of file CISVAPIBase.cpp.

void CISVAPIBase::StartRequestL

(

const TDesC &

aTones

)

As StartRequestL()

Parameters:

aTones

A descriptor to perform Etel third party operations with

Definition at line 101 of file CISVAPIBase.cpp.

void CISVAPIBase::RequestNotificationL

(

)

Makes a request for notification on changes to specified Etel 3rd party data.

Reimplemented in CNetworkRegInfo.

Definition at line 38 of file CISVAPIBase.cpp.

void CISVAPIBase::AppTerminate

(

)

Ends the execution of the application by stopping the active scheduler and cancelling any outstanding requests.

Definition at line 150 of file CISVAPIBase.cpp.

void CISVAPIBase::RetrieveTelephonyObject

(

)

Retrieves a CTelephony instance from the MExecController implementing class by calling the GetTelObj() method of the interface. Sets iTelephony to point to this instance. Etel 3rd party calls can be made through this pointer.

Definition at line 209 of file CISVAPIBase.h.

void CISVAPIBase::RetrieveConsole

(

)

Retrieves a CConsoleBase instance from the MExecController implementing class by calling GConsole() method of the interface. Sets iConsole to point to this instance. A console can now be printed to through this pointer.

Definition at line 219 of file CISVAPIBase.h.

TTelISVExampleType CISVAPIBase::GetExampleType

(

)

const

Gives the type of the derived class.

Returns:

TTelISVExampleType enumeration value stating the derived type of this object

Definition at line 199 of file CISVAPIBase.h.

void CISVAPIBase::DoStartRequestL

(

)

[protected, virtual]

Virtual function for completing the request to start. Empty method.

Reimplemented in CCallStatus, CFlightModeInfo, CLineStatus, CNetworkRegInfo, CAnswerIncomingCall, CCallBarringStatus, CCallForwardingStatus, CCallInfo, CCallStatus, CCallWaitingStatus, CFlightModeInfo, CIdentityServiceStatus, CLineStatus, CCurrentNetworkInfo, CFlightModeInfo, CAnswerIncomingCall, CCallStatus, CCallWaitingStatus, CCurrentNetworkInfo, CCurrentNetworkName, CFlightModeInfo, CGetLockInfo, CLineStatus, CNetworkRegInfo, COperatorName, CPhoneId, CSubscriberId, CBatteryInfo, CFlightModeInfo, CGetIndicator, CSignalInfo, CPhoneId, CCallBarringStatus, CCallForwardingStatus, CCallWaitingStatus, CFlightModeInfo, and CIdentityServiceStatus.

Definition at line 65 of file CISVAPIBase.cpp.

void CISVAPIBase::DoStartRequestL

(

CTelephony::TCallId

aCallId

)

[protected, virtual]

Virtual function for completing the request to start. Empty method.

Parameters:

aCallId

A call identifier to perform Etel Third Party operations on

Reimplemented in CHangup, CHangup, CHangup, CHold, and CResume.

Definition at line 88 of file CISVAPIBase.cpp.

void CISVAPIBase::DoStartRequestL	(	CTelephony::TCallId	aCallId1,
		CTelephony::TCallId	aCallId2
	)			[protected, virtual]

Virtual function for completing the request to start. Empty method.

Parameters:

	aCallId1	A call identifier to perform Etel Third Party operations on
	aCallId2	A call identifier to perform Etel Third Party operations on

Reimplemented in CSwap.

Definition at line 137 of file CISVAPIBase.cpp.

void CISVAPIBase::DoStartRequestL

(

const TDesC &

aNumber

)

[protected, virtual]

Virtual function for completing the request to start. Empty method.

Parameters:

aNumber

Number to be used

Reimplemented in CDialCall, CSendDTMF, and CDialCall.

Definition at line 111 of file CISVAPIBase.cpp.

void CISVAPIBase::DoRequestNotificationL

(

)

[protected, virtual]

Virtual function for completing the notification request. Empty method.

Reimplemented in CCallStatus, CFlightModeInfo, CLineStatus, CNetworkRegInfo, CCallStatus, CFlightModeInfo, CLineStatus, CCurrentNetworkInfo, CFlightModeInfo, CCallStatus, CCurrentNetworkInfo, CFlightModeInfo, CGetLockInfo, CLineStatus, CNetworkRegInfo, CBatteryInfo, CFlightModeInfo, CGetIndicator, CSignalInfo, and CFlightModeInfo.

Definition at line 46 of file CISVAPIBase.cpp.

---

Member Data Documentation

MExecController* CISVAPIBase::iController [protected]

An instance of the MExecController interface allowing objects derived from this class to make calls back to a class implementing this interface. (In this case CMainMenu).

Definition at line 172 of file CISVAPIBase.h.

CTelephony* CISVAPIBase::iTelephony [protected]

A CTelephony instance allowing derived classes to make Etel 3rd party calls.

Definition at line 177 of file CISVAPIBase.h.

CConsoleBase* CISVAPIBase::iConsole [protected]

A CConsoleBase instance allowing derived classes to peform console operations such as printing.

Definition at line 182 of file CISVAPIBase.h.