![[Index]](../../../stock/btn_index.gif){kind=small}
![[Glossary]](../../../stock/btn_glossary.gif){kind=small}
![[Previous]](../../../stock/btn_prev.gif){kind=small}
![[Next]](../../../stock/btn_next.gif){kind=small}
| |
|
| |
Location:
etel.h
Link against: etel.lib
RLine
Supported from 5.0
Provides access to the functionality associated with a specific line.
This class is not intended for user derivation.
|
Defined in RLine:
Close(), DeregisterNotifyCallAdded(), DeregisterNotifyStatusChange(), EnumerateCall(), GetCallInfo(), GetCaps(), GetHookStatus(), GetInfo(), GetStatus(), KCapsData, KCapsEventIncomingCall, KCapsFax, KCapsVoice, NotifyCallAdded(), NotifyCallAddedCancel(), NotifyCapsChange(), NotifyCapsChangeCancel(), NotifyHookChange(), NotifyHookChangeCancel(), NotifyIncomingCall(), NotifyIncomingCallCancel(), NotifyOnAnything(), NotifyOnAnythingCancel(), NotifyStatusChange(), NotifyStatusChangeCancel(), Open(), RLine(), RegisterNotifyCallAdded(), RegisterNotifyStatusChange(), TCallInfo, TCaps, TCapsFlags, TLineInfo, TLineNotifyInfo
RLine();
Constructs an empty default constructor which is present only to support virtual function table export.
|
TInt Open(RPhone& aPhone,const TDesC& aName);
Opens a line from a phone connection.
Note:
Opened line subsessions must be explicitly closed by
the client — a memory leak will result if the RLine object
is destroyed before the subsession is closed.
|
|
TInt Open(RTelServer& aServer,const TDesC& aName);
Opens a line from a server connection. It might be used, in preference to the previous version, when access to phone functionality is not required.
Notes:
Opened line subsessions must be explicitly closed by
the client — a memory leak will result if the RLine object
is destroyed before the subsession is closed.
The line name must be known before this function can be used. Developers intending to develop cross-platform applications should not use this function.
|
|
void Close();
Closes the line. This function must be called for all
RLine subsessions which have been opened — to
prevent memory leakage.
|
TInt GetCaps(TCaps& aCaps) const;
Gets the line capabilities.
|
|
TInt GetStatus(RCall::TStatus& aStatus) const;
Gets line status information.
|
|
TInt GetHookStatus(RCall::THookStatus& aHookStatus) const;
Gets the current hook status.
|
|
TInt EnumerateCall(TInt& aCount) const;
Gets the number of calls opened from a line.
|
|
TInt GetCallInfo(TInt aIndex,TCallInfo& aCallInfo) const;
Gets enough information about a call to differentiate it from other calls on the line.
|
|
TInt GetInfo(TLineNotifyInfo& aLineNotifyInfo) const;
Supported from 5.0
Withdrawn in 5.1
Gets a snapshot of the current line information.
|
|
TInt GetInfo(TLineInfo& aLineInfo) const;
Supported from 5.1
Gets a snapshot of the current line information.
|
|
|
void NotifyCapsChange(TRequestStatus& aStatus, TCaps& aCaps);
Provides notification of a change in the line capabilities.
|
void NotifyCapsChangeCancel() const;
Cancels an "line capabilities change" notification request, placed using
the NotifyCapsChange() function.
void NotifyOnAnything(TRequestStatus& aStatus,TLineNotifyInfo& aLineNotifyInfo);
Supported from 5.0
Withdrawn in 5.1
Provides notification of any change in the line information.
|
void NotifyOnAnythingCancel() const;
Supported from 5.0
Withdrawn in 5.1
Cancels an "any change" notification request, placed using
theNotifyOnAnything() function.
void NotifyIncomingCall(TRequestStatus& aStatus, TName& aName);
Provides notification to a client when an incoming call is detected.
Note
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.
|
void NotifyIncomingCallCancel() const;
Cancels an outstanding incoming call notification, placed with
theNotifyIncomingCall() function.
void NotifyHookChange(TRequestStatus& aStatus,RCall::THookStatus& aHookStatus);
Provides notification when the hook status changes.
|
void NotifyHookChangeCancel() const;
Cancels an outstanding hook change notification request, placed using
theNotifyHookChange() function.
TInt RegisterNotifyStatusChange(const TInt aBufferSize) const;
Supported from 5.0
Withdrawn in 5.1
Causes the server to create a buffer, specifically for the requesting client, to store line status change information. This buffer ensures that information is not lost between the completion of the client’s line status change request, and its next request being posted.
This function only creates a buffer for the notification. To actually get
the status information use
theNotifyStatusChange()function.
|
|
TInt DeregisterNotifyStatusChange() const;
Supported from 5.0
Withdrawn in 5.1
Deletes the status change notification buffer, placed using
theRegisterNotifyStatusChange() function. If a client has a status
change notification request still outstanding, it will remain
so.
|
void NotifyStatusChange(TRequestStatus& aStatus,RCall::TStatus& aLineStatus);
Provides notification about a change in the line status.
|
void NotifyStatusChangeCancel() const;
Cancels an outstanding line status change notification request, placed
using the NotifyStatusChange() function.
void NotifyCallAdded(TRequestStatus& aStatus,TName& aName);
Provides notification that a new call is being added to the line.
|
void NotifyCallAddedCancel() const;
Cancels an outstanding “new call added” notification
request, placed using
theNotifyCallAdded()function.
TInt RegisterNotifyCallAdded(const TInt aBufferSize) const;
Supported from 5.0
Withdrawn in 5.1
Causes the server to create a buffer, specifically for the requesting client, to store the notification that a new call has been added to the line. This buffer ensures that information is not lost between completion of the client’s request for notification, and its next request being posted.
|
|
TInt DeregisterNotifyCallAdded() const;
Supported from 5.0
Withdrawn in 5.1
Deletes the call added notification buffer in the server. If the client has a Call Added notification still outstanding, it will remain so.
|
|
TCapsFlags
Line capability flags.
|
|
TCaps
Line capability information.
Defined in RLine::TCaps:
iFlags
![[Top]](../../../stock/arrow_up_2.gif){kind=icon}
iFlagsTUint iFlags
Line capability flag. Contains a bitmask of the values defined in
theTCapsFlags enumeration.
TCallInfo
Line call capability information.
Defined in RLine::TCallInfo:
iCallCapsFlags, iCallName, iStatus
iCallNameTName iCallName
The name of a call.
iStatusRCall::TStatus iStatus
The call status.
iCallCapsFlagsTUint32 iCallCapsFlags
The call capabilities flag.
RLine::TLineNotifyInfo
Supported from 5.0
Withdrawn in 5.1
Collects together all the information associated with an instance of the core API line class into a single, directly accessible, structure to increase the efficiency of those applications which require access to the majority of the line’s data.
This class is not intended for user derivation.
Defined in RLine::TLineNotifyInfo:
TLineNotifyInfo(), iHookStatus, iHookStatusChanged, iNameOfCallForAnswering, iNameOfCallForAnsweringChanged, iNameOfLastCallAdded, iNameOfLastCallAddedChanged, iStatus, iStatusChanged
|
Rline::TLineNotifyInfo();
Constructs and empty trivial constructor which is present only to support virtual function table export.
|
TBool iHookStatusChanged
An indication that the hook status has changed since the last notification.
TBool iStatusChanged
An indication that the line status has changed since the last notification.
TBool iNameOfLastCallAddedChanged
An indication that a new call has been created on the line and that its
name is contained in the iNameOfLastCallAdded member
variable.
TName iNameOfCallForAnswering
The name of the call to which a new incoming call will be directed.
TBool iNameOfCallForAnsweringChanged
An indication that a new call has been assigned to answer the next incoming call.
RLine::TLineInfo
Supported from 5.1
Collects together all the information associated with an instance of the core API line class into a single, directly accessible, structure.
This increases the efficiency of those applications which require access to the majority of the line’s data.
This class is not intended for user derivation.
Defined in RLine::TLineInfo:
TLineInfo(), iHookStatus, iNameOfCallForAnswering, iNameOfLastCallAdded, iStatus
|
RLine::TLineInfo();
Constructs and empty trivial constructor which is present only to support virtual function table export.
|
TName iNameOfCallForAnswering
The name of the call to which a new incoming call will be directed.
Copyright ©2002 Symbian Ltd. 6.1-00174 |
|
![[Top]](../../../stock/arrow_up.gif){kind=icon}