Collapse all Symbian^3 Product Developer Library

CCaUiEngApi Class Reference

class CCaUiEngApi : public CBase

The API for CallUIEngine usage.

CaUiEngine.lib

Since: 2.6

Inherits from

CCaUiEngApi
- CBase

Public Member Functions
void	CancelAddressSelect()
void	CancelNoteAndReconConfQuery()
void	CancelReconConfQuery()
void	DialL(MCaUiDialResultObserver &, const TDesC8 &, const TCaUiCallType)
void	GetVoIPServiceIdsL(RIdArray &)
void	GetVoipServiceNameL(TServiceId, TDes &)
TBool	LaunchAddressSelectL(TDes &, const TInt, const TBool)
void	LaunchNoNetSupNoteL()
void	LaunchNoteAndReconConfQueryL(MCaUiReconnectQueryObserver &, CPhCntMatcher *, const TPtrC, const TBool, const TPtrC)
void	LaunchReconConfQueryL(MCaUiReconnectQueryObserver &, CPhCntMatcher *, const TPtrC, const TBool)

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	TCaUiEngResource { ECaUiResVoice = 0, ECaUiResVoiceAndVideo = 1, ECaUiResVoiceInternetAndVideo = 2, ECaUiResOnlyInternet = 3 }
enum	TCaUiEngText { ECallMenuItemText = 0, EVoiceCallMenuItemText = 1, EVideoCallMenuItemText = 2, EInternetCallMenuItemText = 3 }

Member Functions Documentation

CancelAddressSelect()

void

CancelAddressSelect

(

)

[pure virtual]

Cancel address selection launched with LaunchAddressSelectL.

CancelNoteAndReconConfQuery()

void

CancelNoteAndReconConfQuery

(

)

[pure virtual]

Cancel note and reconnection query launched with LaunchNoteAndReconConfQueryL.

CancelReconConfQuery()

void

CancelReconConfQuery

(

)

[pure virtual]

Cancel reconnect query launched with LaunchReconConfQueryL.

DialL(MCaUiDialResultObserver &, const TDesC8 &, const TCaUiCallType)

void	DialL	(	MCaUiDialResultObserver &	aObserver,
			const TDesC8 &	aDialData,
			const TCaUiCallType	aCallType
		)	[pure virtual]

Make the dial operation.

Parameters

MCaUiDialResultObserver & aObserver	The observer to handle dial result.
const TDesC8 & aDialData	The TCallUIDialDataV1 dial data information in packaged format.
const TCaUiCallType aCallType	If not equal to ECaUiCallTypeUnknown, then overwrites the call type in aDialData.

GetVoIPServiceIdsL(RIdArray &)

void

GetVoIPServiceIdsL

(

RIdArray &

aVoipServiceIds

)

const [pure virtual]

Get VoIP services

Parameters

RIdArray & aVoipServiceIds

On return, contains the list of VoIP services

GetVoipServiceNameL(TServiceId, TDes &)

void	GetVoipServiceNameL	(	TServiceId	aServiceId,
			TDes &	aServiceName
		)	const [pure virtual]

Get the service provider name

Parameters

TServiceId aServiceId	The service, whose name is requested
TDes & aServiceName	On return, contains the service name

LaunchAddressSelectL(TDes &, const TInt, const TBool)

TBool	LaunchAddressSelectL	(	TDes &	aTelNum,
			const TInt	aContactId,
			const TBool	aVoIPAddressSelect
		)	[pure virtual]

Launch address selection. If contact contains default number or only one number, number will be returned directly. Otherwise address selection list displayed.

Since: 3.0

Parameters

TDes & aTelNum	Contains selected number after execution.
const TInt aContactId	The contact id from PhoneBook.
const TBool aVoIPAddressSelect	If ETrue VoIP address select is used.

LaunchNoNetSupNoteL()

void

LaunchNoNetSupNoteL

(

)

[pure virtual]

Launch the qtn.tel.no.video.network information note.

LaunchNoteAndReconConfQueryL(MCaUiReconnectQueryObserver &, CPhCntMatcher *, const TPtrC, const TBool, const TPtrC)

void	LaunchNoteAndReconConfQueryL	(	MCaUiReconnectQueryObserver &	aObserver,
			CPhCntMatcher *	aPhCntMatcher,
			const TPtrC	aPhoneNumber,
			const TBool	aIncludeVideoCallOption,
			const TPtrC	aNoteText
		)	[pure virtual]

Launch note and reconnect confirmation query in sequence.

Parameters

MCaUiReconnectQueryObserver & aObserver	The observer to handle query result.
CPhCntMatcher * aPhCntMatcher	The Phone Contact Matcher. Ownership not transferred. If NULL, then matcher is created inside CaUIEngine.
const TPtrC aPhoneNumber	Pointer to the number where dial was tried.
const TBool aIncludeVideoCallOption	If set to ETrue, video call option is included to query, otherwise it is left out.
const TPtrC aNoteText	The text shown in information note. If empty, then qtn.tel.no.video.network text is shown.

LaunchReconConfQueryL(MCaUiReconnectQueryObserver &, CPhCntMatcher *, const TPtrC, const TBool)

void	LaunchReconConfQueryL	(	MCaUiReconnectQueryObserver &	aObserver,
			CPhCntMatcher *	aPhCntMatcher,
			const TPtrC	aPhoneNumber,
			const TBool	aIncludeVideoCallOption
		)	[pure virtual]

Launch the reconnect confirmation query shown to user.

Parameters

MCaUiReconnectQueryObserver & aObserver	The observer to handle query result.
CPhCntMatcher * aPhCntMatcher	The Phone Contact Matcher. Ownership not transferred. If NULL, then matcher is created inside CaUIEngine.
const TPtrC aPhoneNumber	Pointer to the number where dial was tried.
const TBool aIncludeVideoCallOption	If set to ETrue, video call option is included to query, otherwise it is left out.

Member Enumerations Documentation

Enum TCaUiEngResource

Enumerate all supported resource types.

ECaUiResVoice - Pure voice call resources. ECaUiResVoiceAndVideo - Voice and video call resources. ECaUiResVoiceInternetAndVideo - All Internet, voice and video call resources. ECaUiResOnlyInternet - Only Internet call resources.

Enumerators

ECaUiResVoice = 0
ECaUiResVoiceAndVideo = 1
ECaUiResVoiceInternetAndVideo = 2
ECaUiResOnlyInternet = 3

Enum TCaUiEngText

Enumerate all supported localized text.

ECallMenuItemText - Menu item text for call. EVoiceCallMenuItemText - Menu item text for voice call. EVideoCallMenuItemText - Menu item text for video call. EInternetCallMenuItemText - Menu item text for internet call.

Enumerators

ECallMenuItemText = 0
EVoiceCallMenuItemText = 1
EVideoCallMenuItemText = 2
EInternetCallMenuItemText = 3