Collapse all Symbian^3 Product Developer Library

CPhCltExtPhoneDialData Class Reference

class CPhCltExtPhoneDialData : public CPhCltDialData

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: 3.2 Dial data set for PhoneClient.

ServiceHandler.lib

Since: Series 60 3.2

Inherits from

CPhCltExtPhoneDialData
- CPhCltDialData
  - CBase

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

Private Member Functions
	CPhCltExtPhoneDialData()
TInt	CalculateDescriptorSize(const TDesC &)
TInt	CalculateDescriptorSize(const TDesC8 &)
void	CheckDescriptorMaxLengthL(TInt, TInt)
void	ConstructL()
void	ConstructL(const TDesC8 &)
void	CopyDescriptorToMemberDescriptorL(const TDesC &, HBufC *&)
void	CopyDescriptorToMemberDescriptorL(const TDesC8 &, HBufC8 *&)
void	ReadDescriptorFromStreamL(RDesReadStream &, HBufC8 *&)
void	ReadDescriptorFromStreamL(RDesReadStream &, HBufC *&)
void	WriteDescriptorToStreamL(RDesWriteStream &, const TDesC8 &)
void	WriteDescriptorToStreamL(RDesWriteStream &, const TDesC &)

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()
	CPhCltDialData::CPhCltDialData()
	CPhCltDialData::~CPhCltDialData()

Public Member Enumerations
enum	TPhCltCallFlags { EPhCltCallFlagsDefault = 0x0000, EPhCltCallFlagsAllowNumberShowing = 0x0001, EPhCltCallFlagsReturnToNumberEntryOnFailure = 0x0002, EPhCltCallFlagsAllowPersonalDirectoryMatching = 0x0004, EPhCltCallFlagsEndBeforeDial = 0x0008, EPhCltCallFlagsSAT = 0x0020, EPhCltCallFlagsVideoCall = 0x0040, EPhCltCallFlagsVoIPCall = 0x0080, EPhCltCallFlagsSendKey = 0x0100 }

Inherited Attributes
	CPhCltDialData::iAllowMatch
	CPhCltDialData::iBearer
	CPhCltDialData::iCallType
	CPhCltDialData::iContactLink
	CPhCltDialData::iEndOtherCalls
	CPhCltDialData::iFlags
	CPhCltDialData::iInitCall
	CPhCltDialData::iName
	CPhCltDialData::iRedial
	CPhCltDialData::iRedialMaximumDuration
	CPhCltDialData::iReturnToNumberEntryOnFailure
	CPhCltDialData::iSATCall
	CPhCltDialData::iSendKey
	CPhCltDialData::iServiceId
	CPhCltDialData::iShowNumber
	CPhCltDialData::iSubAddress
	CPhCltDialData::iTelNumber
	CPhCltDialData::iUUI
	CPhCltDialData::iWindowGroup

Constructor & Destructor Documentation

CPhCltExtPhoneDialData()

CPhCltExtPhoneDialData

(

)

[private]

C++ default constructor.

Since: Series 60 3.2

~CPhCltExtPhoneDialData()

IMPORT_C

~CPhCltExtPhoneDialData

(

)

[virtual]

Destructor.

Member Functions Documentation

AllowMatch()

IMPORT_C TBool

AllowMatch

(

)

const [virtual]

Defines if mathing is allowed.

Since: Series 60 3.2

Bearer()

IMPORT_C const TPhCltBearerCapability &

Bearer

(

)

const [virtual]

Bearer capability.

Since: Series 60 3.2

CalculateDescriptorSize(const TDesC &)

TInt

CalculateDescriptorSize

(

const TDesC &

aDescriptor

)

const [private]

Calculates variable descriptor size

Since: Series 60 3.2

Parameters

const TDesC & aDescriptor

which size is calculated

CalculateDescriptorSize(const TDesC8 &)

TInt

CalculateDescriptorSize

(

const TDesC8 &

aDescriptor

)

const [private]

Calculates variable descriptor size

Since: Series 60 3.2

Parameters

const TDesC8 & aDescriptor

which size is calculated

CalculatePackageSize()

IMPORT_C TInt

CalculatePackageSize

(

)

const

CallType()

IMPORT_C TPhCltCallType

CallType

(

)

const [virtual]

Gives the current call type.

Since: Series 60 3.2

CheckDescriptorMaxLengthL(TInt, TInt)

void	CheckDescriptorMaxLengthL	(	TInt	aDescriptorLength,
			TInt	aMaxAllowedDescriptorLength
		)	const [private]

Check descriptor max length Leaves with KErrArgument if aDescriptorLength is greated that aMaxAllowedDescriptorLenght

Since: Series 60 3.2

Parameters

TInt aDescriptorLength	is descriptor length
TInt aMaxAllowedDescriptorLength	maximum allowed descriptor length

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

Since: Series 60 3.2

ConstructL(const TDesC8 &)

void

ConstructL

(

const TDesC8 &

aPackage

)

[private]

By default Symbian 2nd phase constructor is private.

Since: Series 60 3.2

Parameters

const TDesC8 & aPackage

including dial data

ContactLink()

IMPORT_C const TDesC8 &

ContactLink

(

)

const [virtual]

Contact link field.

Since: Series 60 3.2

CopyDescriptorToMemberDescriptorL(const TDesC &, HBufC *&)

void	CopyDescriptorToMemberDescriptorL	(	const TDesC &	aSource,
			HBufC *&	aMemberDescriptor
		)	[private]

Copy descriptor value to member descriptor

Since: Series 60 3.2

Parameters

const TDesC & aSource	which is as copy source
HBufC *& aMemberDescriptor	is as copy destination

CopyDescriptorToMemberDescriptorL(const TDesC8 &, HBufC8 *&)

void	CopyDescriptorToMemberDescriptorL	(	const TDesC8 &	aSource,
			HBufC8 *&	aMemberDescriptor
		)	[private]

Copy descriptor value to member descriptor

Since: Series 60 3.2

Parameters

const TDesC8 & aSource	which is as copy source
HBufC8 *& aMemberDescriptor	is as copy destination

EndOtherCalls()

IMPORT_C TBool

EndOtherCalls

(

)

const [virtual]

End other calls param.

Since: Series 60 3.2

InitiateCall()

IMPORT_C TBool

InitiateCall

(

)

const [virtual]

Intiate Call

Since: Series 60 3.2

Name()

IMPORT_C const TPhCltNameBuffer &

Name

(

)

const [virtual]

Name.

Since: Series 60 3.2

NewL()

IMPORT_C CPhCltExtPhoneDialData *

NewL

(

)

[static]

Two-phased constructor.

NewL(const TDesC8 &)

IMPORT_C CPhCltExtPhoneDialData *

NewL

(

const TDesC8 &

aPackage

)

[static]

Two-phased constructor.

Parameters

const TDesC8 & aPackage

NewLC()

IMPORT_C CPhCltExtPhoneDialData *

NewLC

(

)

[static]

Two-phased constructor.

NewLC(const TDesC8 &)

IMPORT_C CPhCltExtPhoneDialData *

NewLC

(

const TDesC8 &

aPackage

)

[static]

Two-phased constructor.

Parameters

const TDesC8 & aPackage

PackLC()

IMPORT_C HBufC8 *

PackLC

(

)

Fills the parameter list.

Since: Series 60 3.2

ReadDescriptorFromStreamL(RDesReadStream &, HBufC8 *&)

void	ReadDescriptorFromStreamL	(	RDesReadStream &	aStream,
			HBufC8 *&	aDescriptor
		)	[private]

Read descriptor value from stream

Since: Series 60 3.2

Parameters

RDesReadStream & aStream	used stream
HBufC8 *& aDescriptor	which is read from stream

ReadDescriptorFromStreamL(RDesReadStream &, HBufC *&)

void	ReadDescriptorFromStreamL	(	RDesReadStream &	aStream,
			HBufC *&	aDescriptor
		)	[private]

Read descriptor value from stream

Since: Series 60 3.2

Parameters

RDesReadStream & aStream	used stream
HBufC *& aDescriptor	which is read from stream

Redial()

IMPORT_C TInt

Redial

(

)

const [virtual]

Redial information.

Since: Series 60 3.2

RedialMaximumDuration()

IMPORT_C const TTimeIntervalSeconds

RedialMaximumDuration

(

)

const [virtual]

Redial maximum duration

Since: Series 60 3.2

SATCall()

IMPORT_C TBool

SATCall

(

)

const [virtual]

Return in failure.

Since: Series 60 3.2

Since: Series 60 3.2

SendKeyPressed()

IMPORT_C TBool

SendKeyPressed

(

)

const [virtual]

SendKey pressed.

Since: Series 60 3.2

ServiceId()

IMPORT_C TUint32

ServiceId

(

)

const [virtual]

Service Id. VoIP2.2 implementation

SetAllowMatch(TBool)

IMPORT_C void

SetAllowMatch

(

TBool

aAllowMatch

)

[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 &)

IMPORT_C void

SetBearerL

(

const TPhCltBearerCapability &

aBearer

)

[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)

IMPORT_C void

SetCallType

(

TPhCltCallType

aCallType

)

[virtual]

Sets call type.

Since: Series 60 3.2

Parameters

TPhCltCallType aCallType

calls' type.

SetContactLinkL(const TDesC8 &)

IMPORT_C void

SetContactLinkL

(

const TDesC8 &

aContactLink

)

[virtual]

Set contact link.

Since: Series 60 3.2

Parameters

const TDesC8 & aContactLink

Contact link information.

SetEndOtherCalls(TBool)

IMPORT_C void

SetEndOtherCalls

(

TBool

aEndCalls

)

[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)

IMPORT_C void

SetInitiateCall

(

TBool

aInitCall

)

[virtual]

Set Initiate call Etrue or EFalse

Since: Series 60 3.2

Parameters

TBool aInitCall

ETrue if call is intiate call

SetNameL(const TPhCltNameBuffer &)

IMPORT_C void

SetNameL

(

const TPhCltNameBuffer &

aName

)

[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.

SetParamsL(const TDesC8 &)

void

SetParamsL

(

const TDesC8 &

aPackage

)

Parameters

const TDesC8 & aPackage

SetRedial(TInt)

IMPORT_C void

SetRedial

(

TInt

aRedial

)

[virtual]

Change the redial mode.

Since: Series 60 3.2

Parameters

TInt aRedial

The new redial status

SetRedialMaximumDuration(TTimeIntervalSeconds)

IMPORT_C void

SetRedialMaximumDuration

(

TTimeIntervalSeconds

aMaximumRedialDuration

)

[virtual]

Set redial max duration.

Since: Series 60 3.2

Parameters

TTimeIntervalSeconds aMaximumRedialDuration

SetReturnToNumberEntryOnFailure(TBool)

IMPORT_C void

SetReturnToNumberEntryOnFailure

(

TBool

aReturn

)

Set whether to return to number entry.

Parameters

TBool aReturn

Whether to return to the number entry editor.

SetSATCall(TBool)

IMPORT_C void

SetSATCall

(

TBool

aSATCall

)

[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)

IMPORT_C void

SetSendKeyPressed

(

TBool

aSendKey

)

[virtual]

Set the value of SendKey.

Since: Series 60 3.2

Parameters

TBool aSendKey

The value of SendKey.

SetServiceId(TUint32)

IMPORT_C void

SetServiceId

(

TUint32

aServiceId

)

[virtual]

Set the value of xSP Service Id.

Parameters

TUint32 aServiceId

The value of Service Id.

SetShowNumber(TBool)

IMPORT_C void

SetShowNumber

(

TBool

aShowNumber

)

[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 &)

IMPORT_C void

SetSubAddressL

(

const TPhCltSubAddress &

aSubAddress

)

[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 &)

IMPORT_C void

SetTelephoneNumber

(

const TPhCltTelephoneNumber &

aNumber

)

[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 &)

IMPORT_C void

SetUUIL

(

const TDesC &

aUUI

)

[virtual]

Sets user to user information. Maximum length is KPhCltUUILength.

Since: S60 v3.2

Parameters

const TDesC & aUUI

User to user information.

SetWindowGroup(TInt)

IMPORT_C void

SetWindowGroup

(

TInt

aWindowGroup

)

[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()

IMPORT_C TBool

ShowNumber

(

)

const [virtual]

Show Number.

Since: Series 60 3.2

SubAddress()

IMPORT_C const TPhCltSubAddress &

SubAddress

(

)

const [virtual]

Sub address.

Since: Series 60 3.2

TelephoneNumber()

IMPORT_C const TPhCltTelephoneNumber &

TelephoneNumber

(

)

const [virtual]

Gives the current phone number.

Since: Series 60 3.2

UUI()

IMPORT_C const TDesC &

UUI

(

)

const [virtual]

Gives the user to user information.

Since: S60 v3.2

WindowGroup()

IMPORT_C TInt

WindowGroup

(

)

const [virtual]

Gives the current window group id.

Since: Series 60 3.2

WriteDescriptorToStreamL(RDesWriteStream &, const TDesC8 &)

void	WriteDescriptorToStreamL	(	RDesWriteStream &	aStream,
			const TDesC8 &	aDescriptor
		)	[private]

Write descriptor value to stream

Since: Series 60 3.2

Parameters

RDesWriteStream & aStream	used stream
const TDesC8 & aDescriptor	which value is write to stream

WriteDescriptorToStreamL(RDesWriteStream &, const TDesC &)

void	WriteDescriptorToStreamL	(	RDesWriteStream &	aStream,
			const TDesC &	aDescriptor
		)	[private]

Write descriptor value to stream

Since: Series 60 3.2

Parameters

RDesWriteStream & aStream	used stream
const TDesC & aDescriptor	which value is write to stream

Member Enumerations Documentation

Enum TPhCltCallFlags

Enumerators

EPhCltCallFlagsDefault = 0x0000
EPhCltCallFlagsAllowNumberShowing = 0x0001
EPhCltCallFlagsReturnToNumberEntryOnFailure = 0x0002
EPhCltCallFlagsAllowPersonalDirectoryMatching = 0x0004
EPhCltCallFlagsEndBeforeDial = 0x0008
EPhCltCallFlagsSAT = 0x0020
EPhCltCallFlagsVideoCall = 0x0040
EPhCltCallFlagsVoIPCall = 0x0080
EPhCltCallFlagsSendKey = 0x0100