Collapse all Symbian^3 Product Developer Library

RLine Class Reference

class RLine : public RTelSubSessionBase

Provides access to the functionality associated with a specific line.

This class is not intended for user derivation.

Inherits from

RLine
- RTelSubSessionBase
  - RSubSessionBase

Nested Classes and Structures

Public Member Functions
	RLine()
IMPORT_C void	Close()
IMPORT_C TInt	EnumerateCall(TInt &)
IMPORT_C TInt	GetCallInfo(TInt, TCallInfo &)
IMPORT_C TInt	GetCaps(TCaps &)
IMPORT_C TInt	GetHookStatus(RCall::THookStatus &)
IMPORT_C TInt	GetInfo(TLineInfo &)
IMPORT_C TInt	GetStatus(RCall::TStatus &)
IMPORT_C void	NotifyCallAddedCancel()
IMPORT_C void	NotifyCapsChange(TRequestStatus &, TCaps &)
IMPORT_C void	NotifyCapsChangeCancel()
IMPORT_C void	NotifyHookChangeCancel()
IMPORT_C void	NotifyIncomingCall(TRequestStatus &, TName &)
IMPORT_C void	NotifyIncomingCallCancel()
IMPORT_C void	NotifyStatusChange(TRequestStatus &, RCall::TStatus &)
IMPORT_C void	NotifyStatusChangeCancel()
IMPORT_C TInt	Open(RPhone &, const TDesC &)
IMPORT_C TInt	Open(RTelServer &, const TDesC &)

Protected Member Functions
IMPORT_C void	ConstructL()
IMPORT_C void	Destruct()

Inherited Functions
	RSubSessionBase::CloseSubSession(TInt)
	RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::RSubSessionBase()
	RSubSessionBase::Send(TInt)const
	RSubSessionBase::Send(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt)const
	RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSubSessionBase::Session()const
	RSubSessionBase::SubSessionHandle()const
	RTelSubSessionBase::Blank(const TInt,TReqPriorityType)const
	RTelSubSessionBase::Blank(const TInt,TRequestStatus &,TReqPriorityType)const
	RTelSubSessionBase::CancelAsyncRequest(TInt)const
	RTelSubSessionBase::CancelReq(const TInt,const TInt)const
	RTelSubSessionBase::CancelSubSession()const
	RTelSubSessionBase::Get(const TInt,TDes16 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TDes8 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TDes8 &,TDes8 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TDes8 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TRequestStatus &,TDes16 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TRequestStatus &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TRequestStatus &,TDes8 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TRequestStatus &,TDes8 &,TDes8 &,TReqPriorityType)const
	RTelSubSessionBase::Get(const TInt,TRequestStatus &,TDes8 &,TReqPriorityType)const
	RTelSubSessionBase::RTelSubSessionBase()
	RTelSubSessionBase::ResetSessionHandle()
	RTelSubSessionBase::SessionHandle()const
	RTelSubSessionBase::Set(const TInt,TRequestStatus &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,TRequestStatus &,const TDesC16 &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,TRequestStatus &,const TDesC8 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,TRequestStatus &,const TDesC8 &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,TRequestStatus &,const TDesC8 &,const TDesC8 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const RFile &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const TDesC16 &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const TDesC8 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const TDesC8 &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::Set(const TInt,const TDesC8 &,const TDesC8 &,TReqPriorityType)const
	RTelSubSessionBase::SetAndGet(const TInt,TRequestStatus &,TDes8 &,const TDesC16 &,TReqPriorityType)const
	RTelSubSessionBase::SetAndGet(const TInt,TRequestStatus &,const TDesC16 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::SetAndGet(const TInt,TRequestStatus &,const TDesC8 &,TDes16 &,TReqPriorityType)const
	RTelSubSessionBase::SetAndGet(const TInt,TRequestStatus &,const TDesC8 &,TDes8 &,TReqPriorityType)const
	RTelSubSessionBase::SetSessionHandle(RSessionBase &)
	RTelSubSessionBase::SubSessionHandle()

Public Member Enumerations
enum	TCapsFlags { KCapsData = 0x00000001, KCapsFax = 0x00000002, KCapsVoice = 0x00000004, KCapsEventIncomingCall = 0x00010000 }

Inherited Enumerations
	RTelSubSessionBase:TReqPriorityType

Inherited Attributes
	RTelSubSessionBase::iPtrHolder

Constructor & Destructor Documentation

RLine()

IMPORT_C

RLine

(

)

Constructs an empty default constructor which is present only to support virtual function table export.

Member Functions Documentation

Close()

IMPORT_C void

(

)

ConstructL()

IMPORT_C void

ConstructL

(

)

[protected, virtual]

capability: None

Destruct()

IMPORT_C void

Destruct

(

)

[protected, virtual]

capability: None

EnumerateCall(TInt &)

IMPORT_C TInt

EnumerateCall

(

TInt &

aCount

)

const

Gets the number of calls opened from a line.

capability: None

Parameters

TInt & aCount

On return, contains the number of calls opened from the line.

GetCallInfo(TInt, TCallInfo &)

IMPORT_C TInt	GetCallInfo	(	TInt	aIndex,
			TCallInfo &	aCallInfo
		)	const

Gets enough information about a call to differentiate it from other calls on the line.

capability: None

Parameters

TInt aIndex	The index of the call for which information is to be obtained.
TCallInfo & aCallInfo	On return, contains the call information.

GetCaps(TCaps &)

IMPORT_C TInt

GetCaps

(

TCaps &

aCaps

)

const

Gets the line capabilities.

capability: None

Parameters

TCaps & aCaps

On return, contains the line capabilities.

GetHookStatus(RCall::THookStatus &)

IMPORT_C TInt

GetHookStatus

(

RCall::THookStatus &

aHookStatus

)

const

Parameters

RCall::THookStatus & aHookStatus

GetInfo(TLineInfo &)

IMPORT_C TInt

GetInfo

(

TLineInfo &

aLineInfo

)

const

Gets a snapshot of the current line information.

capability: None

Parameters

TLineInfo & aLineInfo

On return, contains the current line information

GetStatus(RCall::TStatus &)

IMPORT_C TInt

GetStatus

(

RCall::TStatus &

aStatus

)

const

Gets line status information.

capability: None

Parameters

RCall::TStatus & aStatus

On return, contains the line status.

NotifyCallAddedCancel()

IMPORT_C void

NotifyCallAddedCancel

(

)

const

Cancels an outstanding 'new call added' notification request, placed using the NotifyCallAdded() function.

capability: None

NotifyCapsChange(TRequestStatus &, TCaps &)

IMPORT_C void	NotifyCapsChange	(	TRequestStatus &	aStatus,
			TCaps &	aCaps
		)

Provides notification of a change in the line capabilities.

capability: None

Parameters

TRequestStatus & aStatus	A variable that indicates the completion status of the request.
TCaps & aCaps	On request completion, contains the new line capabilities

NotifyCapsChangeCancel()

IMPORT_C void

NotifyCapsChangeCancel

(

)

const

Cancels an "line capabilities change" notification request, placed using the NotifyCapsChange() function.

capability: None

NotifyHookChangeCancel()

IMPORT_C void

NotifyHookChangeCancel

(

)

const

Cancels an outstanding hook change notification request, placed using the NotifyHookChange() function.

capability: None

NotifyIncomingCall(TRequestStatus &, TName &)

IMPORT_C void	NotifyIncomingCall	(	TRequestStatus &	aStatus,
			TName &	aName
		)

Provides notification to a client when an incoming call is detected.

If there is no outstanding request to answer the next call, a call is automatically created by the server and its name is passed back to the client.

capability: None

Parameters

TRequestStatus & aStatus	A variable that indicates the completion status of the request.
TName & aName	On request completion, contains the name of the incoming call.

NotifyIncomingCallCancel()

IMPORT_C void

NotifyIncomingCallCancel

(

)

const

Cancels an outstanding incoming call notification, placed with the NotifyIncomingCall() function.

capability: None

NotifyStatusChange(TRequestStatus &, RCall::TStatus &)

IMPORT_C void	NotifyStatusChange	(	TRequestStatus &	aStatus,
			RCall::TStatus &	aLineStatus
		)

Provides notification about a change in the line status.

capability: None

Parameters

TRequestStatus & aStatus	A variable that indicates the completion status of the request.
RCall::TStatus & aLineStatus	On request completion, contains the new line status.

NotifyStatusChangeCancel()

IMPORT_C void

NotifyStatusChangeCancel

(

)

const

Cancels an outstanding line status change notification request, placed using the NotifyStatusChange() function.

capability: None

Open(RPhone &, const TDesC &)

IMPORT_C TInt	Open	(	RPhone &	aPhone,
			const TDesC &	aName
		)

Parameters

RPhone & aPhone
const TDesC & aName

Open(RTelServer &, const TDesC &)

IMPORT_C TInt	Open	(	RTelServer &	aServer,
			const TDesC &	aName
		)

Parameters

RTelServer & aServer
const TDesC & aName

Member Enumerations Documentation

Enum TCapsFlags

Line capability flags.

Enumerators

KCapsData = 0x00000001	The line supports data connections.
KCapsFax = 0x00000002	The line supports fax connections.
KCapsVoice = 0x00000004	The line supports voice connections.
KCapsEventIncomingCall = 0x00010000	The line supports incoming call notification requests.