![]() |
SwyxIt! Client SDK 14.20
|
import "CLMgrPub.idl";
Public Member Functions | |
HRESULT | DispHookOff () |
HRESULT | DispHookOn () |
HRESULT | DispPressHook () |
HRESULT | DispDial ([in] BSTR dialstring) |
HRESULT | DispHold () |
HRESULT | DispActivate () |
HRESULT | DispDirectCall () |
HRESULT | DispJoinConference ([in] IDispatch *pIConferenceLine) |
HRESULT | DispTransferCall ([in] IDispatch *pITargetLine) |
HRESULT | DispForwardCall ([in] BSTR dialstring) |
HRESULT | DispEnable ([in] BOOL bEnable) |
HRESULT | DispRequestCallbackAuto () |
HRESULT | DispStartRecording () |
HRESULT | DispStopRecording () |
HRESULT | DispSetMediastreamingLink ([in] BSTR MsLinkId) |
HRESULT | DispHookOffEx ([in] BSTR CallerId, [in] BOOL SuppressRedialListEntry, [in] BSTR CallerIdOverride) |
HRESULT | DispPlaySoundFile ([in] BSTR sFileName, [in] BOOL bPlayLoop, [in] int iLoopInterval) |
HRESULT | DispStopPlaySoundFile () |
HRESULT | DispRecordSoundFile ([in] BSTR sFileName, [in] BOOL bAppend) |
HRESULT | DispStopRecordSoundFile () |
HRESULT | DispSendDtmf ([in] BSTR dialstring, [in] BOOL bInband) |
HRESULT | DispSetDtmfDetectionMode ([in] long iDtmfMode) |
HRESULT | DispHookOffEx2 ([in] BSTR CallerId, [in] BOOL SuppressRedialListEntry, [in] BSTR CallerIdOverride, [in] BSTR CallerNameOverride) |
HRESULT | DispHookOnEx ([in] long iReason) |
dispatch interface for client line manager events can be used from VB clients for receiving client line manager messages via connection point Line interface; encapsulates handling of a single line
!!! This dispatch interface must be used from VB clients only !!! !!! For new versions additional functioncs might be added. This is necessary for VB clients but would cause trouble for C++ clients.
HRESULT IClientLineDisp::DispActivate | ( | ) |
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
HRESULT IClientLineDisp::DispDial | ( | [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
HRESULT IClientLineDisp::DispDirectCall | ( | ) |
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
HRESULT IClientLineDisp::DispEnable | ( | [in] BOOL | bEnable | ) |
enable / disable line for incoming calls (manual wrap up time; disabling does not start timer for automatical enabling line)
HRESULT IClientLineDisp::DispForwardCall | ( | [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
HRESULT IClientLineDisp::DispHold | ( | ) |
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
HRESULT IClientLineDisp::DispHookOff | ( | ) |
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
HRESULT IClientLineDisp::DispHookOffEx | ( | [in] BSTR | CallerId, |
[in] BOOL | SuppressRedialListEntry, | ||
[in] BSTR | CallerIdOverride ) |
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 CallerId is the own number (and therefore SIP account) to be used for this call If SuppressRedialListEntry is set to true, the next call will not be shown in the redial list
HRESULT IClientLineDisp::DispHookOffEx2 | ( | [in] BSTR | CallerId, |
[in] BOOL | SuppressRedialListEntry, | ||
[in] BSTR | CallerIdOverride, | ||
[in] BSTR | CallerNameOverride ) |
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 CallerId is the own number (and therefore SIP account) to be used for this call If SuppressRedialListEntry is set to true, the next call will not be shown in the redial list
HRESULT IClientLineDisp::DispHookOn | ( | ) |
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
HRESULT IClientLineDisp::DispHookOnEx | ( | [in] long | iReason | ) |
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
HRESULT IClientLineDisp::DispJoinConference | ( | [in] IDispatch * | 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
HRESULT IClientLineDisp::DispPlaySoundFile | ( | [in] BSTR | sFileName, |
[in] BOOL | bPlayLoop, | ||
[in] int | iLoopInterval ) |
Play soundfile using our mediastreaming Power dial mode; Sound will be heared by all lines connected to the same media streaming link
HRESULT IClientLineDisp::DispPressHook | ( | ) |
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
HRESULT IClientLineDisp::DispRecordSoundFile | ( | [in] BSTR | sFileName, |
[in] BOOL | bAppend ) |
Record soundfile using our mediastreaming Power dial mode; Record all sound from all lines connected to the same media streaming link
HRESULT IClientLineDisp::DispRequestCallbackAuto | ( | ) |
request callback depending on line state if destination is busy or if it is a second call, we will do a callback on busy in all other cases we will request a callback
HRESULT IClientLineDisp::DispSendDtmf | ( | [in] BSTR | dialstring, |
[in] BOOL | bInband ) |
Action from client: dial given dialstring, or send that string as DTMF signal calls state machine
HRESULT IClientLineDisp::DispSetDtmfDetectionMode | ( | [in] long | iDtmfMode | ) |
None = 0 -> use default from SIP account resp. InfoMethod_DtmfRelay for SwyxIt! Rfc2833_Event = 1 -> DTMF via RTP according to RFC 2833, Rfc2833_Wave (not supported) InfoMethod_DtmfRelay = 3 -> DTMF via SIP info messages (used in SwyxWare) Inband = 4 -> DTMF as inband tones
HRESULT IClientLineDisp::DispSetMediastreamingLink | ( | [in] BSTR | MsLinkId | ) |
Power dial mode, link the media streaming of this line to media streaming link object given by its GUID Reset the linkage by setting MsLinkId to NULL or ""
HRESULT IClientLineDisp::DispStartRecording | ( | ) |
record current conversation file name will be build of own extension, peer extension / name and timestamp location depends on configuration depending on configuration, inquiry calls will be recorded into same file or different file
HRESULT IClientLineDisp::DispStopPlaySoundFile | ( | ) |
Stop Play soundfile
HRESULT IClientLineDisp::DispStopRecording | ( | ) |
stop recording of current conversation
HRESULT IClientLineDisp::DispStopRecordSoundFile | ( | ) |
Stop Record soundfile
HRESULT IClientLineDisp::DispTransferCall | ( | [in] IDispatch * | 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
|
getproperty |
dialstring that has been acknowledged by server so far we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
extension of called line (incoming call: one of our own extensions, or in case of a group call the group extension) we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
name of called PBX user (incoming call: our name, or in case of a group call the group name) we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
get call history collection
|
getproperty |
Unique call id (valid only for incoming calls); will be 0 for outgoing calls
|
getproperty |
this call was redirected (incoming and outgoing) we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
get details of that line
|
getproperty |
string containing charging information we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
end time of current connection we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
start time of current connection we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
name of called PBX user (incoming call: our name, or in case of a group call the group name) we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
name of called PBX user (incoming call: our name, or in case of a group call the group name) we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
name of called PBX user (incoming call: our name, or in case of a group call the group name) we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
encryption mode of current call we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
name of called PBX user (incoming call: our name, or in case of a group call the group name) we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
disconnect reason we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage" reason for disconnect on line states "PubLSBusy" and "PubLSTerminated" possible reasons:
* typedef enum * { * PubSCl3DRNormal, //nothing special * PubSCl3DRBusy, //peer was busy * PubSCl3DRRejected, //peer rejected call * PubSCl3DRCancelled, //call was cancelled * PubSCl3DRTransferred, //call was transferred (connect to peers with "PubTransferCall") * PubSCl3DRJoinedConference, //call was added to conference on other line with "PubJoinConference" * PubSCl3DRNoAnswer, //peer did not pick up, timeout * PubSCl3DRTooLate, //call was already picked up from other phone * PubSCl3DRDirectCallImpossible, //direct call to peer was not allowed * PubSCl3DRWrongNumber, //invalid number was dialed * PubSCl3DRUnreachable, //destination is unreachable * PubSCl3DRCallDiverted, //call was redirected * PubSCl3DRCallRoutingFailed, //call routing failed, possible script error (script of peer) * PubSCl3DRPermissionDenied, //permission for call was denied due to call restrictions (e.g. no long distance call allowed) * PubSCl3DRNetworkCongestion, //no line available (public ISDN network) * PubSCl3DRNoChannelAvailable, //no gateway channel available * PubSCl3DRNumberChanged, //number of destination has changed * PubSCl3DRIncompatibleDestination, //destination is incompatible (compression) * } PubSCl3DiscReason; *
|
getproperty |
Get configured extension for incoming calls on this line returns empty string if we accept calls for any extension
|
getproperty |
Get configured extension used for outgoing calls on this line
|
getproperty |
codec of current call
|
getproperty |
this call ought to be a direct call we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage" not implemented in SwyxWare 2.0, will always be FALSE
|
getproperty |
this call was a directed to the whole group we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
is current call incoming or outgoing?
|
getproperty |
extension of called line (incoming call: one of our own extensions, or in case of a group call the group extension) we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
name of called PBX user (incoming call: our name, or in case of a group call the group name) we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
charging of last call we will notified about changed data with message "PubCLMgrCallDetailsMessage"
|
getproperty |
disconnect reason we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage" reason for disconnect on line states "PubLSBusy" and "PubLSTerminated" possible reasons:
* typedef enum * { * PubSCl3DRNormal, //nothing special * PubSCl3DRBusy, //peer was busy * PubSCl3DRRejected, //peer rejected call * PubSCl3DRCancelled, //call was cancelled * PubSCl3DRTransferred, //call was transferred (connect to peers with "PubTransferCall") * PubSCl3DRJoinedConference, //call was added to conference on other line with "PubJoinConference" * PubSCl3DRNoAnswer, //peer did not pick up, timeout * PubSCl3DRTooLate, //call was already picked up from other phone * PubSCl3DRDirectCallImpossible, //direct call to peer was not allowed * PubSCl3DRWrongNumber, //invalid number was dialed * PubSCl3DRUnreachable, //destination is unreachable * PubSCl3DRCallDiverted, //call was redirected * PubSCl3DRCallRoutingFailed, //call routing failed, possible script error (script of peer) * PubSCl3DRPermissionDenied, //permission for call was denied due to call restrictions (e.g. no long distance call allowed) * PubSCl3DRNetworkCongestion, //no line available (public ISDN network) * PubSCl3DRNoChannelAvailable, //no gateway channel available * PubSCl3DRNumberChanged, //number of destination has changed * PubSCl3DRIncompatibleDestination, //destination is incompatible (compression) * } PubSCl3DiscReason; *
|
getproperty |
our extension that was used for last call we will notified about changed data with message "PubCLMgrCallDetailsMessage"
|
getproperty |
end time of last call we will notified about changed data with message "PubCLMgrCallDetailsMessage"
|
getproperty |
get call history collection of last call
|
getproperty |
Unique call id of last call (valid only for incoming calls); will be 0 for outgoing calls
|
getproperty |
was last call incoming or outgoing?
|
getproperty |
Least Cost Routing prefix that has been used for last call we will notified about changed data with message "PubCLMgrCallDetailsMessage"
|
getproperty |
peer number of last call we will notified about changed data with message "PubCLMgrCallDetailsMessage"
|
getproperty |
peer name of last call we will notified about changed data with message "PubCLMgrCallDetailsMessage"
|
getproperty |
start time of last call we will notified about changed data with message "PubCLMgrCallDetailsMessage"
|
getproperty |
was last call connected?
|
getproperty |
number or participants in a conference; 0: no conference we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
name of peer, incoming and outgoing we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
phone number of peer, incoming and outgoing we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
phone number of peer, incoming and outgoing without public access prefix we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
get details of that line
|
getproperty |
get details of that line
|
getproperty |
DTMF digits received from peer
|
getproperty |
name of PBX user that forwarded this call we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
number of PBX user that forwarded this call we will notified about changed data with message "PubCLMgrLineDetailsChangedMessage"
|
getproperty |
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; *