IClientLinePub Interface Reference

import "CLMgrPub.idl";

Inheritance diagram for IClientLinePub:

Public Member Functions
HRESULT	PubHookOff ()
HRESULT	PubHookOn ()
HRESULT	PubPressHook ()
HRESULT	PubDial ([in] BSTR dialstring)
HRESULT	PubHold ()
HRESULT	PubActivate ()
HRESULT	PubDirectCall ()
HRESULT	PubJoinConference ([in] IClientLinePub *pIConferenceLine)
HRESULT	PubTransferCall ([in] IClientLinePub *pITargetLine)
HRESULT	PubForwardCall ([in] BSTR dialstring)
HRESULT	PubGetState ([out] long *piState)
HRESULT	PubGetDetails ([out] PubCLMgrLineDetails *pDetails)
HRESULT	PubGetLastCallDetails ([out] PubCLMgrCallDetails *pDetails)
HRESULT	PubGetIncomingExtension ([out] BSTR *pExtension)
HRESULT	PubGetOutgoingExtension ([out] BSTR *pExtension)

Detailed Description

Line interface; encapsulates handling of a single line

Use this interface from C++ clients

Member Function Documentation

PubActivate()

HRESULT IClientLinePub::PubActivate

(

)

reactive a line that is currently on hold line is selected automatically, an other active line will be set to hold function call will be handled asynchronous, return code S_OK does not guarantee success if successful, we will get message "PubCLMgrLineStateChangedMessage" and property "PubState" will contain new state

PubDial()

HRESULT IClientLinePub::PubDial

(

[in] BSTR

dialstring

)

dial given dialstring, or send that string as DTMF signal (if connected) function call will be handled asynchronous, return code S_OK does not guarantee success if successful, we get message "PubCLMgrLineDetailsChangedMessage" and property "PubAcknowledgedDialstring" will contain dialstring that has been dialed so far and property "PubState" will contain new state

PubDirectCall()

HRESULT IClientLinePub::PubDirectCall

(

)

line is alerting: connect in direct call mode function call will be handled asynchronous, return code S_OK does not guarantee success if successful, we will get message "PubCLMgrLineStateChangedMessage" and property "PubState" will contain new state

not yet implemented

PubForwardCall()

HRESULT IClientLinePub::PubForwardCall

(

[in] BSTR

dialstring

)

Forward an established call to a specified dialnumber function call will be handled asynchronous, return code S_OK does not guarantee success if successful, we will get message "PubCLMgrLineStateChangedMessage" and property "PubState" will contain new state

PubGetDetails()

HRESULT IClientLinePub::PubGetDetails

(

[out] PubCLMgrLineDetails *

pDetails

)

get details of line

PubGetIncomingExtension()

HRESULT IClientLinePub::PubGetIncomingExtension

(

[out] BSTR *

pExtension

)

Get configured extension for incoming calls on this line returns empty string if we accept calls for any extension

PubGetLastCallDetails()

HRESULT IClientLinePub::PubGetLastCallDetails

(

[out] PubCLMgrCallDetails *

pDetails

)

Get details of last call

PubGetOutgoingExtension()

HRESULT IClientLinePub::PubGetOutgoingExtension

(

[out] BSTR *

pExtension

)

Get configured extension used for outgoing calls on this line

PubGetState()

HRESULT IClientLinePub::PubGetState

(

[out] long *

piState

)

get state of that line
we will notified about changed state with message "PubCLMgrLineStateChangedMessage"
possible states are:

//line states
typedef enum
{
    PubLSNone=-1,                  //unknown, not defined
    PubLSInactive=0,               //line is inactive
    PubLSHookOffInternal,          //off hook, internal dialtone
    PubLSHookOffExternal,          //off hook, external dialtone
    PubLSRinging,                  //incoming call, ringing
    PubLSDialing,                  //outgoing call, we are dialing, no sound
    PubLSAlerting,                 //outgoing call, alerting = ringing on destination
    PubLSKnocking,                 //outgoing call, knocking = second call ringing on destination
    PubLSBusy,                     //outgoing call, destination is busy, reason given in property "PubDiscReason"
    PubLSActive,                   //incoming / outgoing call, logical and physical connection is established
    PubLSOnHold,                   //incoming / outgoing call, logical connection is established, destination gets music on hold
    PubLSConferenceActive,         //incoming / outgoing conference, logical and physical connection is established
    PubLSConferenceOnHold,         //incoming / outgoing conference, logical connection is established, not physcically connected
    PubLSTerminated,               //incoming / outgoing connection / call has been disconnected,
                                   //reason given in property "PubDiscReason"
    PubLSDirectCall                //incoming call, logical and physical connection is established but micro is muted
} PubCLMgrLineStates;

PubHold()

HRESULT IClientLinePub::PubHold

(

)

set an active line on hold, does not activate an other line function call will be handled asynchronous, return code S_OK does not guarantee success if successful, we will get message "PubCLMgrLineStateChangedMessage" and property "PubState" will contain new state

PubHookOff()

HRESULT IClientLinePub::PubHookOff

(

)

hook up before dialing or pick up incoming call function call will be handled asynchronous, return code S_OK does not guarantee success if successful, we will get message "PubCLMgrLineStateChangedMessage" and property "PubState" will contain new state

PubHookOn()

HRESULT IClientLinePub::PubHookOn

(

)

hook on, disconnect call, reject incoming call function call will be handled asynchronous, return code S_OK does not guarantee success if successful, we will get message "PubCLMgrLineStateChangedMessage" and property "PubState" will contain new state

PubJoinConference()

HRESULT IClientLinePub::PubJoinConference

(

[in] IClientLinePub *

pIConferenceLine

)

Add this line to a conference / connection on given line (pConferenceLine). If connection on pConferenceLine was not yet a conference, it will be transferred into a conference. This line will be disconnected afterwards. function call will be handled asynchronous, return code S_OK does not guarantee success if successful, we will get message "PubCLMgrLineStateChangedMessage" and property "PubState" will contain new state

not yet implemented

PubPressHook()

HRESULT IClientLinePub::PubPressHook

(

)

Press hook (hook on, and if handset is offhook, hook off again) function call will be handled asynchronous, return code S_OK does not guarantee success if successful, we will get message "PubCLMgrLineStateChangedMessage" and property "PubState" will contain new state

PubTransferCall()

HRESULT IClientLinePub::PubTransferCall

(

[in] IClientLinePub *

pITargetLine

)

Transfer the connection from this line to line given in pTargetLine. Both lines will be disconnected on this client, and both peers will be connected afterwards. function call will be handled asynchronous, return code S_OK does not guarantee success if successful, we will get message "PubCLMgrLineStateChangedMessage" and property "PubState" will contain new state

---

The documentation for this interface was generated from the following file:

• CLMgrPub.idl