import "CLMgrPub.idl";

Inheritance diagram for IClientLineMgrPub5:

Public Member Functions
HRESULT	PubGetCallbackOnBusyNotifyDetails ([out] PubCLMgrCallbackOnBusyNotifyDetails *pDetails)

HRESULT	PubPickupCallbackOnBusyNotification ([in] int LineNumber)

HRESULT	PubRejectCallbackOnBusyNotification ()

HRESULT	PubSimpleDialEx ([in] BSTR dialstring, [in] int LineNumber)

HRESULT	PubRequestCallbackOnBusy ([in] BSTR PeerNumber, [in] BSTR PeerName)

HRESULT	PubVoicemailRemoteInquiry ()

HRESULT	PubRegisterChatMessageReader ([out] DWORD *dwReaderID)

HRESULT	PubSendChatMessage ([in] PubCLMgrChatMsg ChatMessage)

HRESULT	PubReadChatMessage ([in] DWORD dwReaderID, [out] PubCLMgrChatMsg *pChatMessage)

HRESULT	PubAcknowledgeChatMessage ([in] PubCLMgrChatMsgAck ChatMessageAcknowledge)

HRESULT	PubUnRegisterChatMessageReader ([in] DWORD dwReaderID)

Detailed Description

Line manager interface Handles connection to server and selection of lines,

Use this interface from C++ clients

Member Function Documentation

◆ PubAcknowledgeChatMessage()

HRESULT IClientLineMgrPub5::PubAcknowledgeChatMessage ( [in] PubCLMgrChatMsgAck ChatMessageAcknowledge )

Acknowledge read chat message, use m_ulMessageId from the message to be confirmed

◆ PubGetCallbackOnBusyNotifyDetails()

HRESULT IClientLineMgrPub5::PubGetCallbackOnBusyNotifyDetails ( [out] PubCLMgrCallbackOnBusyNotifyDetails * pDetails )

get details of current callback on busy notification

* typedef struct
* {
*     BSTR            m_sPeerNumber;  //number that is now free again
*     BSTR            m_sPeerName;    //name that is now free again
* } PubCLMgrCallbackOnBusyNotifyDetails;
*

◆ PubPickupCallbackOnBusyNotification()

HRESULT IClientLineMgrPub5::PubPickupCallbackOnBusyNotification ( [in] int LineNumber )

pickup callback on busy -> retry calling on specified line line = -1 if line does not matter -> select first inactive line

◆ PubReadChatMessage()

HRESULT IClientLineMgrPub5::PubReadChatMessage	(	[in] DWORD	dwReaderID,
		[out] PubCLMgrChatMsg *	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;
*

◆ PubRegisterChatMessageReader()

HRESULT IClientLineMgrPub5::PubRegisterChatMessageReader ( [out] 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

◆ PubRejectCallbackOnBusyNotification()

HRESULT IClientLineMgrPub5::PubRejectCallbackOnBusyNotification ( )

reject callback on busy -> do not retry calling, stop notification

◆ PubRequestCallbackOnBusy()

HRESULT IClientLineMgrPub5::PubRequestCallbackOnBusy	(	[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

◆ PubSendChatMessage()

HRESULT IClientLineMgrPub5::PubSendChatMessage ( [in] PubCLMgrChatMsg ChatMessage )

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;
*

◆ PubSimpleDialEx()

HRESULT IClientLineMgrPub5::PubSimpleDialEx	(	[in] BSTR	dialstring,
		[in] int	LineNumber )

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 function call will be handled asynchronous, return code S_OK does not guarantee success

◆ PubUnRegisterChatMessageReader()

HRESULT IClientLineMgrPub5::PubUnRegisterChatMessageReader ( [in] DWORD dwReaderID )

UnRegister as receiver for chat messages

◆ PubVoicemailRemoteInquiry()

HRESULT IClientLineMgrPub5::PubVoicemailRemoteInquiry ( )

Dial own number for entering voicemail remote inquiry menu

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

CLMgrPub.idl

Public Member Functions