![]() |
SwyxIt! Client SDK 14.20
|
import "CLMgrPub.idl";
Public Member Functions | |
HRESULT | DispInit ([in] BSTR ServerName, [out, retval] long *pError) |
HRESULT | DispRegisterUser ([in] BSTR UserName, [out, retval] long *pUserId) |
HRESULT | DispReleaseUser ([in] long UserId) |
HRESULT | DispSetNumberOfLines ([in] long NumberOfLines, [out, retval] long *pError) |
HRESULT | DispGetLine ([in] long iLineNumber, [out, retval] IDispatch **ppIClientLineDisp) |
HRESULT | DispSelectLineNumber ([in] long iLineNumber, [out, retval] long *pError) |
HRESULT | DispSelectLine ([in] IDispatch *pIClientLine, [out, retval] long *pError) |
HRESULT | DispSwitchToLineNumber ([in] long iLineNumber, [out, retval] long *pError) |
HRESULT | DispSwitchToLine ([in] IDispatch *pIClientLine, [out, retval] long *pError) |
HRESULT | DispRegisterMessageTarget ([in] long hWnd, [in] long dwThreadId) |
HRESULT | DispUnRegisterMessageTarget ([in] long hWnd, [in] long dwThreadId) |
HRESULT | DispPickupGroupNotificationCall ([in] long LineNumber) |
HRESULT | DispGetExtension ([in] long iIndex, [out, retval] BSTR *pExtension) |
HRESULT | DispSpeedDialName ([in] long iIndex, [out, retval] BSTR *pName) |
HRESULT | DispSpeedDialNumber ([in] long iIndex, [out, retval] BSTR *pNumber) |
HRESULT | DispSpeedDialState ([in] long iIndex, [out, retval] long *pState) |
HRESULT | DispSimpleDial ([in] BSTR dialstring) |
HRESULT | DispResolveNumber ([in] BSTR Number, [out, retval] BSTR *pName) |
HRESULT | DispConvertNumber ([in] DWORD Style, [in] BSTR NumberFrom, [out, retval] BSTR *pNumberTo) |
HRESULT | DispSimpleDialEx ([in] BSTR dialstring, [out, retval] DWORD *pdwErrorCode) |
HRESULT | DispInitEx ([in] BSTR ServerName, [in] BSTR BackupServerName, [out, retval] long *pError) |
HRESULT | DispCreateConference ([in] long iConferenceLine) |
HRESULT | DispJoinAllToConference ([in] BOOL bCreateConference) |
HRESULT | DispJoinLineToConference ([in] long iLine) |
HRESULT | DispPlaySoundFile ([in] BSTR sFileName, [in] BOOL bPlayLoop, [in] int iLoopInterval) |
HRESULT | DispStopPlaySoundFile () |
HRESULT | DispPlayToRtp ([in] BSTR sFullPath, [in] BOOL bLoop, [in] DWORD dwPause) |
HRESULT | DispStopPlayToRtp () |
HRESULT | DispRecordFromRtp ([in] BSTR sFullPath, [in] BOOL bAppend, [in] BOOL bAddLocalSounds) |
HRESULT | DispStopRecordFromRtp () |
HRESULT | DispExternalHookStateChanged ([in] BOOL bNewHookState, int iHookDeviceId) |
HRESULT | DispSkinPhoneCommand ([in] DWORD dwCommandId, [in] DWORD dwButtonId) |
HRESULT | DispSkinGetActionAreaState ([in] DWORD dwCommandId, [in] DWORD dwButtonId, [out, retval] DWORD *pdwActionAreaState) |
HRESULT | DispSkinGetInfoDetail ([in] DWORD dwDetailIndex, [out, retval] BSTR *pInfoDetail) |
HRESULT | DispPostMessage ([in] DWORD message, [in] DWORD wParam, [in] DWORD lParam) |
HRESULT | DispPickupCallbackOnBusyNotification ([in] int LineNumber) |
HRESULT | DispRejectCallbackOnBusyNotification () |
HRESULT | DispSimpleDialEx2 ([in] BSTR dialstring, [in] int LineNumber, [out, retval] DWORD *pdwErrorCode) |
HRESULT | DispRequestCallbackOnBusy ([in] BSTR PeerNumber, [in] BSTR PeerName) |
HRESULT | DispVoicemailRemoteInquiry () |
HRESULT | DispRegisterChatMessageReader ([out, retval] DWORD *dwReaderID) |
HRESULT | DispSendChatMessage ([in] unsigned long ulMessageId, [in] BSTR sMessageText, [in] BSTR sPeerName, [in] DWORD dwPeerIpAddress) |
HRESULT | DispReadChatMessage ([in] DWORD dwReaderID, [out, retval] IDispatch **pChatMessage) |
HRESULT | DispAcknowledgeChatMessage ([in] unsigned long ulMessageId, [in] BSTR sPeerName, [in] DWORD dwPeerIpAddress) |
HRESULT | DispUnRegisterChatMessageReader ([in] DWORD dwReaderID) |
HRESULT | DispSimpleDialEx3 ([in] BSTR dialstring, [in] int LineNumber, [in] BOOL bProcessNumber, [in] BSTR name, [out, retval] DWORD *pdwErrorCode) |
HRESULT | PlaySoundFileCDS ([in] BSTR FileName, [in] LONG Scope, [in] LONG Category, [in] BOOL bPlayLoop, [in] int iLoopInterval, [in] DWORD dwVolume) |
HRESULT | RecordSoundFileCDS ([in] BSTR FileName, [in] LONG Scope, [in] LONG Category, [in] BOOL IsPrivate, [in] BOOL IsHidden) |
HRESULT | PlayToRtpCDS ([in] BSTR sFileName, [in] LONG eScope, [in] LONG eCategory, [in] BOOL bLoop, [in] DWORD dwPause) |
HRESULT | RecordFromRtpCDS ([in] BSTR sFullPath, [in] LONG eScope, [in] LONG eCategory, [in] BOOL IsPrivate, [in] BOOL IsHidden, [in] BOOL bAppend, [in] BOOL bAddLocalSounds) |
HRESULT | PlaySoundFileDxExCDS ([in] BSTR sFileName, [in] LONG eScope, [in] LONG eCategory, [in] BOOL bPlayLoop, [in] int iLoopInterval, [in] int iPosition, [in] BOOL bPercent, [in] BOOL bPauseImmediately, [in] int iDevice) |
HRESULT | PlaySoundFileDxCDS ([in] BSTR sFileName, [in] LONG eScope, [in] LONG eCategory, [in] BOOL bPlayLoop, [in] int iLoopInterval) |
HRESULT | RegisterUserEx ([in] BSTR ServerName, [in] BSTR BackupServerName, [in] BSTR PbxUserName, [in] BSTR Password, [in] int iAuthenticationMode, [in] BOOL bCtiMaster, [out] BSTR *Usernames) |
HRESULT | ReleaseUserEx () |
HRESULT | ChangePbxPassword ([in] BSTR OldPassword, [in] BSTR NewPassword) |
HRESULT | DispCreateMediastreamingLink ([out, retval] BSTR *pMsLinkId) |
HRESULT | DispDeleteMediastreamingLink ([in] BSTR MsLinkId) |
HRESULT | DispSetDialerMode ([in] BOOL bEnable, [in] BSTR SLoggedInDeviceUri) |
HRESULT | FreeBusy ([in] BSTR name, [out] long *pCurrentState, [out] DATE *pCurrentStateTill, [out] long *pNextState, [out] DATE *pNextStateTill, [out, retval] BOOL *pbSucceded) |
HRESULT | ResolveRecipient ([in] BSTR searchString, [out] BSTR *resolvedName, [out] BSTR *resolvedEMailAddress, [out] BOOL *IsResolved, [out] BOOL *IsExchangeUser, [in] BOOL ShowDetails, [out, retval] BOOL *pbSucceded) |
HRESULT | CreateMeetingRequest ([in] BSTR recipient, [in] BSTR subject, [in] BSTR body, [out, retval] BOOL *pbSucceded) |
HRESULT | OpenCalendar ([in] BSTR recipient, [out, retval] BOOL *pbSucceded) |
HRESULT | CreateTaskRequest ([in] BSTR recipient, [in] BSTR subject, [in] BSTR body, [out, retval] BOOL *pbSucceded) |
HRESULT | CreateEMail ([in] BSTR recipient, [in] BSTR subject, [in] BSTR body, [out, retval] BOOL *pbSucceded) |
HRESULT | CalendarAddInSupported ([out] BOOL *bSupported) |
HRESULT | IsOfficeRunning ([out] BOOL *pbRunning) |
HRESULT | HasAppointment ([in] BSTR name, [out] DATE *pEndTime, [out] BOOL *pIsPrivate, [out] long *pType, [out] BSTR *pSubject, [out, retval] BOOL *pbSucceded) |
HRESULT | GetContactDataPlugIns ([out] VARIANT *pVal) |
HRESULT | GetContactByID ([in] BSTR bstrPluginID, [in] BSTR bstrPluginContactID, [out] VARIANT *pVal) |
HRESULT | GetSearchResultCount ([in] BSTR bstrContactPluginID, [in] BSTR bstrSearchString, [out] ULONG *pVal) |
HRESULT | SearchContacts ([in] BSTR bstrContactPluginID, [in] BSTR bstrSearchString, [out] VARIANT *pVal) |
HRESULT | GetNameKey ([in] UINT uiIndex, [in] BOOL bUseCache, [out] VARIANT *pVal) |
HRESULT | get_DispCtiSettings ([out] BSTR *szControlledNumber, [out] BOOL *bEnableDeliveryTo3pcc, [out] BOOL *bUseAsSystemPhone, [out] BOOL *bUse3pccAllowed, [out] BOOL *bUseAutopairing, [out] INT *ePubCLMgrCtiSlaveTypes, [out] BOOL *bHasFeatureSwyxCTIPlus, [out] BOOL *bHasFeatureSwyxCTI) |
HRESULT | put_DispCtiSettings ([in] BSTR szControlledNumber, [in] BOOL bEnableDeliveryTo3pcc, [in] BOOL bUseAutopairing) |
HRESULT | SaveCtiSettings () |
HRESULT | SetNameKey ([in] UINT uiIndex, [in] BOOL bApplyChanges, [in] VARIANT val) |
HRESULT | get_DispNumberHistory ([in] BSTR name, [out] BSTR *szFirstNumber, [out] BSTR *szSecondNumber, [out] BSTR *szThirdNumber, [out] BSTR *szFourthNumber, [out] BSTR *szFifthNumber) |
HRESULT | AddNumberToHistory ([in] BSTR name, [in] BSTR newVal) |
HRESULT | GetFreeBusyInfo ([in] BSTR bstrName, [in] BSTR bstrContactId, [in] BSTR bstrPluginId, [out] long *pCurrentState, [out] DATE *pCurrentStateTill, [out] long *pNextState, [out] DATE *pNextStateTill, [out, retval] BOOL *pSucceded) |
HRESULT | ResolveRecipientById ([in] BSTR bstrContactId, [in] BSTR bstrPluginId, [out] BSTR *pResolvedName, [out] BSTR *pResolvedEMailAddress, [out] BOOL *pIsResolved, [out] BOOL *pIsRealUser, [out, retval] BOOL *pSucceded) |
HRESULT | FulltextSearchInContactsEx ([in] BSTR bstrSearchText, [in] BOOL bSearchInPhonebook, [in] BOOL bSearchInPlugins, [in] BOOL bSearchInNumbers, [out] IDispatch **ppSearchResultCollection, [out, retval] BOOL *pbSucceeded) |
HRESULT | ValidateCtiSettings ([in] BSTR controlledNumber,[out] PubCLMgrCtiValidation *ctiValidation) |
HRESULT | ShowContactEx ([in] BSTR bstrContactId, [in] BSTR bstrPluginId, [in] BSTR bstrName, [in] BSTR bstrNumber, [in] BOOL bCreateIfNotExists, [out, retval] BOOL *pSucceded) |
HRESULT | RegisterUserEx4UC ([in] BSTR ServerName, [in] BSTR BackupServerName, [in] BSTR PbxUserName, [in] BSTR Password, [in] int iAuthenticationMode, [in] BOOL bCtiMaster, [out] BSTR *Usernames, [in] VARIANT vStatusNames) |
HRESULT | RegisterUserConnector4UC ([in] int iConnectorConfig, [in] int iCertificateConfig, [in] BSTR PublicServerName, [in] BSTR PublicBackupServerName, [in, out] VARIANT *pvThumbprint, [in] BSTR ServerName, [in] BSTR BackupServerName, [in] BSTR PbxUserName, [in] BSTR Password, [in] int iAuthenticationMode, [in] BOOL bCtiMaster, [out] BSTR *Usernames, [in] VARIANT vStatusNames) |
HRESULT | GetCertificateThumbprint ([out] VARIANT *pvThumbprint) |
HRESULT | SendClientRegisterRequest ([in] int iRegisteringEntity) |
HRESULT | CstaPhonePairingList ([out] VARIANT *pListName, [out] VARIANT *pValListId) |
HRESULT | StopCstaSession () |
HRESULT | SaveCstaPairing ([in] BSTR deviceId) |
HRESULT | StopCstaMonitor () |
HRESULT | IsCstaMonitorStarted ([out, retval] BOOL *pVal) |
HRESULT | StartCstaMonitor ([in] BSTR deviceId) |
HRESULT | StartCstaSession ([out, retval] BOOL *pVal) |
HRESULT | GetCstaPairing ([out, retval] BSTR *pVal) |
HRESULT | IsDcf2CstaPairing ([out, retval] BOOL *pVal) |
HRESULT | SaveCtiPairing ([in] BSTR deviceId) |
HRESULT | SetUnreadInstantMessageCount ([in] DWORD dwUnreadMessages) |
HRESULT | GetUserAppearances ([out, retval] IDispatch **ppUserAppearances) |
HRESULT | GetUserIdByPhoneNumber ([in] BSTR phoneNumber, [out] int *piSiteId, [out] int *piUserId) |
HRESULT | IsClientPopUpAndNotificationAllowed ([out, retval] BOOL *pVal) |
HRESULT | SaveRcClientCertificate ([in] VARIANT Certificate, [in] BSTR Password) |
HRESULT | GetRcEndpoints ([out] BSTR *pszPublicAuthServer, [out] BSTR *pszPublicFallbackAuthServer, [out] BSTR *pszPublicRcServer, [out] BSTR *pszPublicFallbackRcServer) |
HRESULT | OpenClientUiDialog ([in] DWORD dwDialogId) |
HRESULT | DoneWithModalUiDialog ([in] DWORD dwDialogId) |
HRESULT | GetUserPhoneBookStatus ([in] int iSiteId, [in] int iUserId, [out] int *piStatus, [out] BSTR *pszFreeText) |
HRESULT | GetUserPhoneCallbackEnumerator ([out, retval] IDispatch **ppVal) |
HRESULT | IsTerminalServer ([out, retval] BOOL *pVal) |
Line manager interface Handles connection to server and selection of lines,
!!! 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 IClientLineMgrDisp::AddNumberToHistory | ( | [in] BSTR | name, |
[in] BSTR | newVal ) |
HRESULT IClientLineMgrDisp::CalendarAddInSupported | ( | [out] BOOL * | bSupported | ) |
CalendarAddInSupported Checks if the line manager has loaded one or more Add Ins supporting ICalenderSearchAddIn and writes TRUE to bSupported if it is so
HRESULT IClientLineMgrDisp::ChangePbxPassword | ( | [in] BSTR | OldPassword, |
[in] BSTR | NewPassword ) |
Change PBX password
HRESULT IClientLineMgrDisp::CreateEMail | ( | [in] BSTR | recipient, |
[in] BSTR | subject, | ||
[in] BSTR | body, | ||
[out, retval] BOOL * | pbSucceded ) |
HRESULT IClientLineMgrDisp::CreateMeetingRequest | ( | [in] BSTR | recipient, |
[in] BSTR | subject, | ||
[in] BSTR | body, | ||
[out, retval] BOOL * | pbSucceded ) |
HRESULT IClientLineMgrDisp::CreateTaskRequest | ( | [in] BSTR | recipient, |
[in] BSTR | subject, | ||
[in] BSTR | body, | ||
[out, retval] BOOL * | pbSucceded ) |
HRESULT IClientLineMgrDisp::CstaPhonePairingList | ( | [out] VARIANT * | pListName, |
[out] VARIANT * | pValListId ) |
CstaPhonePairingList retrieves a list of available CTI devices (Display Names)
HRESULT IClientLineMgrDisp::DispAcknowledgeChatMessage | ( | [in] unsigned long | ulMessageId, |
[in] BSTR | sPeerName, | ||
[in] DWORD | dwPeerIpAddress ) |
Acknowledge read chat message, use m_ulMessageId from the message to be confirmed
HRESULT IClientLineMgrDisp::DispConvertNumber | ( | [in] DWORD | Style, |
[in] BSTR | NumberFrom, | ||
[out, retval] BSTR * | pNumberTo ) |
This method will convert a phone number to a different format
requested style:
* typedef enum * { * PubCLMgrNumberStyleFull, //e.g. 0004923147770 or 0023147770 * PubCLMgrNumberStylePlain, //e.g. 4923147770 or 23147770 * PubCLMgrNumberStyleCanonical //e.g. +49 (231) 47770 or +49 (231) 4777-0 * PubCLMgrNumberStyleFullPublic //e.g. 004923147770 or 023147770 * } PubCLMgrNumberStyle; *
Full number: 0023147770 Canonical number: +49 (231) 4777-0 or +49 (231) 47770 (the extension cannot be detected automatically)
HRESULT IClientLineMgrDisp::DispCreateConference | ( | [in] long | iConferenceLine | ) |
Create new conference If iConferenceLine == -1, active line or first line on hold will become conference line. Otherwise iConferenceLine indicicates the line that will become the conference line The chosen line must be active or on hold.
|
property |
Power dial mode only Create a media streaming link object for linking the RTP connections of multiple lines in power dial mode Returns an GUID as reference for the created object. This GUID can passed to multiple lines for connecting the media streaming
HRESULT IClientLineMgrDisp::DispDeleteMediastreamingLink | ( | [in] BSTR | MsLinkId | ) |
Power dial mode only Delete a media streaming link object given by its GUID. The GUID should not passed to lines afterwards.
HRESULT IClientLineMgrDisp::DispExternalHookStateChanged | ( | [in] BOOL | bNewHookState, |
int | iHookDeviceId ) |
Signal changed hookstate to line manager bNewHookState will be the new hook state. TRUE: off hook
HRESULT IClientLineMgrDisp::DispGetExtension | ( | [in] long | iIndex, |
[out, retval] BSTR * | pExtension ) |
Get configured extension with index i
HRESULT IClientLineMgrDisp::DispGetLine | ( | [in] long | iLineNumber, |
[out, retval] IDispatch ** | ppIClientLineDisp ) |
Get interface pointer to specified line object if *ppIClientLinePub==NULL the line is not available
HRESULT IClientLineMgrDisp::DispInit | ( | [in] BSTR | ServerName, |
[out, retval] long * | pError ) |
!!! depcreated function! Use IClientLineMgrDisp::RegisterUserEx !!!
HRESULT IClientLineMgrDisp::DispInitEx | ( | [in] BSTR | ServerName, |
[in] BSTR | BackupServerName, | ||
[out, retval] long * | pError ) |
!!! depcreated function! Use IClientLineMgrDisp::RegisterUserEx !!!
HRESULT IClientLineMgrDisp::DispJoinAllToConference | ( | [in] BOOL | bCreateConference | ) |
Add all active and onhold line to a conference. If bCreateConference==TRUE, a new conference will be created if there is currently no conference
HRESULT IClientLineMgrDisp::DispJoinLineToConference | ( | [in] long | iLine | ) |
Add requested line (zero based index) to running conference
HRESULT IClientLineMgrDisp::DispPickupCallbackOnBusyNotification | ( | [in] int | LineNumber | ) |
pickup callback on busy -> retry calling on specified line line = -1 if line does not matter -> select first inactive line
HRESULT IClientLineMgrDisp::DispPickupGroupNotificationCall | ( | [in] long | LineNumber | ) |
pickup group call on specified line set line = -1 if line does not matter -> select first inactive line
HRESULT IClientLineMgrDisp::DispPlaySoundFile | ( | [in] BSTR | sFileName, |
[in] BOOL | bPlayLoop, | ||
[in] int | iLoopInterval ) |
Play soundfile using our mediastreaming The file will be heared locally and remote (if in a phone call and voice connection is established, so not on hold) sFileName: full path of the file to be played bPlayLoop: if TRUE, the file will be played repeatedly iLoopInterval: time interval (Seconds) between loops; ignored if bPlayLoop==FALSE
HRESULT IClientLineMgrDisp::DispPlayToRtp | ( | [in] BSTR | sFullPath, |
[in] BOOL | bLoop, | ||
[in] DWORD | dwPause ) |
Play soundfile using our mediastreaming The file will be heared only remote (if in a phone call and voice connection is established, so not on hold) The function may be called any time, it is not related to a certain connection or line. If lines are switched, the playback will proceed.
sFullPath: Full file name bLoop: if TRUE, the file is played in loop, otherwise it is played once dwPause: if playing in loop, this parameter gives the pause beween loops, milliseconds
HRESULT IClientLineMgrDisp::DispPostMessage | ( | [in] DWORD | message, |
[in] DWORD | wParam, | ||
[in] DWORD | lParam ) |
Signal window message through line manager to SwyxIt! (will be handled by GUI)
HRESULT IClientLineMgrDisp::DispReadChatMessage | ( | [in] DWORD | dwReaderID, |
[out, retval] IDispatch ** | pChatMessage ) |
Read chat message. m_sPeerName is the originators username on the IPPBX server m_dwPeerIpAddress the IP address of the originator
* typedef struct * { * unsigned long m_ulMessageId; * BSTR m_sMessageText; * BSTR m_sPeerName; * DWORD m_dwPeerIpAddress; * } CLMgrChatMsg; *
HRESULT IClientLineMgrDisp::DispRecordFromRtp | ( | [in] BSTR | sFullPath, |
[in] BOOL | bAppend, | ||
[in] BOOL | bAddLocalSounds ) |
Record the incoming voice (RTP) stream of an active connection. The local (own) voice stream is not recorded. Only local sounds (dial tone, alerting, etc.) can be recorded as well. The function may be called any time, it is not related to a certain connection or line. If lines are switched, the recording will proceed.
sFullPath: Full file name bAppend: if TRUE, the file is appended; otherwise the file is overwritten if it exists bAddLocalSounds: if TRUE, local notification sounds are recorded too; otherwise only the RTP stream is recorded
HRESULT IClientLineMgrDisp::DispRegisterChatMessageReader | ( | [out, retval] DWORD * | dwReaderID | ) |
Register as receiver for chat messages The line manager will create a message queue for each interested client. When a new message is available, the line manager will send the CLMgrChatMessage message, the client then can retreive the message. A client that has displayed the message should acknowledge the received message. An acknlowledged message will be signaled to the sender as a CLMgrChatMessageAck message When no longer interested in chat messages, the client should release the queue by calling UnRegisterChatMessageReader
HRESULT IClientLineMgrDisp::DispRegisterMessageTarget | ( | [in] long | hWnd, |
[in] long | dwThreadId ) |
register thread / window for window messages client line manager will signal events to us by sending windows messages to a given window or thread in order to receive events you need to capture the windows message id as returned by RegisterWindowMessage(_T("WM_LineMgrNotification")); in order to have the messages send to a window, register the window handle in order to have the messages send to a certain thread, register its thread id
possible messages are:
* //message parameters for state information from line manager to client, * //send as wParam of RegisterWindowMessage(_T("WM_LineMgrNotification") * typedef enum * { * PubCLMgrLineStateChangedMessage=0, //state of a line has changed * //lParam: index of line * PubCLMgrLineSelectionChangedMessage, //line selection has changed, new line in focus * //lParam: index of now selected line * PubCLMgrLineDetailsChangedMessage, //details of line has changed * //lParam: index of line * PubCLMgrUserDataChangedMessage, //user configuration has changed * PubCLMgrCallDetailsMessage, //details of last call are available, after disconnect, for logging purpose * //lParam: index of line * PubCLMgrServerDownMessage, //server is down, will be rebooted, ... * //-> keep interfaces to line manager, wait for ServerUp message * PubCLMgrServerUpMessage, //server is up again -> keep interfaces to line manger * PubCLMgrWaveDeviceChanged, //speaker and / or micro has been switched on or off * //lParam: 0:no problem * //lParam: 1:there was an error, could not enable micro or speaker * PubCLMgrGroupCallNotificationMessage, //notification about signaled call we could pick up now * //lParam: 1:signaled call available * //lParam: 0:signaled call not available / no longer available * PubCLMgrNameKeyStateChangedMessage, //notification about changed namekey state * //lParam: index of namekey that has new state * PubCLMgrNumberOfLinesChangedMessage, //the number of lines has changed * //lParam: new number of lines * PubCLMgrClientShutDownRequest, //Client Line Manager requests client to shutdown and release all interfaces * PubCLMgrPowerSuspendMessage, //client machine goes to hibernate or suspend mode * //-> keep interfaces to line manager, wait for PowerResume message * PubCLMgrPowerResumeMessage, //client machine has returned from suspend mode -> keep interfaces to line manager * PubCLMgrHandsetStateChangedMessage, //state of handset has changed * //lParam: new handset state 0 = on hook, 1 = off hook * PubCLMgrCallbackOnBusyNotification, //informing clients about available callback on busy * PubCLMgrAsyncErrorMessage //error message for reporting problems that occured within state machine / were reported by server * //lParam will contain the error code * } PubCLMgrMessages; * *
HRESULT IClientLineMgrDisp::DispRegisterUser | ( | [in] BSTR | UserName, |
[out, retval] long * | pUserId ) |
!!! depcreated function! Use IClientLineMgrDisp::RegisterUserEx !!!
HRESULT IClientLineMgrDisp::DispRejectCallbackOnBusyNotification | ( | ) |
reject callback on busy -> do not retry calling, stop notification
HRESULT IClientLineMgrDisp::DispReleaseUser | ( | [in] long | UserId | ) |
!!! depcreated function! Use IClientLineMgrDisp::ReleaseUserEx !!!
HRESULT IClientLineMgrDisp::DispRequestCallbackOnBusy | ( | [in] BSTR | PeerNumber, |
[in] BSTR | PeerName ) |
request callback on busy: peer is busy, server will notify us as soon as peer is no more busy peer will not get any info about RequestCallbackOnBusy The peer number is important here; the name will be used for display during callback signaling
HRESULT IClientLineMgrDisp::DispResolveNumber | ( | [in] BSTR | Number, |
[out, retval] BSTR * | pName ) |
This method will resolve a phone number to a name
Input: Number Output: Name. If the number can be resolved, *pName is the resolved name and the HRESULT is S_OK. If the number cannot be resolved, *pName is set to NULL and the HRESULT is S_FALSE. If Number is NULL or pName is NULL, HRESULT will be E_INVALIDARG
HRESULT IClientLineMgrDisp::DispSelectLine | ( | [in] IDispatch * | pIClientLine, |
[out, retval] long * | pError ) |
HRESULT IClientLineMgrDisp::DispSelectLineNumber | ( | [in] long | iLineNumber, |
[out, retval] long * | pError ) |
HRESULT IClientLineMgrDisp::DispSendChatMessage | ( | [in] unsigned long | ulMessageId, |
[in] BSTR | sMessageText, | ||
[in] BSTR | sPeerName, | ||
[in] DWORD | dwPeerIpAddress ) |
Send chat message. m_sPeerName is the username on the IPPBX server If m_dwPeerIpAddress==0, the message will be sent to all logged on devices of this user, otherwise to the device with the given IP address
* typedef struct * { * unsigned long m_ulMessageId; * BSTR m_sMessageText; * BSTR m_sPeerName; * DWORD m_dwPeerIpAddress; * } CLMgrChatMsg; *
HRESULT IClientLineMgrDisp::DispSetDialerMode | ( | [in] BOOL | bEnable, |
[in] BSTR | SLoggedInDeviceUri ) |
Enable / disable dialer mode phone URI: URI of the controlled phone
HRESULT IClientLineMgrDisp::DispSetNumberOfLines | ( | [in] long | NumberOfLines, |
[out, retval] long * | pError ) |
HRESULT IClientLineMgrDisp::DispSimpleDial | ( | [in] BSTR | dialstring | ) |
dial given dialstring on any free line If selected line is active, an inactive line will be selected automatically before dialing function call will be handled asynchronous, return code S_OK does not guarantee success
HRESULT IClientLineMgrDisp::DispSimpleDialEx | ( | [in] BSTR | dialstring, |
[out, retval] DWORD * | pdwErrorCode ) |
dial given dialstring on any free line If selected line is active, an inactive line will be selected automatically before dialing function call will be handled asynchronous, return code S_OK does not guarantee success If *pdwErrorCode==S_OK, the number was dialed asynchronous. If *pdwErrorCode==S_FALSE, the number was not dialed. The phone client software is not running (line manager not logged on to server) Any other errorcode: internal errocode, might come from server or line manager
HRESULT IClientLineMgrDisp::DispSimpleDialEx2 | ( | [in] BSTR | dialstring, |
[in] int | LineNumber, | ||
[out, retval] DWORD * | pdwErrorCode ) |
LineNumber=0..n: dial given dialstring on this line if free line LineNumber=-1: dial given dialstring on any free line If chosen line or selected line is active, an inactive line will be selected automatically before dialing If selected line is active, an inactive line will be selected automatically before dialing function call will be handled asynchronous, return code S_OK does not guarantee success If *pdwErrorCode==S_OK, the number was dialed asynchronous. If *pdwErrorCode==S_FALSE, the number was not dialed. The phone client software is not running (line manager not logged on to server) Any other errorcode: internal errocode, might come from server or line manager
HRESULT IClientLineMgrDisp::DispSimpleDialEx3 | ( | [in] BSTR | dialstring, |
[in] int | LineNumber, | ||
[in] BOOL | bProcessNumber, | ||
[in] BSTR | name, | ||
[out, retval] DWORD * | pdwErrorCode ) |
LineNumber=0..n: dial given dialstring on this line if free line LineNumber=-1: dial given dialstring on any free line If chosen line or selected line is active, an inactive line will be selected automatically before dialing If selected line is active, an inactive line will be selected automatically before dialing function call will be handled asynchronous, return code S_OK does not guarantee success bProcessNumber: TRUE: automatically add public access code if it is possibly missing name: if known, the name might be submitted as well; will be used for name resolution If *pdwErrorCode==S_OK, the number was dialed asynchronous. If *pdwErrorCode==S_FALSE, the number was not dialed. The phone client software is not running (line manager not logged on to server) Any other errorcode: internal errocode, might come from server or line manager
HRESULT IClientLineMgrDisp::DispSkinGetActionAreaState | ( | [in] DWORD | dwCommandId, |
[in] DWORD | dwButtonId, | ||
[out, retval] DWORD * | pdwActionAreaState ) |
Get state of SwyxIt! button pdwActionAreaState will return the current SwyxIt! action area state of the SwyxIt! command dwCommandId. Some buttons (commands) (line, speed dial) are indexed (line 0..line n). If command is not indexed, set dwButtonId to 0
HRESULT IClientLineMgrDisp::DispSkinGetInfoDetail | ( | [in] DWORD | dwDetailIndex, |
[out, retval] BSTR * | pInfoDetail ) |
HRESULT IClientLineMgrDisp::DispSkinPhoneCommand | ( | [in] DWORD | dwCommandId, |
[in] DWORD | dwButtonId ) |
Signal command through line manager to SwyxIt! (will be handled by GUI) Some commands (line, speed dial) are indexed (line 0..line n). If command is not indexed, set dwButtonId to 0 Will be handled as if button was pressed
HRESULT IClientLineMgrDisp::DispSpeedDialName | ( | [in] long | iIndex, |
[out, retval] BSTR * | pName ) |
Get speed dial configuration: Name
HRESULT IClientLineMgrDisp::DispSpeedDialNumber | ( | [in] long | iIndex, |
[out, retval] BSTR * | pNumber ) |
Get speed dial configuration: Dialnumber
HRESULT IClientLineMgrDisp::DispSpeedDialState | ( | [in] long | iIndex, |
[out, retval] long * | pState ) |
Get speed dial notification state speed dial signalling states
* typedef enum * { * PubSDUnknown=0, //unknown -> external number * PubSDLoggedOut, //known user, not logged on to PBX * PubSDLoggedIn, //known user, logged on to PBX * PubSDBusy, //known user, client is busy * PubSDGroupCallNotification //known user, that user currently receives a call; notification call * } PubCLMgrSpeedDialStates; *
HRESULT IClientLineMgrDisp::DispStopPlaySoundFile | ( | ) |
Stop playback of currently played sound file
HRESULT IClientLineMgrDisp::DispStopPlayToRtp | ( | ) |
Stop playing soundfile towards RTP
HRESULT IClientLineMgrDisp::DispStopRecordFromRtp | ( | ) |
Stop recording RTP stream to soundfile
HRESULT IClientLineMgrDisp::DispSwitchToLine | ( | [in] IDispatch * | pIClientLine, |
[out, retval] long * | pError ) |
switch to line the previous selected line will be set to hold / disconnected if it was active or dialing, alerting etc. after a short timeout the afterwards selected line will -> be activated if currently on hold -> pickup incoming call if ringing -> hook off if currently inactive / terminated *pError returns error code *pError==S_OK -> success *pError==S_FALSE -> could not select line (probably because selected line is active and cannot be hold for some reason)
HRESULT IClientLineMgrDisp::DispSwitchToLineNumber | ( | [in] long | iLineNumber, |
[out, retval] long * | pError ) |
switch to line the previous selected line will be set to hold / disconnected if it was active or dialing, alerting etc. after a short timeout the afterwards selected line will -> be activated if currently on hold -> pickup incoming call if ringing -> hook off if currently inactive / terminated *pError returns error code *pError==S_OK -> success *pError==S_FALSE -> could not select line (probably because selected line is active and cannot be hold for some reason)
HRESULT IClientLineMgrDisp::DispUnRegisterChatMessageReader | ( | [in] DWORD | dwReaderID | ) |
UnRegister as receiver for chat messages
HRESULT IClientLineMgrDisp::DispUnRegisterMessageTarget | ( | [in] long | hWnd, |
[in] long | dwThreadId ) |
unregister thread / window for window messages
HRESULT IClientLineMgrDisp::DispVoicemailRemoteInquiry | ( | ) |
Dial own number for entering voicemail remote inquiry menu
HRESULT IClientLineMgrDisp::DoneWithModalUiDialog | ( | [in] DWORD | dwDialogId | ) |
Client GUI (SwyxIt!) uses this to notify everyone that it's done showing the modal dialog requested by OpenClientUiDialog
HRESULT IClientLineMgrDisp::FreeBusy | ( | [in] BSTR | name, |
[out] long * | pCurrentState, | ||
[out] DATE * | pCurrentStateTill, | ||
[out] long * | pNextState, | ||
[out] DATE * | pNextStateTill, | ||
[out, retval] BOOL * | pbSucceded ) |
HRESULT IClientLineMgrDisp::FulltextSearchInContactsEx | ( | [in] BSTR | bstrSearchText, |
[in] BOOL | bSearchInPhonebook, | ||
[in] BOOL | bSearchInPlugins, | ||
[in] BOOL | bSearchInNumbers, | ||
[out] IDispatch ** | ppSearchResultCollection, | ||
[out, retval] BOOL * | pbSucceeded ) |
HRESULT IClientLineMgrDisp::get_DispCtiSettings | ( | [out] BSTR * | szControlledNumber, |
[out] BOOL * | bEnableDeliveryTo3pcc, | ||
[out] BOOL * | bUseAsSystemPhone, | ||
[out] BOOL * | bUse3pccAllowed, | ||
[out] BOOL * | bUseAutopairing, | ||
[out] INT * | ePubCLMgrCtiSlaveTypes, | ||
[out] BOOL * | bHasFeatureSwyxCTIPlus, | ||
[out] BOOL * | bHasFeatureSwyxCTI ) |
HRESULT IClientLineMgrDisp::get_DispNumberHistory | ( | [in] BSTR | name, |
[out] BSTR * | szFirstNumber, | ||
[out] BSTR * | szSecondNumber, | ||
[out] BSTR * | szThirdNumber, | ||
[out] BSTR * | szFourthNumber, | ||
[out] BSTR * | szFifthNumber ) |
HRESULT IClientLineMgrDisp::GetCertificateThumbprint | ( | [out] VARIANT * | pvThumbprint | ) |
Get thumbprint of automatic configured certificate
HRESULT IClientLineMgrDisp::GetContactByID | ( | [in] BSTR | bstrPluginID, |
[in] BSTR | bstrPluginContactID, | ||
[out] VARIANT * | pVal ) |
HRESULT IClientLineMgrDisp::GetContactDataPlugIns | ( | [out] VARIANT * | pVal | ) |
HRESULT IClientLineMgrDisp::GetCstaPairing | ( | [out, retval] BSTR * | pVal | ) |
GetCstaPairing Get last paired Csta device id
HRESULT IClientLineMgrDisp::GetFreeBusyInfo | ( | [in] BSTR | bstrName, |
[in] BSTR | bstrContactId, | ||
[in] BSTR | bstrPluginId, | ||
[out] long * | pCurrentState, | ||
[out] DATE * | pCurrentStateTill, | ||
[out] long * | pNextState, | ||
[out] DATE * | pNextStateTill, | ||
[out, retval] BOOL * | pSucceded ) |
|
property |
HRESULT IClientLineMgrDisp::GetRcEndpoints | ( | [out] BSTR * | pszPublicAuthServer, |
[out] BSTR * | pszPublicFallbackAuthServer, | ||
[out] BSTR * | pszPublicRcServer, | ||
[out] BSTR * | pszPublicFallbackRcServer ) |
Get Remote Connector configuration (Authentication Server Endpoints and Remote Connector Endpoints)
HRESULT IClientLineMgrDisp::GetSearchResultCount | ( | [in] BSTR | bstrContactPluginID, |
[in] BSTR | bstrSearchString, | ||
[out] ULONG * | pVal ) |
HRESULT IClientLineMgrDisp::GetUserAppearances | ( | [out, retval] IDispatch ** | ppUserAppearances | ) |
Get user appeareances as needed by IM client returns a list of user appearance interfaces The list contains all appearance of all user that have a ChatUserId assigned, which always includes the self-user.
HRESULT IClientLineMgrDisp::GetUserIdByPhoneNumber | ( | [in] BSTR | phoneNumber, |
[out] int * | piSiteId, | ||
[out] int * | piUserId ) |
Resolve a phone number into SiteID and UserID
HRESULT IClientLineMgrDisp::GetUserPhoneBookStatus | ( | [in] int | iSiteId, |
[in] int | iUserId, | ||
[out] int * | piStatus, | ||
[out] BSTR * | pszFreeText ) |
Get User's Phone book status by SiteID and UserID
|
property |
Get User's Phone book callback enumeration
HRESULT IClientLineMgrDisp::HasAppointment | ( | [in] BSTR | name, |
[out] DATE * | pEndTime, | ||
[out] BOOL * | pIsPrivate, | ||
[out] long * | pType, | ||
[out] BSTR * | pSubject, | ||
[out, retval] BOOL * | pbSucceded ) |
HasAppointment Checks if the user has an active appointment and returns the corresponding information.
HRESULT IClientLineMgrDisp::IsClientPopUpAndNotificationAllowed | ( | [out, retval] BOOL * | pVal | ) |
Returns TRUE if the client is allowed to show call pop-ups, notifications (and start Swyx Messenger) Can be changed by setting Client::RemoteDesktop::PopupMode GlobalConfigItem
HRESULT IClientLineMgrDisp::IsCstaMonitorStarted | ( | [out, retval] BOOL * | pVal | ) |
IsCstaMonitorStarted Determines if a Csta monitor is running.
HRESULT IClientLineMgrDisp::IsDcf2CstaPairing | ( | [out, retval] BOOL * | pVal | ) |
IsDcf2CstaPairing Returns TRUE if the currently paired CSTA device supports Swyx's DCF2 implementation (e.g., multi-line functionality)
HRESULT IClientLineMgrDisp::IsOfficeRunning | ( | [out] BOOL * | pbRunning | ) |
IsOfficeRunning Checks if the line manager plugin can access the related office application and writes TRUE to pbRunning if it is so
HRESULT IClientLineMgrDisp::IsTerminalServer | ( | [out, retval] BOOL * | pVal | ) |
Returns TRUE if CLMgr is running on a Terminal Server
HRESULT IClientLineMgrDisp::OpenCalendar | ( | [in] BSTR | recipient, |
[out, retval] BOOL * | pbSucceded ) |
HRESULT IClientLineMgrDisp::OpenClientUiDialog | ( | [in] DWORD | dwDialogId | ) |
Ask the client GUI (SwyxIt!) to open a dialog (e.g., some settings) See PubCLMgrUiDialogId enum for dialog IDs
HRESULT IClientLineMgrDisp::PlaySoundFileCDS | ( | [in] BSTR | FileName, |
[in] LONG | Scope, | ||
[in] LONG | Category, | ||
[in] BOOL | bPlayLoop, | ||
[in] int | iLoopInterval, | ||
[in] DWORD | dwVolume ) |
Play soundfile API
HRESULT IClientLineMgrDisp::PlaySoundFileDxCDS | ( | [in] BSTR | sFileName, |
[in] LONG | eScope, | ||
[in] LONG | eCategory, | ||
[in] BOOL | bPlayLoop, | ||
[in] int | iLoopInterval ) |
HRESULT IClientLineMgrDisp::PlaySoundFileDxExCDS | ( | [in] BSTR | sFileName, |
[in] LONG | eScope, | ||
[in] LONG | eCategory, | ||
[in] BOOL | bPlayLoop, | ||
[in] int | iLoopInterval, | ||
[in] int | iPosition, | ||
[in] BOOL | bPercent, | ||
[in] BOOL | bPauseImmediately, | ||
[in] int | iDevice ) |
HRESULT IClientLineMgrDisp::PlayToRtpCDS | ( | [in] BSTR | sFileName, |
[in] LONG | eScope, | ||
[in] LONG | eCategory, | ||
[in] BOOL | bLoop, | ||
[in] DWORD | dwPause ) |
HRESULT IClientLineMgrDisp::put_DispCtiSettings | ( | [in] BSTR | szControlledNumber, |
[in] BOOL | bEnableDeliveryTo3pcc, | ||
[in] BOOL | bUseAutopairing ) |
HRESULT IClientLineMgrDisp::RecordFromRtpCDS | ( | [in] BSTR | sFullPath, |
[in] LONG | eScope, | ||
[in] LONG | eCategory, | ||
[in] BOOL | IsPrivate, | ||
[in] BOOL | IsHidden, | ||
[in] BOOL | bAppend, | ||
[in] BOOL | bAddLocalSounds ) |
HRESULT IClientLineMgrDisp::RecordSoundFileCDS | ( | [in] BSTR | FileName, |
[in] LONG | Scope, | ||
[in] LONG | Category, | ||
[in] BOOL | IsPrivate, | ||
[in] BOOL | IsHidden ) |
HRESULT IClientLineMgrDisp::RegisterUserConnector4UC | ( | [in] int | iConnectorConfig, |
[in] int | iCertificateConfig, | ||
[in] BSTR | PublicServerName, | ||
[in] BSTR | PublicBackupServerName, | ||
[in, out] VARIANT * | pvThumbprint, | ||
[in] BSTR | ServerName, | ||
[in] BSTR | BackupServerName, | ||
[in] BSTR | PbxUserName, | ||
[in] BSTR | Password, | ||
[in] int | iAuthenticationMode, | ||
[in] BOOL | bCtiMaster, | ||
[out] BSTR * | Usernames, | ||
[in] VARIANT | vStatusNames ) |
RegisterUser CloudConnector
HRESULT IClientLineMgrDisp::RegisterUserEx | ( | [in] BSTR | ServerName, |
[in] BSTR | BackupServerName, | ||
[in] BSTR | PbxUserName, | ||
[in] BSTR | Password, | ||
[in] int | iAuthenticationMode, | ||
[in] BOOL | bCtiMaster, | ||
[out] BSTR * | Usernames ) |
Register a user on the PBX
ServerName | |
BackupServerName | server resp. fallback server |
PbxUserName | Name of PBX user |
Password | Password of PBX user |
iAuthenticationMode | typedef enum { CLMgrAuthenticationMode_None=0, //to be used for "SwyxIt! Now logon -> logon based on configured SIP accounts CLMgrAuthenticationMode_Password=1, //logon based on username & password; parameters will be used for //database access and SIP logon CLMgrAuthenticationMode_WebServiceTrusted=2,//trusted logon for database, SIP logon parameters will be used from user profile } CLMgrAuthenticationMode; * |
bCtiMaster | |
*Usernames | When the logon was ambigous, return the list of possible user names; names separated by '\n': john\npaul\nmeyer, kurtreturns S_OK when the logon was successful S_FALSE when trusted logon without providing a username is not possbible because multiple accounts match |
HRESULT IClientLineMgrDisp::RegisterUserEx4UC | ( | [in] BSTR | ServerName, |
[in] BSTR | BackupServerName, | ||
[in] BSTR | PbxUserName, | ||
[in] BSTR | Password, | ||
[in] int | iAuthenticationMode, | ||
[in] BOOL | bCtiMaster, | ||
[out] BSTR * | Usernames, | ||
[in] VARIANT | vStatusNames ) |
Register a user on the PBX
ServerName | contains the server name |
BackupServerName | server resp. fallback server |
PbxUserName | Name of PBX user |
Password | Password of PBX user |
iAuthenticationMode | typedef enum { CLMgrAuthenticationMode_None=0, //to be used for "SwyxIt! Now logon -> logon based on configured SIP accounts CLMgrAuthenticationMode_Password=1, //logon based on username & password; parameters will be used for //database access and SIP logon CLMgrAuthenticationMode_WebServiceTrusted=2, //trusted logon for database, SIP logon parameters will be used from user profile } CLMgrAuthenticationMode; * |
bCtiMaster | is true if the client is acting as CTI master |
*Usernames | When the logon was ambigous, return the list of possible user names; names separated by '\n': john\npaul\nmeyer, kurt |
vStatusNames | contains status names |
HRESULT IClientLineMgrDisp::ReleaseUserEx | ( | ) |
Release user from PBX Calling RegisterUserEx and ReleaseUserEx is not required for all clients. Registration should be done only by full clients, clients that intend to provide a complete phone user interface like SwyxIt! it self. For "simple" dialer applications (software that occasionally establishes a phone call) or monitor applications (software that traces incoming or all calls and responds with pop up windows etc.) must not really logon. All methods can be used without logon. The client line manager implements a reference counter for all logged on client applications. The client linemanger unregisters from the SwyxServer only after all logged on client applications have logged off again. Please refer to the sample applications: the trace tool and the dialer VB script do not register.
HRESULT IClientLineMgrDisp::ResolveRecipient | ( | [in] BSTR | searchString, |
[out] BSTR * | resolvedName, | ||
[out] BSTR * | resolvedEMailAddress, | ||
[out] BOOL * | IsResolved, | ||
[out] BOOL * | IsExchangeUser, | ||
[in] BOOL | ShowDetails, | ||
[out, retval] BOOL * | pbSucceded ) |
HRESULT IClientLineMgrDisp::ResolveRecipientById | ( | [in] BSTR | bstrContactId, |
[in] BSTR | bstrPluginId, | ||
[out] BSTR * | pResolvedName, | ||
[out] BSTR * | pResolvedEMailAddress, | ||
[out] BOOL * | pIsResolved, | ||
[out] BOOL * | pIsRealUser, | ||
[out, retval] BOOL * | pSucceded ) |
HRESULT IClientLineMgrDisp::SaveCstaPairing | ( | [in] BSTR | deviceId | ) |
SaveCstaPairing Saves Cti information for Csta usage.
HRESULT IClientLineMgrDisp::SaveCtiPairing | ( | [in] BSTR | deviceId | ) |
SaveCstaPairing Saves Cti information for Csta usage.
HRESULT IClientLineMgrDisp::SaveCtiSettings | ( | ) |
HRESULT IClientLineMgrDisp::SaveRcClientCertificate | ( | [in] VARIANT | Certificate, |
[in] BSTR | Password ) |
Save remote connector client certificate
HRESULT IClientLineMgrDisp::SearchContacts | ( | [in] BSTR | bstrContactPluginID, |
[in] BSTR | bstrSearchString, | ||
[out] VARIANT * | pVal ) |
HRESULT IClientLineMgrDisp::SendClientRegisterRequest | ( | [in] int | iRegisteringEntity | ) |
Get state of local cloud connector
|
property |
HRESULT IClientLineMgrDisp::SetUnreadInstantMessageCount | ( | [in] DWORD | dwUnreadMessages | ) |
Signal the count of unread instant messages through line manager to SwyxIt! (will be handled by GUI)
HRESULT IClientLineMgrDisp::ShowContactEx | ( | [in] BSTR | bstrContactId, |
[in] BSTR | bstrPluginId, | ||
[in] BSTR | bstrName, | ||
[in] BSTR | bstrNumber, | ||
[in] BOOL | bCreateIfNotExists, | ||
[out, retval] BOOL * | pSucceded ) |
HRESULT IClientLineMgrDisp::StartCstaMonitor | ( | [in] BSTR | deviceId | ) |
StartCstaMonitor Starts Csta monitoring.
HRESULT IClientLineMgrDisp::StartCstaSession | ( | [out, retval] BOOL * | pVal | ) |
StartCstaSession Starts a Csta Sesson
HRESULT IClientLineMgrDisp::StopCstaMonitor | ( | ) |
StopCstaMonitor Stops Csta monitoring.
HRESULT IClientLineMgrDisp::StopCstaSession | ( | ) |
StopCstaSession Stop the current Csta Sesson
HRESULT IClientLineMgrDisp::ValidateCtiSettings | ( | [in] BSTR | controlledNumber, |
[out] PubCLMgrCtiValidation * | ctiValidation ) |
|
getproperty |
Get state of local cloud connector
|
getproperty |
Get state of local cloud connector
|
getproperty |
Get AreaCode pAreaCode: "231" for Dortmund, without leading zeros
|
getsetproperty |
DispAudioMode switches the AudioMode state (Handset / Headset /Handsfree)
|
getproperty |
Get Details about server addresses retreived via AutoDetection backup server to be used (resolved name, ip address if name could not be resolved)
If you want to use server as retrieved via AutoDetection, please call PubInit / PubInitEx without server name
|
getproperty |
Get Details about server addresses retreived via AutoDetection TRUE if AutoDetection API available, FALSE if we could not use AutoDetection (Windows 9x, NT4)
|
getproperty |
Get Details about server addresses retreived via AutoDetection primary server to be used (resolved name, ip address if name could not be resolved)
If you want to use server as retrieved via AutoDetection, please call PubInit / PubInitEx without server name
|
getproperty |
Get Details about server addresses retreived via AutoDetection TRUE if we retreived server addresses via AutoDetection);
|
getsetproperty |
DispConfigureDevice invokes configuration of device
|
getproperty |
DispCaptureVolume gets the adjusted microphone level
|
getproperty |
DispClientConfig property returns the client config object
|
getproperty |
Get conference line; returns NULL if no conference running
|
getproperty |
Get zero based index of conference line; returns -1 if no conference running
|
getproperty |
Conference established or in creation?
|
setproperty |
DispConfigureDevice invokes configuration of device
|
getproperty |
Get CountryCode pCountryCode: "49" for Germany, without leading zeros
|
setproperty |
DispDefaultAudioMode puts the default audiomode
|
getproperty |
Get device session id (a registered devices can be identified by this id.
|
getproperty |
get details of current callback on busy notification: peer name that is now free again
|
getproperty |
get details of current callback on busy notification: peer name that is now free again
|
getproperty |
Get Logon Details about current session int *piAuthMode: authentication mode used for the last logon
|
getproperty |
Get Logon Details about current session BSTR *psServer: server we are logged on to; if NULL, we are not initialized
|
getproperty |
Get Logon Details about current session BSTR *psUser: user name we used; if NULL, we are not logged on
|
getproperty |
DispHandsetAvailable gets the Handset available state
|
setproperty |
DispHandsetCaptureDevice puts the selected handset capture device
|
getproperty |
DispHandsetCaptureDevices retrievs a list of available handset capture devices
|
setproperty |
DispHandsetDevice puts the selected handset device
|
getproperty |
DispHandsetDevices retrievs a list of available handset devices
|
getproperty |
DispHandsfreeAvailable gets the Handsfree available state
|
setproperty |
DispHandsfreeCaptureDevice puts the selected handsfree capture device
|
getproperty |
DispHandsfreeCaptureDevices retrievs a list of available handset devices
|
setproperty |
DispHandsfreeDevice puts the selected handsfree device
|
getproperty |
DispHandsfreeDevices retrievs a list of available handsfree devices
|
getproperty |
DispHeadsetAvailable gets the Headset available state
|
setproperty |
DispHeadsetCaptureDevice puts the selected headset capture device
|
getproperty |
DispHeadsetCaptureDevices retrievs a list of available headset capture devices
|
setproperty |
DispHeadsetDevice puts the selected headset device
|
getproperty |
DispHeadsetDevices retrievs a list of available headset devices
|
getproperty |
Get InternationCallPrefix pInternationCallPrefix: e.g. "00" -> a user has to dial "000" (public 0 + international 00) for international calls
|
getproperty |
DispIsLoggedIn gets the information if we are logged in
|
getproperty |
DispIsLoggedInAsCtiMaster gets the information if we are logged in as CTI-Master
|
getproperty |
check whether connection to server is up (again), after we received message "PubCLMgrServerDownMessage" while connection to server is down, this method will try to reconnect immediately Client Line Manager will try reconnect in fixed time interval anyway
|
getproperty |
Get LongDistanceCallPrefix pLongDistanceCallPrefix: e.g. "0" -> a user has to dial "00" (public 0 + long distance 0) for long distance calls
|
getsetproperty |
get / set microphone state
|
getproperty |
available notification call, signaled with "PubCLMgrGroupCallNotificationMessage" we can pick up call for other user by "PubPickupGroupNotificationCall" one of our own extensions or number of called group (it it was group call)
|
getproperty |
available notification call, signaled with "PubCLMgrGroupCallNotificationMessage" we can pick up call for other user by "PubPickupGroupNotificationCall" name of called PBX user = our own name or name of group that has been called
|
getproperty |
available notification call, signaled with "PubCLMgrGroupCallNotificationMessage" we can pick up call for other user by "PubPickupGroupNotificationCall" name of caller
|
getproperty |
available notification call, signaled with "PubCLMgrGroupCallNotificationMessage" we can pick up call for other user by "PubPickupGroupNotificationCall" number of caller
|
getproperty |
available notification call, signaled with "PubCLMgrGroupCallNotificationMessage" we can pick up call for other user by "PubPickupGroupNotificationCall" name of PBX user that has forwarded this call
|
getproperty |
available notification call, signaled with "PubCLMgrGroupCallNotificationMessage" we can pick up call for other user by "PubPickupGroupNotificationCall" number of PBX user that has forwarded this call
|
getproperty |
available notification call, signaled with "PubCLMgrGroupCallNotificationMessage" we can pick up call for other user by "PubPickupGroupNotificationCall" this call was redirected (incoming or outgoing)
|
getproperty |
Get number of configured extensions
|
getproperty |
Get / set number of lines if number of lines is changed, we get message "PubCLMgrNumberOfLinesChangedMessage" PubSetNumberOfLines will only change the number of created lines, the number of configured lines will not be changed
|
getproperty |
Get number of configured speed dials
|
getsetproperty |
DispOpenListening switches the OpenListening state (Off / On)
|
getproperty |
DispOpenListeningAvailable gets the OpenListening available state
|
setproperty |
DispOpenListeningDevice puts the selected open listening device
|
getproperty |
DispOpenListeningDevices retrievs a list of available OpenListening devices
|
getsetproperty |
DispPreferredHandsetDevice gets/sets the preferred Handset device
|
getsetproperty |
DispPreferredHandsfreeDevice gets/sets the preferred Handsfree device
|
getsetproperty |
DispPreferredHeadsetDevice gets/sets the preferred Headset device
|
getsetproperty |
DispPreferredOpenListeningDevice gets/sets the preferred OpenListening device
|
getsetproperty |
DispPreferredRingingDevice gets/sets the preferred Ringing device
|
getproperty |
Get PublicAccessPrefix pPublicAccessPrefix: e.g. "0" -> a user has to dial "0" for a public line
|
getproperty |
DispRecordingDimension gets the dimension of recorded data
|
getproperty |
DispRecordingLevel gets the capture level during recoding
|
setproperty |
DispRingingDevice puts the selected ringing device
|
getproperty |
DispRingingDevices retrievs a list of available ringing devices
|
setproperty |
DispRingToneVolumeBias adjusts the volume on the ringing device for a RingTone using a changed volume bias ( a value from 0..100) the changed value is not stored by calling this method and must be stored by the application
|
getproperty |
get / set selected line by interface pointer the previous selected line will be set to hold / disconnected if it was active or dialing, alerting etc. the afterwards selected line will not be activated or hooked off *pError returns error code *pError==S_OK -> success *pError==S_FALSE -> could not select line (probably because selected line is active and cannot be hold for some reason)
|
getproperty |
get / set selected line by index (first line == 0, ...) the previous selected line will be set to hold / disconnected if it was active or dialing, alerting etc. the afterwards selected line will not be activated or hooked off *pError returns error code *pError==S_OK -> success *pError==S_FALSE -> could not select line (probably because selected line is active and cannot be hold for some reason)
|
getsetproperty |
get / set speaker state
|
setproperty |
DispStartRecording starts recording
|
setproperty |
DispStartSoundFile starts playing a sound file
|
setproperty |
DispStopRecording stops recording
|
setproperty |
DispStopSoundFile stops playing a sound file
|
getsetproperty |
DispVolume gets/adjusts the sound volume
|
getproperty |
Get collection of all devices that are logged in for the current user
|
getsetproperty |
|
getproperty |
SwyxItVersionInfo retrievs SwyxItVersionInfo