CSTADLL  2.5.0
Public Member Functions | Protected Member Functions | Properties | List of all members
GenericCSTAp2 Class Reference
Inheritance diagram for GenericCSTAp2:
SiemensHipath3000p2 IETF_CSTAp2 Alcatel4400 SamsungSCM AlcatelOXE

Public Member Functions

virtual CSTAResponseInfo AnswerCall (string deviceToLift)
 
virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer)
 
virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer, string deviceToLift)
 
virtual CSTAResponseInfo ClearConnection (ConnectionID connToClear)
 
virtual CSTAResponseInfo ClearDoNotDisturb (string targetDevice)
 
virtual CSTAResponseInfo ClearMessageWaiting (string targetDevice)
 
virtual CSTAResponseInfo ConferenceCall (ConnectionID heldCall, ConnectionID activeCall)
 
virtual CSTAResponseInfo ConsultationCall (ConnectionID existingCall, string targetDevice)
 
virtual CSTAResponseInfo DivertCall (string divertFrom, string divertTo)
 
int EncodeROSERequestHeader (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, Phase2Opcodes.Opcodes opcode)
 
 GenericCSTAp2 (string pbxSystem, int port)
 
 GenericCSTAp2 (PBXSession sessionObject)
 
virtual CSTAResponseInfo HoldCall (ConnectionID callToHold)
 
virtual CSTAResponseInfo MakeACSEAssociation ()
 
virtual CSTAResponseInfo MakeCall (string callingDevice, string calledDevice)
 
virtual CSTAResponseInfo MonitorStart (string deviceToMonitor)
 
virtual CSTAResponseInfo MonitorStart (ConnectionID callToMonitor)
 
virtual CSTAResponseInfo MonitorStop (MonitorCrossRefID crossRefID)
 
virtual CSTAResponseInfo MonitorStop (string monitoredDevice)
 
virtual CSTAResponseInfo MonitorStop (long monitoredDevice)
 
virtual CSTAResponseInfo QueryDevice (string deviceToQuery)
 
virtual CSTAResponseInfo ReleaseACSEAssociation ()
 
virtual CSTAResponseInfo RetrieveCall (ConnectionID callToRetrieve)
 
virtual CSTAResponseInfo SetAgentState (string targetDevice, AgentParameter agentParam)
 
virtual CSTAResponseInfo SetDoNotDisturb (string targetDevice)
 
virtual CSTAResponseInfo SetMessageWaiting (string targetDevice)
 
virtual CSTAResponseInfo SetOrClearForwarding (string fromDevice, ForwardingType fwdType, string toDevice)
 
virtual CSTAResponseInfo SnapshotDevice (string deviceToSnapshot)
 
virtual CSTAResponseInfo TransferCall (ConnectionID initiatedCall, ConnectionID originalCall)
 
virtual CSTAResponseInfo TransferCall (string heldDevice, string connectedDevice)
 

Protected Member Functions

virtual int EncodeACSEConnectionRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer)
 
virtual int EncodeACSEReleaseRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer)
 
virtual int EncodeAnswerCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string deviceToLift)
 
virtual int EncodeAnswerCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToAnswer)
 
virtual int EncodeAnswerCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToAnswer, string deviceToLift)
 
virtual int EncodeClearConnectionRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID connToClear)
 
virtual int EncodeConferenceCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID heldCall, ConnectionID activeCall)
 
virtual int EncodeConsultationCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID existingCall, string targetDevice)
 
virtual int EncodeDivertCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string divertFrom, string divertTo)
 
virtual int EncodeHoldCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToHold)
 
virtual int EncodeMakeCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string callingDevice, string calledDevice)
 
virtual int EncodeMonitorStartRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string deviceToMonitor)
 
virtual int EncodeMonitorStartRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToMonitor)
 
virtual int EncodeMonitorStopRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, MonitorCrossRefID crossRefObj)
 
virtual int EncodeQueryDeviceRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string deviceToQuery)
 
virtual int EncodeRetrieveCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToRetrieve)
 
virtual int EncodeSetAgentStateRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice, AgentParameter agentParam)
 
virtual int EncodeSetOrClearDNDRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice, bool dndOn)
 
virtual int EncodeSetOrClearFwdRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string fromDevice, ForwardingType fwdType, string toDevice)
 
virtual int EncodeSetOrClearMWRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice, bool indicatorOn)
 
virtual int EncodeSnapshotDeviceRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string deviceToSnapshot)
 
virtual int EncodeTransferCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID initiatedCall, ConnectionID originalCall)
 
virtual int EncodeTransferCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string heldDevice, string connectedDevice)
 

Properties

PBXSession SessionObject [get]
 
CSTAContext ThreadContext [get]
 

Detailed Description

Implements CSTA phase 2 operations using BER. Note that most PBXes don't support all CSTA messages, so some methods in this class may result in an error status being returned by your PBX.

Constructor & Destructor Documentation

◆ GenericCSTAp2() [1/2]

GenericCSTAp2 ( string  pbxSystem,
int  port 
)

Constructs an instance associated with the given PBX identifier and port.

Parameters
pbxSystemWell-known name or IP address of the PBX.
portPort on which the PBX listens for CSTA messages.

◆ GenericCSTAp2() [2/2]

GenericCSTAp2 ( PBXSession  sessionObject)

Constructs an instance associated with the given PBXSession object.

Parameters
sessionObjectA PBXSession object.

Member Function Documentation

◆ AnswerCall() [1/3]

virtual CSTAResponseInfo AnswerCall ( string  deviceToLift)
virtual

Answers a call.

Parameters
deviceToLiftThe identification (e.g., phone number) of the device to answer.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ AnswerCall() [2/3]

virtual CSTAResponseInfo AnswerCall ( ConnectionID  callToAnswer)
virtual

Answers a call.

Parameters
callToAnswerThe ConnectionID of the call to answer.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ AnswerCall() [3/3]

virtual CSTAResponseInfo AnswerCall ( ConnectionID  callToAnswer,
string  deviceToLift 
)
virtual

Answers a call.

Parameters
callToAnswerThe connection id of the call to answer.
deviceToLiftThe device (e.g., extension number) that is to answer the call.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ ClearConnection()

virtual CSTAResponseInfo ClearConnection ( ConnectionID  connToClear)
virtual

Clears a connection.

Parameters
connToClearThe ConnectionID of the connection to clear.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ ClearDoNotDisturb()

virtual CSTAResponseInfo ClearDoNotDisturb ( string  targetDevice)
virtual

Turns off the Do Not Disturb functionality for a phone.

Parameters
targetDeviceThe device for which the Do Not Disturb functionality is to be turned off.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ ClearMessageWaiting()

virtual CSTAResponseInfo ClearMessageWaiting ( string  targetDevice)
virtual

Turns off the message waiting indicator on a device's display.

Parameters
targetDeviceThe device for which the indicator is to be turned off.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ ConferenceCall()

virtual CSTAResponseInfo ConferenceCall ( ConnectionID  heldCall,
ConnectionID  activeCall 
)
virtual

Brings a held call into conference with an active call.

Parameters
heldCallThe held call to be brought into conference.
activeCallThe active call.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ ConsultationCall()

virtual CSTAResponseInfo ConsultationCall ( ConnectionID  existingCall,
string  targetDevice 
)
virtual

Instruct the PBX to do a consultation call.

Parameters
existingCallThe connection id of the call for which the consultation call will be made.
targetDeviceIdentifier (e.g., phone number) of the device that is the target of the consultation call.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ DivertCall()

virtual CSTAResponseInfo DivertCall ( string  divertFrom,
string  divertTo 
)
virtual

Diverts a call from a source to a destination.

Parameters
divertFromIdentifier (e.g., phone number) of the device from which the call is to be diverted.
divertToIdentifier (e.g., phone number) of the device to which the call is to be diverted.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ EncodeACSEConnectionRequest()

virtual int EncodeACSEConnectionRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer 
)
protectedvirtual

Encodes an ACSE Association Request message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
Returns
The length of the encoded message, or -1 if an error occurred.

Reimplemented in Alcatel4400.

References CSTAResponseInfo.StatusMessage.

◆ EncodeACSEReleaseRequest()

virtual int EncodeACSEReleaseRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer 
)
protectedvirtual

Encodes an ACSE Release Request message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.ResponseFromPBX, CSTAResponseInfo.StatusCode, and CSTAResponseInfo.StatusMessage.

◆ EncodeAnswerCallRequest() [1/3]

virtual int EncodeAnswerCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  deviceToLift 
)
protectedvirtual

Encodes an AnswerCall message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
deviceToLiftThe identification (e.g., phone number) of the device to answer.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeAnswerCallRequest() [2/3]

virtual int EncodeAnswerCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
ConnectionID  callToAnswer 
)
protectedvirtual

Encodes an AnswerCall message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
callToAnswerThe ConnectionID of the call to answer.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeAnswerCallRequest() [3/3]

virtual int EncodeAnswerCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
ConnectionID  callToAnswer,
string  deviceToLift 
)
protectedvirtual

Encodes an AnswerCall message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
callToAnswerThe ConnectionID of the call to answer.
deviceToLiftThe identification (e.g., phone number) of the device to answer.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeClearConnectionRequest()

virtual int EncodeClearConnectionRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
ConnectionID  connToClear 
)
protectedvirtual

Encodes a ClearConnection message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
connToClearThe ConnectionID of the connection to clear.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeConferenceCallRequest()

virtual int EncodeConferenceCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
ConnectionID  heldCall,
ConnectionID  activeCall 
)
protectedvirtual

Encodes a ConferenceCall message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
heldCallConnectionID of the held call to be retrieved.
activeCallConnectionID of the active call.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeConsultationCallRequest()

virtual int EncodeConsultationCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
ConnectionID  existingCall,
string  targetDevice 
)
protectedvirtual

Encodes a ConsultationCall message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
existingCallThe connection id of the call for which the consultation call will be made.
targetDeviceIdentifier (e.g., phone number) of the device that is the target of the consultation call.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeDivertCallRequest()

virtual int EncodeDivertCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  divertFrom,
string  divertTo 
)
protectedvirtual

Encodes a DivertCall message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
divertFromIdentifier (e.g., phone number) of the device from which the call is to be diverted.
divertToIdentifier (e.g., phone number) of the device to which the call is to be diverted.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeHoldCallRequest()

virtual int EncodeHoldCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
ConnectionID  callToHold 
)
protectedvirtual

Encodes a HoldCall message.

Parameters
responseA CSTAResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
callToHoldThe ConnectionID of the call to be held.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeMakeCallRequest()

virtual int EncodeMakeCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  callingDevice,
string  calledDevice 
)
protectedvirtual

Encodes a MakeCall message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
callingDeviceIdentifier (e.g., phone number) of the device making the call.
calledDeviceIdentifier (e.g., phone number) of the device being called.
Returns
The length of the encoded message, or -1 if an error occurred.

Reimplemented in Alcatel4400.

References CSTAResponseInfo.StatusMessage.

◆ EncodeMonitorStartRequest() [1/2]

virtual int EncodeMonitorStartRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  deviceToMonitor 
)
protectedvirtual

Encodes a MonitorStart message to monitor a device.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
deviceToMonitorIdentifier (e.g., telephone number) of the device to monitor.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeMonitorStartRequest() [2/2]

virtual int EncodeMonitorStartRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
ConnectionID  callToMonitor 
)
protectedvirtual

Encodes a MonitorStart message to monitor a call.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
callToMonitorThe call to monitor.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeMonitorStopRequest()

virtual int EncodeMonitorStopRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
MonitorCrossRefID  crossRefObj 
)
protectedvirtual

Encodes a MonitorStop message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
crossRefObjThe cross reference id of the monitor request as a MonitorCrossRefID object.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeQueryDeviceRequest()

virtual int EncodeQueryDeviceRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  deviceToQuery 
)
protectedvirtual

Encodes a QueryDevice message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
deviceToQueryThe identification (e.g., phone number) of the device to query.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeRetrieveCallRequest()

virtual int EncodeRetrieveCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
ConnectionID  callToRetrieve 
)
protectedvirtual

Encodes a RetrieveCall message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
callToRetrieveThe ConnectionID of the call to retrieve.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeROSERequestHeader()

int EncodeROSERequestHeader ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
Phase2Opcodes.Opcodes  opcode 
)

This method prepends a ROSE header to an already encoded phase 2 CSTA message.

Parameters
responseA CSTAResponseInfo object, used to communicate any exception information back to the caller.
encodeBufferAn Asn1BerEncodeBuffer instance containing the already encoded CSTA message.
opcodeThe opcode enumeration for the operation that the encoded CSTA message describes.
Returns
The length of the encoded message, including both the CSTA message and the ROSE header, or -1 if the encoding fails.

References CSTAResponseInfo.StatusMessage.

Referenced by SamsungSCM.LinkSetup().

◆ EncodeSetAgentStateRequest()

virtual int EncodeSetAgentStateRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  targetDevice,
AgentParameter  agentParam 
)
protectedvirtual

Encodes a SetFeature message to set an agent state.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
targetDeviceThe device for which the agent state will be set.
agentParamAn AgentParameter object.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetOrClearDNDRequest()

virtual int EncodeSetOrClearDNDRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  targetDevice,
bool  dndOn 
)
protectedvirtual

Encodes a SetFeature message to set or clear the Do Not Disturb setting.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
targetDeviceThe device for which Do Not Disturb is to be set or cleared.
dndOnIf true, DoNotDisturb will be turned on. If false, DoNotDisturb will be turned off.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetOrClearFwdRequest()

virtual int EncodeSetOrClearFwdRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  fromDevice,
ForwardingType  fwdType,
string  toDevice 
)
protectedvirtual

Encodes a SetFeature message to set or clear forwarding.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
fromDeviceThe device for which forwarding is to be turned on or off.
fwdTypeA ForwardingType object. This object specifies the type of forwarding and whether it is to be turned on or off.
toDeviceIf fwdType indicates that forwarding is to be turned on, then this argument is the device to which calls are to be forwarded. Otherwise, this argument is ignored and can be null.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetOrClearMWRequest()

virtual int EncodeSetOrClearMWRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  targetDevice,
bool  indicatorOn 
)
protectedvirtual

Encodes a SetFeature message to set or clear the Message Waiting indicator.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
targetDeviceThe device for which the indicator is to be turned on or off.
indicatorOnIf true, the message waiting indicator is turned on. If false, the message waiting indicator is turned off.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSnapshotDeviceRequest()

virtual int EncodeSnapshotDeviceRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  deviceToSnapshot 
)
protectedvirtual

Encodes a SnapshotDevice message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
deviceToSnapshotIdentifier (e.g., phone number) of the device for which the snapshot is desired.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeTransferCallRequest() [1/2]

virtual int EncodeTransferCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
ConnectionID  initiatedCall,
ConnectionID  originalCall 
)
protectedvirtual

Encodes a TransferCall message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
initiatedCallConnectionID of the new call initiated by the consultation call. The initiatedCall member of the ConsultationCallResult class, for example, contains this ConnectionID.
originalCallConnectionID of the original call. The somewhat confusingly named callingDevice member of the MakeCallResult class contains this ConnectionID, as does the establishedConnection member of the EstablishedEvent class.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeTransferCallRequest() [2/2]

virtual int EncodeTransferCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  heldDevice,
string  connectedDevice 
)
protectedvirtual

Encodes a TransferCall message.

Parameters
responseA CSTA ResponseInfo object.
encodeBufferAn encode buffer object into which the message will be encoded.
heldDeviceIdentifier (e.g., phone number) of the device from which the call is transferred.
connectedDeviceIdentifier (e.g., phone number) of the device to which the call is transferred.
Returns
The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ HoldCall()

virtual CSTAResponseInfo HoldCall ( ConnectionID  callToHold)
virtual

Instruct the PBX to hold a call.

Parameters
callToHoldThe ConnectionID of the call to be held.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ MakeACSEAssociation()

virtual CSTAResponseInfo MakeACSEAssociation ( )
virtual

◆ MakeCall()

virtual CSTAResponseInfo MakeCall ( string  callingDevice,
string  calledDevice 
)
virtual

Instruct the PBX to place a call.

Parameters
callingDeviceIdentifier (e.g., phone number) of the device making the call.
calledDeviceIdentifier (e.g., phone number) of the device being called.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ MonitorStart() [1/2]

virtual CSTAResponseInfo MonitorStart ( string  deviceToMonitor)
virtual

Issues a MonitorStart request to the PBX to monitor a device.

Parameters
deviceToMonitorIdentifier (e.g., telephone number) of the device to monitor.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ MonitorStart() [2/2]

virtual CSTAResponseInfo MonitorStart ( ConnectionID  callToMonitor)
virtual

Issues a MonitorStart request to the PBX to monitor a call.

Parameters
callToMonitorThe call to monitor.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ MonitorStop() [1/3]

virtual CSTAResponseInfo MonitorStop ( MonitorCrossRefID  crossRefID)
virtual

Stop a previously started PBX monitor request.

Parameters
crossRefIDThe cross reference id of the monitor request as a MonitorCrossRefID object.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ MonitorStop() [2/3]

virtual CSTAResponseInfo MonitorStop ( string  monitoredDevice)
virtual

This method stops all monitors active against the indicated device, regardless of what thread started the monitor. The method will only stop monitors started through the MonitorStart() method.

Parameters
monitoredDeviceThe monitored device (e.g., extension).
Returns
If no problems are encountered, the method returns a CSTAResponseInfo object containing the response from the PBX for the LAST Monitor Stop message.
If any problems are encountered, the method returns a CSTAResponseInfo object containing information about the error, including any response from the PBX for the problematic Monitor Stop message.

References PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ MonitorStop() [3/3]

virtual CSTAResponseInfo MonitorStop ( long  monitoredDevice)
virtual

This method stops all monitors active against the indicated device, regardless of what thread started the monitor. The method will only stop monitors started through the MonitorStart() method.

Parameters
monitoredDeviceThe device number of the monitored device.
Returns
If no problems are encountered, the method returns a CSTAResponseInfo object containing the response from the PBX for the LAST Monitor Stop message.
If any problems are encountered, the method returns a CSTAResponseInfo object containing information about the error, including any response from the PBX for the problematic Monitor Stop message.

References PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ QueryDevice()

virtual CSTAResponseInfo QueryDevice ( string  deviceToQuery)
virtual

Queries a device.

Parameters
deviceToQueryThe identification (e.g., phone number) of the device to query.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ ReleaseACSEAssociation()

virtual CSTAResponseInfo ReleaseACSEAssociation ( )
virtual

Releases an ACSE association with a PBX device.

Returns
A CSTAResponseInfo object. For this message the connection with the PBX is closed, so null is returned.

References PBXSession.SendACSEMessage(), CSTAResponseInfo.StatusCode, and CSTAResponseInfo.StatusMessage.

◆ RetrieveCall()

virtual CSTAResponseInfo RetrieveCall ( ConnectionID  callToRetrieve)
virtual

Retrieves a held call.

Parameters
callToRetrieveThe ConnectionID of the call to retrieve.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ SetAgentState()

virtual CSTAResponseInfo SetAgentState ( string  targetDevice,
AgentParameter  agentParam 
)
virtual

Sets the state of an agent.

Parameters
targetDeviceThe device for which the agent state is to be set.
agentParamAn AgentParameter object.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ SetDoNotDisturb()

virtual CSTAResponseInfo SetDoNotDisturb ( string  targetDevice)
virtual

Sets the Do Not Disturb feature for a phone.

Parameters
targetDeviceThe device for which Do Not Disturb is to be set.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ SetMessageWaiting()

virtual CSTAResponseInfo SetMessageWaiting ( string  targetDevice)
virtual

Turns on the message waiting indicator on a device's display.

Parameters
targetDeviceThe device for which the indicator is to be turned on.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ SetOrClearForwarding()

virtual CSTAResponseInfo SetOrClearForwarding ( string  fromDevice,
ForwardingType  fwdType,
string  toDevice 
)
virtual

Sets or clears forwarding for a device.

Parameters
fromDeviceThe device for which forwarding is to be turned on or off.
fwdTypeA ForwardingType object. This object specifies the type of forwarding and whether it is to be turned on or off.
toDeviceIf fwdType indicates that forwarding is to be turned on, then this argument is the device to which calls are to be forwarded. Otherwise, this argument is ignored and can be null.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ SnapshotDevice()

virtual CSTAResponseInfo SnapshotDevice ( string  deviceToSnapshot)
virtual

Instruct the PBX to take a snapshot of calls active at a device.

Parameters
deviceToSnapshotIdentifier (e.g., phone number) of the device for which the snapshot is desired.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ TransferCall() [1/2]

virtual CSTAResponseInfo TransferCall ( ConnectionID  initiatedCall,
ConnectionID  originalCall 
)
virtual

Transfers a call. A consultation call must be done before calling this method.

Parameters
initiatedCallConnectionID of the new call initiated by the consultation call. The initiatedCall member of the ConsultationCallResult class, for example, contains this ConnectionID.
originalCallConnectionID of the original call. The somewhat confusingly named callingDevice member of the MakeCallResult class contains this ConnectionID, as does the establishedConnection member of the EstablishedEvent class.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

◆ TransferCall() [2/2]

virtual CSTAResponseInfo TransferCall ( string  heldDevice,
string  connectedDevice 
)
virtual

Transfers a call from one device to another.

Parameters
heldDeviceIdentifier (e.g., phone number) of the device from which the call is transferred.
connectedDeviceIdentifier (e.g., phone number) of the device to which the call is transferred.
Returns
A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, PBXSession.SendMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and PBXSession.WaitForROSEResponse().

Property Documentation

◆ SessionObject

PBXSession SessionObject
get

The PBXSession object associated with this instance.

◆ ThreadContext

CSTAContext ThreadContext
get

The CSTAContext structure for this thread.