Collapse all Symbian^3 Application Developer Library

MPEClientInformation Class Reference

class MPEClientInformation

Interface to access the client information of a single call.

Public Member Functions
TBool	AllowMatch ()
TPECallType	CallType ()
const TDesC8 &	ContactLink ()
TBool	EndOtherCalls ()
const TName &	Name ()
const TPEPhoneNumber &	Number ()
void	Reset ()
void	Set (const MPEClientInformation &)
void	SetAllowMatch ( TBool )
void	SetCallType ( TPECallType )
void	SetContactLink (const TDesC8 &)
void	SetEndOtherCalls ( TBool )
void	SetName (const TName &)
void	SetNumber (const TPEPhoneNumber &)
void	SetShowNumber ( TBool )
TBool	ShowNumber ()

Member Functions Documentation

AllowMatch()

TBool

AllowMatch

(

)

const [pure virtual]

Returns if contact matching is allowed.

CallType()

TPECallType

CallType

(

)

const [pure virtual]

Returns the type of the call.

ContactLink()

const TDesC8 &

ContactLink

(

)

const [pure virtual]

Returns the contact link used for retrieving contact information.

EndOtherCalls()

TBool

EndOtherCalls

(

)

const [pure virtual]

Returns a flag indicating if existing calls should be terminated before this one is being attempted.

Name()

const TName &

Name

(

)

const [pure virtual]

Returns the name corresponding the phone number.

Number()

const TPEPhoneNumber &

Number

(

)

const [pure virtual]

Returns the phone number to be dialed.

Reset()

void

Reset

(

)

[pure virtual]

Resets the state of this client information.

Set(const MPEClientInformation &)

void

Set

(

const MPEClientInformation &

aSource

)

[pure virtual]

Sets information from another client information.

Parameters

const MPEClientInformation & aSource

Client information to set.

SetAllowMatch(TBool)

void

SetAllowMatch

(

TBool

aAllow

)

[pure virtual]

Enables or disables contact matching.

Parameters

TBool aAllow

Flag to enable or disable contact matching.

SetCallType(TPECallType)

void

SetCallType

(

TPECallType

aType

)

[pure virtual]

Sets the type of the call.

Parameters

TPECallType aType

Type of the call to set.

SetContactLink(const TDesC8 &)

void

SetContactLink

(

const TDesC8 &

aLink

)

[pure virtual]

Sets the contact link used for retrieving contact information.

Should be available when dialing from Phonebook.

Parameters

const TDesC8 & aLink

Contact link to set.

SetEndOtherCalls(TBool)

void

SetEndOtherCalls

(

TBool

aEndOtherCalls

)

[pure virtual]

Flag to indicate if existing calls should be terminated before this one is being attempted.

Parameters

TBool aEndOtherCalls

Flag to indicate if existing calls should be terminated before this one is being attempted.

SetName(const TName &)

void

SetName

(

const TName &

aName

)

[pure virtual]

Sets the name corresponding the phone number.

Must be defined if showing the phone number is disabled.

Parameters

const TName & aName

Name corresponding the phone number.

SetNumber(const TPEPhoneNumber &)

void

SetNumber

(

const TPEPhoneNumber &

aNumber

)

[pure virtual]

Sets the phone number to be dialed.

Parameters

const TPEPhoneNumber & aNumber

Phone number to set.

SetShowNumber(TBool)

void

SetShowNumber

(

TBool

aShow

)

[pure virtual]

Shows or hides the phone number that is being dialed.

Parameters

TBool aShow

Flag to indicate if the phone number being dialed should be shown.

ShowNumber()

TBool

ShowNumber

(

)

const [pure virtual]

Returns a flag indicating if the phone number being dialed should be shown.