Collapse all Symbian^3 Application Developer Library

CPhCltDialData Class Reference

class CPhCltDialData : public CBase

It defines the structure containing dial information.

Fields:

window group - When call is ended, set window group is actived.

show number - Permission to show number. ETrue if it is allowed.

redial - Automatic redial override.

name - Name corresponding to number. Name must be defined if shown number equals to EFalse. contact link - Contact link. you should put always when you are dialing from phonebook contact. tel number - String that is to be dialled. number fields are supported. allow match - Permission to allow match. ETrue if match is to be done. If you are dialing from sim pd or fdn, then this should be EFalse. number entry - Returns whether to return to the number entry on failure

end other calls - Information if the existing calls are ended before this new one is made. Not mandatory. Set only if you know that the call is an emergency call. subaddress - The calling party subaddress. Supports SAT features. Defined in ITU-T I.330 and 3GPP TS 11.14. SATCall - Set whether this is SAT originated call or not. Supports SAT features. bearer - Bearer capabilities. Supports SAT features.

CallType - The type of the call, i.e. voice (default) or video.

SendKey - Call made with SendKey, optional.

Redial maximum duration - Automatic redial maximum duration

Initiate call - true if iniate call false otherwise

UUI - User to user information sent on call setup phase.

phoneclient.lib

Since: 5.0 Dial data set for PhoneClient.

phoneclient.lib

Since: Series 60 5.0

Inherits from

CPhCltDialData
- CBase

Public Member Functions
	~CPhCltDialData ()
TBool	AllowMatch ()
const TPhCltBearerCapability &	Bearer ()
TPhCltCallType	CallType ()
const TDesC8 &	ContactLink ()
TBool	EndOtherCalls ()
TBool	InitiateCall ()
const TPhCltNameBuffer &	Name ()
TInt	Redial ()
const TTimeIntervalSeconds	RedialMaximumDuration ()
TBool	SATCall ()
TBool	SendKeyPressed ()
TUint32	ServiceId ()
void	SetAllowMatch ( TBool )
void	SetBearerL (const TPhCltBearerCapability &)
void	SetCallType ( TPhCltCallType )
void	SetContactLinkL (const TDesC8 &)
void	SetEndOtherCalls ( TBool )
void	SetInitiateCall ( TBool )
void	SetNameL (const TPhCltNameBuffer &)
void	SetRedial ( TInt )
void	SetRedialMaximumDuration ( TTimeIntervalSeconds )
void	SetSATCall ( TBool )
void	SetSendKeyPressed ( TBool )
void	SetServiceId ( TUint32 )
void	SetShowNumber ( TBool )
void	SetSubAddressL (const TPhCltSubAddress &)
void	SetTelephoneNumber (const TPhCltTelephoneNumber &)
void	SetUUIL (const TDesC &)
void	SetWindowGroup ( TInt )
TBool	ShowNumber ()
const TPhCltSubAddress &	SubAddress ()
const TPhCltTelephoneNumber &	TelephoneNumber ()
const TDesC &	UUI ()
TInt	WindowGroup ()

Protected Member Functions
	CPhCltDialData ()
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()

Protected Attributes
TBool	iAllowMatch
TPhCltBearerCapability	iBearer
TPhCltCallType	iCallType
HBufC8 *	iContactLink
TBool	iEndOtherCalls
TUint	iFlags
TBool	iInitCall
TPhCltNameBuffer	iName
TInt	iRedial
TTimeIntervalSeconds	iRedialMaximumDuration
TBool	iReturnToNumberEntryOnFailure
TBool	iSATCall
TBool	iSendKey
TUint32	iServiceId
TBool	iShowNumber
TPhCltSubAddress	iSubAddress
TPhCltTelephoneNumber	iTelNumber
HBufC *	iUUI
TInt	iWindowGroup

Constructor & Destructor Documentation

CPhCltDialData()

CPhCltDialData

(

)

[protected]

C++ default constructor.

Since: Series 60 3.2

~CPhCltDialData()

~CPhCltDialData

(

)

[virtual]

Destructor.

Member Functions Documentation

AllowMatch()

TBool

AllowMatch

(

)

const [pure virtual]

Defines if mathing is allowed.

Since: Series 60 3.2

Bearer()

const TPhCltBearerCapability &

Bearer

(

)

const [pure virtual]

Bearer capability.

Since: Series 60 3.2

CallType()

TPhCltCallType

CallType

(

)

const [pure virtual]

Gives the current call type.

Since: Series 60 3.2

ConstructL()

void

ConstructL

(

)

[protected]

Construction that allocates memory.

Since: Series 60 3.2

ContactLink()

const TDesC8 &

ContactLink

(

)

const [pure virtual]

Contact link field.

Since: Series 60 3.2

EndOtherCalls()

TBool

EndOtherCalls

(

)

const [pure virtual]

End other calls param.

Since: Series 60 3.2

InitiateCall()

TBool

InitiateCall

(

)

const [pure virtual]

Intiate Call

Since: Series 60 3.2

Name()

const TPhCltNameBuffer &

Name

(

)

const [pure virtual]

Name.

Since: Series 60 3.2

Redial()

TInt

Redial

(

)

const [pure virtual]

Redial information.

Since: Series 60 3.2

RedialMaximumDuration()

const TTimeIntervalSeconds

RedialMaximumDuration

(

)

const [pure virtual]

Redial maximum duration

Since: Series 60 3.2

SATCall()

TBool

SATCall

(

)

const [pure virtual]

SAT Call.

Since: Series 60 3.2

SendKeyPressed()

TBool

SendKeyPressed

(

)

const [pure virtual]

SendKey pressed.

Since: Series 60 3.2

ServiceId()

TUint32

ServiceId

(

)

const [pure virtual]

Service Id.

SetAllowMatch(TBool)

void

SetAllowMatch

(

TBool

aAllowMatch

)

[pure virtual]

Set whether the name entered in SetName should be matched against the personal directory.

Since: Series 60 3.2 This should be set EFalse only if phone number has not been taken from phonebook.

Parameters

TBool aAllowMatch

Whether to allow matches.

SetBearerL(const TPhCltBearerCapability &)

void

SetBearerL

(

const TPhCltBearerCapability &

aBearer

)

[pure virtual]

Set the bearer capability.

Since: Series 60 3.2

Parameters

const TPhCltBearerCapability & aBearer

The bearer capabilities as defined in GSM 04.08. KErrArgument if aBearer's length is longer than KAiwBearerLength

SetCallType(TPhCltCallType)

void

SetCallType

(

TPhCltCallType

aCallType

)

[pure virtual]

Sets call type.

Since: Series 60 3.2

Parameters

TPhCltCallType aCallType

calls' type.

SetContactLinkL(const TDesC8 &)

void

SetContactLinkL

(

const TDesC8 &

aContactLink

)

[pure virtual]

Set contact link.

Since: Series 60 3.2

Parameters

const TDesC8 & aContactLink

Contact link information.

SetEndOtherCalls(TBool)

void

SetEndOtherCalls

(

TBool

aEndCalls

)

[pure virtual]

Set parameter for end other calls.

Since: Series 60 3.2 If this is set to ETrue, other calls will be terminated before dial. Default is EFalse.

Parameters

TBool aEndCalls

Are the other calls ended.

SetInitiateCall(TBool)

void

SetInitiateCall

(

TBool

aInitCall

)

[pure virtual]

Set Initiate call Etrue or EFalse

Since: Series 60 3.2

Parameters

TBool aInitCall

ETrue if call is intiate call

SetNameL(const TPhCltNameBuffer &)

void

SetNameL

(

const TPhCltNameBuffer &

aName

)

[pure virtual]

Set the name of the person who is to be called.

Since: Series 60 3.2

Parameters

const TPhCltNameBuffer & aName

The name of the person being called. KErrArgument if aName length is over 50 characters.

SetRedial(TInt)

void

SetRedial

(

TInt

aRedial

)

[pure virtual]

Change the redial mode.

Since: Series 60 3.2

Parameters

TInt aRedial

The new redial status

SetRedialMaximumDuration(TTimeIntervalSeconds)

void

SetRedialMaximumDuration

(

TTimeIntervalSeconds

aMaximumRedialDuration

)

[pure virtual]

Set redial max duration.

Since: Series 60 3.2

Parameters

TTimeIntervalSeconds aMaximumRedialDuration

SetSATCall(TBool)

void

SetSATCall

(

TBool

aSATCall

)

[pure virtual]

Set wheteher this is a SAT originated call or not. If this function is not called, the originator is assumed to be other than SAT.

Since: Series 60 3.2

Parameters

TBool aSATCall

ETrue if SAT originated the call, EFalse otherwise.

SetSendKeyPressed(TBool)

void

SetSendKeyPressed

(

TBool

aSendKey

)

[pure virtual]

Set the value of SendKey.

Since: Series 60 3.2

Parameters

TBool aSendKey

The value of SendKey.

SetServiceId(TUint32)

void

SetServiceId

(

TUint32

aServiceId

)

[pure virtual]

Set the value of xSP Service Id.

Parameters

TUint32 aServiceId

The value of Service Id.

SetShowNumber(TBool)

void

SetShowNumber

(

TBool

aShowNumber

)

[pure virtual]

Set the number visibility in the phone app.

Since: Series 60 3.2 If this is set to EFalse, then number is not shown or written to log event.

Parameters

TBool aShowNumber

Whether or not to show the number.

SetSubAddressL(const TPhCltSubAddress &)

void

SetSubAddressL

(

const TPhCltSubAddress &

aSubAddress

)

[pure virtual]

Set the calling party subaddress. Defined in ITU-T I.330 and 3GPP TS 11.14.

Since: Series 60 3.2

Parameters

const TPhCltSubAddress & aSubAddress

The calling party subaddress. KErrArgument if aSubAddress length is longer than KAiwSubAddressLength

SetTelephoneNumber(const TPhCltTelephoneNumber &)

void

SetTelephoneNumber

(

const TPhCltTelephoneNumber &

aNumber

)

[pure virtual]

Sets the phone number.

Since: Series 60 3.2

Parameters

const TPhCltTelephoneNumber & aNumber

Phone number, which maximum length is KMaximumPhoneNumberLength. KErrArgument if aPhoneNumber length is over KMaximumPhoneNumberLength

SetUUIL(const TDesC &)

void

SetUUIL

(

const TDesC &

aUUI

)

[pure virtual]

Sets user to user information. Maximum length is KPhCltUUILength.

Since: S60 v3.2

Parameters

const TDesC & aUUI

User to user information.

SetWindowGroup(TInt)

void

SetWindowGroup

(

TInt

aWindowGroup

)

[pure virtual]

Sets the window group identifier. When call is ended, set window group is actived.

Since: Series 60 3.2

Parameters

TInt aWindowGroup

Window group id.

ShowNumber()

TBool

ShowNumber

(

)

const [pure virtual]

Show Number.

Since: Series 60 3.2

SubAddress()

const TPhCltSubAddress &

SubAddress

(

)

const [pure virtual]

Sub address.

Since: Series 60 3.2

TelephoneNumber()

const TPhCltTelephoneNumber &

TelephoneNumber

(

)

const [pure virtual]

Gives the current phone number.

Since: Series 60 3.2

UUI()

const TDesC &

UUI

(

)

const [pure virtual]

Gives the user to user information.

Since: S60 v3.2

WindowGroup()

TInt

WindowGroup

(

)

const [pure virtual]

Gives the current window group id.

Since: Series 60 3.2

Member Data Documentation

TBool iAllowMatch

TBool

iAllowMatch

[protected]

TPhCltBearerCapability iBearer

TPhCltBearerCapability

iBearer

[protected]

TPhCltCallType iCallType

TPhCltCallType

iCallType

[protected]

HBufC8 * iContactLink

HBufC8 *

iContactLink

[protected]

TBool iEndOtherCalls

TBool

iEndOtherCalls

[protected]

TUint iFlags

TUint

iFlags

[protected]

TBool iInitCall

TBool

iInitCall

[protected]

TPhCltNameBuffer iName

TPhCltNameBuffer

iName

[protected]

TInt iRedial

TInt

iRedial

[protected]

TTimeIntervalSeconds iRedialMaximumDuration

TTimeIntervalSeconds

iRedialMaximumDuration

[protected]

TBool iReturnToNumberEntryOnFailure

TBool

iReturnToNumberEntryOnFailure

[protected]

TBool iSATCall

TBool

iSATCall

[protected]

TBool iSendKey

TBool

iSendKey

[protected]

TUint32 iServiceId

TUint32

iServiceId

[protected]

TBool iShowNumber

TBool

iShowNumber

[protected]

TPhCltSubAddress iSubAddress

TPhCltSubAddress

iSubAddress

[protected]

TPhCltTelephoneNumber iTelNumber

TPhCltTelephoneNumber

iTelNumber

[protected]

HBufC * iUUI

HBufC *

iUUI

[protected]

User to user info. own.

TInt iWindowGroup

TInt

iWindowGroup

[protected]