Inheritance diagram for GenericCSTAp3:

Public Member Functions
virtual CSTAResponseInfo	AcceptCall (ConnectionID callToAccept)

virtual CSTAResponseInfo	AlternateCall (ConnectionID heldCall, ConnectionID activeCall)

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	ClearForwarding (string fromDevice, ForwardingType fwdType)

virtual CSTAResponseInfo	ClearMessageWaiting (string targetDevice)

virtual CSTAResponseInfo	ConferenceCall (ConnectionID heldCall, ConnectionID activeCall)

virtual CSTAResponseInfo	ConsultationCall (ConnectionID existingCall, string targetDevice)

virtual CSTAResponseInfo	ConsultationCall (ConnectionID existingCall, string targetDevice, ConsultOptions options)

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

	GenericCSTAp3 (string pbxSystem, int port)

	GenericCSTAp3 (PBXSession sessionObject)

virtual CSTAResponseInfo	GetAgentState (string agentDevice)

virtual CSTAResponseInfo	GetDoNotDisturb (string targetDevice)

virtual CSTAResponseInfo	GetLogicalDevInfo (string targetDevice)

virtual CSTAResponseInfo	GetPhysicalDevInfo (string targetDevice)

virtual CSTAResponseInfo	GetSFDevices ()

virtual CSTAResponseInfo	GetSFDevices (ReqDeviceCategory deviceCategory)

virtual CSTAResponseInfo	HoldCall (ConnectionID callToHold)

virtual CSTAResponseInfo	MakeACSEAssociation ()

virtual CSTAResponseInfo	MakeCall (string callingDevice, string calledDevice)

virtual CSTAResponseInfo	MakeCall (string callingDevice, string calledDevice, bool autoOriginate)

virtual CSTAResponseInfo	MonitorStart (string deviceToMonitor)

virtual CSTAResponseInfo	MonitorStart (long deviceToMonitor)

virtual CSTAResponseInfo	MonitorStart (ConnectionID callToMonitor)

virtual CSTAResponseInfo	MonitorStop (MonitorCrossRefID crossRefID)

virtual CSTAResponseInfo	MonitorStop (string monitoredDevice)

virtual CSTAResponseInfo	MonitorStop (long monitoredDevice)

virtual CSTAResponseInfo	ReleaseACSEAssociation ()

virtual CSTAResponseInfo	RequestSystemStatus ()

virtual CSTAResponseInfo	RetrieveCall (ConnectionID callToRetrieve)

virtual CSTAResponseInfo	RingDevice (string targetDevice, string targetRinger, long ringPattern)

virtual CSTAResponseInfo	SendData (IOCrossRefID ioCrossRef, string text)

virtual CSTAResponseInfo	SendStoredCDR (CDRCrossRefID cdrCrossRefID)

virtual CSTAResponseInfo	SetAgentState (string agentDevice, ReqAgentState agentState, AgentID aid)

virtual CSTAResponseInfo	SetAgentState (string agentDevice, ReqAgentState agentState)

virtual CSTAResponseInfo	SetDisplay (string targetDevice, string text)

virtual CSTAResponseInfo	SetDoNotDisturb (string targetDevice)

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

virtual CSTAResponseInfo	SetMessageWaiting (string targetDevice)

virtual CSTAResponseInfo	SingleStepTransfer (ConnectionID callToTransfer, string transferToDevice)

virtual CSTAResponseInfo	SingleStepTransfer (SingleStepTransferInfo sstInfo)

virtual CSTAResponseInfo	SnapshotCall (ConnectionID callToSnapshot)

virtual CSTAResponseInfo	SnapshotDevice (string deviceToSnapshot)

virtual CSTAResponseInfo	StartCDRTransmission (CDRTransferMode transferMode)

virtual CSTAResponseInfo	StartDataPath (string targetDevice)

virtual CSTAResponseInfo	StopCDRTransmission (CDRCrossRefID cdrCrossRefID)

virtual CSTAResponseInfo	StopDataPath (IOCrossRefID ioCrossRef)

virtual CSTAResponseInfo	StopRing (string targetDevice, string targetRinger, long ringPattern)

virtual CSTAResponseInfo	TransferCall (ConnectionID initiatedCall, ConnectionID originalCall)

virtual CSTAResponseInfo	TransferCall (TransferCallInfo tcInfo)

Protected Member Functions
virtual int	EncodeAcceptCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToAccept)

virtual int	EncodeACSEConnectionRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer)

virtual int	EncodeACSEReleaseRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer)

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

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, ConsultOptions options)

virtual int	EncodeGetAgentStateRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string agentDevice)

virtual int	EncodeGetDNDRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice)

virtual int	EncodeGetLogicalDevInfoRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice)

virtual int	EncodeGetPhysicalDevInfoRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice)

virtual int	EncodeGetSFDevicesRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ReqDeviceCategory deviceCategory)

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

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

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

virtual int	EncodeMonitorStartRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, long deviceToMonitor)

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

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

virtual int	EncodeRequestSysStatRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer)

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

virtual int	EncodeSendDataRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, IOCrossRefID ioCrossRef, string text)

virtual int	EncodeSendStoredCDRRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, CDRCrossRefID cdrCrossRefID)

virtual int	EncodeSetAgentStateRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string agentDevice, ReqAgentState agentState, AgentID aid)

virtual int	EncodeSetDisplayRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice, string text)

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

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

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

virtual int	EncodeSetRingerStatusRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice, string targetRinger, RingMode mode, long ringPattern)

virtual int	EncodeSingleStepTransferRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToTransfer, string transferToDevice)

virtual int	EncodeSingleStepTransferRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, SingleStepTransferInfo sstInfo)

virtual int	EncodeSnapshotCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToSnapshot)

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

virtual int	EncodeStartCDRTransRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, CDRTransferMode transferMode)

virtual int	EncodeStartDataPathRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice)

virtual int	EncodeStopCDRTransRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, CDRCrossRefID cdrCrossRefID)

virtual int	EncodeStopDataPathRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, IOCrossRefID ioCrossRef)

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

virtual int	EncodeTransferCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, TransferCallInfo tcInfo)

Properties
PBXSession	SessionObject `[get]`

CSTAContext	ThreadContext `[get]`

Detailed Description

Implements CSTA phase 3 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

◆ GenericCSTAp3() [1/2]

GenericCSTAp3	(	string	pbxSystem,
		int	port
	)

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

Parameters

pbxSystem	Well-known name or IP address of the PBX.
port	Port on which the PBX listens for CSTA messages.

◆ GenericCSTAp3() [2/2]

GenericCSTAp3 ( PBXSession sessionObject )

Constructs an instance associated with the given PBXSession object.

Parameters

sessionObject A PBXSession object.

Member Function Documentation

◆ AcceptCall()

virtual CSTAResponseInfo AcceptCall ( ConnectionID callToAccept )

virtual

Accepts a call.

Parameters

callToAccept The ConnectionID of the call to accept.

Returns: A CSTAResponseInfo object.

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

◆ AlternateCall()

virtual CSTAResponseInfo AlternateCall	(	ConnectionID	heldCall,
		ConnectionID	activeCall
	)

virtual

Places an existing active call on hold and then either retrieves a previously held call or connects to an alerting or queued call at the same device (e.g., to answer a call waiting call).

Parameters

heldCall	The held call to be retrieved.
activeCall	The active call to be placed on hold.

Returns: A CSTAResponseInfo object.

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

◆ AnswerCall() [1/3]

virtual CSTAResponseInfo AnswerCall ( string deviceToLift )

virtual

Answers a call.

Parameters

deviceToLift The 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

callToAnswer The 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

callToAnswer	ConnectionID of an existing call (such as initiated through MakeCall()).
deviceToLift	The device (e.g., "800") 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

connToClear The 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

targetDevice The 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().

◆ ClearForwarding()

virtual CSTAResponseInfo ClearForwarding	(	string	fromDevice,
		ForwardingType	fwdType
	)

virtual

Clears the forwarding feature for a phone.

Parameters

fromDevice	The device for which forwarding is to be cleared. This is the device from which calls are being forwarded to a different device.
fwdType	The type of forwarding to clear.

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

targetDevice The 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

heldCall	The held call to be brought into conference.
activeCall	The active call.

Returns: A CSTAResponseInfo object.

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

◆ ConsultationCall() [1/2]

virtual CSTAResponseInfo ConsultationCall	(	ConnectionID	existingCall,
		string	targetDevice
	)

virtual

Instruct the PBX to do a consultation call.

Parameters

existingCall	The connection id of the call for which the consultation call will be made.
targetDevice	Identifier (e.g., phone number) of the device that is the target of the consultation call.

Returns: A CSTAResponseInfo object.

◆ ConsultationCall() [2/2]

virtual CSTAResponseInfo ConsultationCall	(	ConnectionID	existingCall,
		string	targetDevice,
		ConsultOptions	options
	)

virtual

Instruct the PBX to do a consultation call.

Parameters

existingCall	The connection id of the call for which the consultation call will be made.
targetDevice	Identifier (e.g., phone number) of the device that is the target of the consultation call.
options	A ConsultOptions object.

Returns: A CSTAResponseInfo object.

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

◆ EncodeAcceptCallRequest()

virtual int EncodeAcceptCallRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		ConnectionID	callToAccept
	)

protectedvirtual

Encodes an AcceptCall message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
callToAccept	The ConnectionID of the call to accept.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeACSEConnectionRequest()

virtual int EncodeACSEConnectionRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer
	)

protectedvirtual

Encodes an ACSE Association Request message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An 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 PanasonicKXNS, PanasonicKXTDE, SiemensCap, SiemensHipath3000p3, and UnifyOpenscape4000BER.

References CSTAResponseInfo.StatusMessage.

◆ EncodeACSEReleaseRequest()

virtual int EncodeACSEReleaseRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer
	)

protectedvirtual

Encodes an ACSE Release Request message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An 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.StatusMessage.

◆ EncodeAlternateCallRequest()

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

protectedvirtual

Encodes an AlternateCall message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
heldCall	ConnectionID of the held call to be retrieved.
activeCall	ConnectionID of the active call to be placed on hold.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeAnswerCallRequest() [1/3]

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

protectedvirtual

Encodes an AnswerCall message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
deviceToLift	The 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

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
callToAnswer	The 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

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
callToAnswer	The ConnectionID of the call to answer.
deviceToLift	The 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

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
connToClear	The 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

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
heldCall	ConnectionID of the held call to be retrieved.
activeCall	ConnectionID 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,
		ConsultOptions	options
	)

protectedvirtual

Encodes a ConsultationCall message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
existingCall	The connection id of the call for which the consultation call will be made.
targetDevice	Identifier (e.g., phone number) of the device that is the target of the consultation call.
options	A ConsultOptions object.

Returns: The length of the encoded message, or -1 if an error occurred.

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

◆ EncodeGetAgentStateRequest()

virtual int EncodeGetAgentStateRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		string	agentDevice
	)

protectedvirtual

Encodes a GetAgentState message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
agentDevice	The device associated with the agent.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeGetDNDRequest()

virtual int EncodeGetDNDRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		string	targetDevice
	)

protectedvirtual

Encodes a GetDoNotDisturb message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
targetDevice	The phone for which the Do Not Disturb setting is desired.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeGetLogicalDevInfoRequest()

virtual int EncodeGetLogicalDevInfoRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		string	targetDevice
	)

protectedvirtual

Encodes a GetLogicalDeviceInformation message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
targetDevice	The device for which the information is needed.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeGetPhysicalDevInfoRequest()

virtual int EncodeGetPhysicalDevInfoRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		string	targetDevice
	)

protectedvirtual

Encodes a GetPhysicalDeviceInformation message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
targetDevice	The device for which the information is needed.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeGetSFDevicesRequest()

virtual int EncodeGetSFDevicesRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		ReqDeviceCategory	deviceCategory
	)

protectedvirtual

Encodes a GetSwitchingFunctionDevices message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
deviceCategory	The category of device for which the list is desired.

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

response	A CSTAResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
callToHold	The 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,
		bool	autoOriginate
	)

protectedvirtual

Encodes a MakeCall message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
callingDevice	Identifier (e.g., phone number) of the device making the call.
calledDevice	Identifier (e.g., phone number) of the device being called.
autoOriginate	If true, the call will be answered automatically (if the PBX supports this feature). If false, the called device will alert.

Returns: The length of the encoded message, or -1 if an error occurred.

Reimplemented in PanasonicKXNS, and PanasonicKXTDE.

References CSTAResponseInfo.StatusMessage.

◆ EncodeMonitorStartRequest() [1/3]

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

protectedvirtual

Encodes a MonitorStart message to monitor a device.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
deviceToMonitor	Identifier (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/3]

virtual int EncodeMonitorStartRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		long	deviceToMonitor
	)

protectedvirtual

Encodes a MonitorStart message to monitor a device.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
deviceToMonitor	Device number of the device to monitor.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeMonitorStartRequest() [3/3]

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

protectedvirtual

Encodes a MonitorStart message to monitor a call.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
callToMonitor	The 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

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
crossRefObj	The 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.

◆ EncodeRequestSysStatRequest()

virtual int EncodeRequestSysStatRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer
	)

protectedvirtual

Encodes a RequestSystemStatus message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An 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.StatusMessage.

◆ EncodeRetrieveCallRequest()

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

protectedvirtual

Encodes a RetrieveCall message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
callToRetrieve	The ConnectionID of the call to retrieve.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeROSERequestHeader()

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

virtual

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

Parameters

response	A CSTAResponseInfo object, used to communicate any exception information back to the caller.
encodeBuffer	An Asn1BerEncodeBuffer instance containing the already encoded CSTA message.
opcode	The 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.

◆ EncodeSendDataRequest()

virtual int EncodeSendDataRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		IOCrossRefID	ioCrossRef,
		string	text
	)

protectedvirtual

Encodes a SendData message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
ioCrossRef	An IOCrossRefID object, most likely obtained by a previous call to StartDataPath.
text	The text to send to the telephony device.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSendStoredCDRRequest()

virtual int EncodeSendStoredCDRRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		CDRCrossRefID	cdrCrossRefID
	)

protectedvirtual

Encodes a SendStoredCallDetailRecords message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
cdrCrossRefID	The CDR cross reference id that was returned in the response to a previously issued StartCDRTransmission() call.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetAgentStateRequest()

virtual int EncodeSetAgentStateRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		string	agentDevice,
		ReqAgentState	agentState,
		AgentID	aid
	)

protectedvirtual

Encodes a SetAgentState message.

Parameters

response	A CSTAResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
agentDevice	The device associated with the agent.
agentState	An ReqAgentState object indicating the desired state of the agent.
aid	The agent id as an AgentID object.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetDisplayRequest()

virtual int EncodeSetDisplayRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		string	targetDevice,
		string	text
	)

protectedvirtual

Encodes a SetDisplay message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
targetDevice	The device to which the text is to be sent.
text	The text to be sent.

Returns: The length of the encoded message, or -1 if an error occurred.

Reimplemented in PanasonicKXNS, and PanasonicKXTDE.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetOrClearDNDRequest()

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

protectedvirtual

Encodes a SetDoNotDisturb message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
targetDevice	The device for which Do Not Disturb is to be set or cleared.
dndOn	If 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,
		bool	fwdOn,
		ForwardingType	fwdType,
		string	toDevice
	)

protectedvirtual

Encodes a SetForwarding message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
fromDevice	The device for which forwarding is to be set or cleared. In the case of setting forwarding, this is the device from which calls are to be forwarded to a different device. In the case of clearing forwarding, this is the device from which calls are currently being forwarded to a different device.
fwdOn	If true, forwarding will be turned on. If false, forwarding will be turned off.
fwdType	The type of forwarding to set or clear.
toDevice	The device to which calls are to be forwarded from the device indicated by the fromDevice parameter. If forwarding is being cleared, this parameter is ignored and can be set to 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 SetMessageWaiting message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
targetDevice	The device for which the indicator is to be turned on or off.
indicatorOn	If 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.

◆ EncodeSetRingerStatusRequest()

virtual int EncodeSetRingerStatusRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		string	targetDevice,
		string	targetRinger,
		RingMode	mode,
		long	ringPattern
	)

protectedvirtual

Encodes a SetRingerStatus message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
targetDevice	The device whose ringer is to be affected.
targetRinger	The id of the ringer to use for the operation. This argument can be specified as a character string (e.g, "abc"), a hex string (e.g, "'010A05'H"), or a binary string (e.g, "'000000010000101000000101'B").
mode	A RingMode object that specifies ringing or notRinging.
ringPattern	The indicator of the ring pattern to use.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSingleStepTransferRequest() [1/2]

virtual int EncodeSingleStepTransferRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		ConnectionID	callToTransfer,
		string	transferToDevice
	)

protectedvirtual

Encodes a SingleStepTransfer message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
callToTransfer	The ConnectionID of the call to transfer.
transferToDevice	The device to which the call is to be transferred.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSingleStepTransferRequest() [2/2]

virtual int EncodeSingleStepTransferRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		SingleStepTransferInfo	sstInfo
	)

protectedvirtual

Encodes a SingleStepTransfer message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
sstInfo	A SingleStepTransferInfo object.

Returns: The length of the encoded message, or -1 if an error occurred.

Reimplemented in SiemensHipath3000p3.

References CSTAResponseInfo.StatusMessage, SingleStepTransferInfo.TransferFromDevice, SingleStepTransferInfo.TransferringCallID, and SingleStepTransferInfo.TransferToDevice.

◆ EncodeSnapshotCallRequest()

virtual int EncodeSnapshotCallRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		ConnectionID	callToSnapshot
	)

protectedvirtual

Encodes a SnapshotCall message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
callToSnapshot	The ConnectionID of the call for which the snapshot is desired.

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

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
deviceToSnapshot	Identifier (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.

◆ EncodeStartCDRTransRequest()

virtual int EncodeStartCDRTransRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		CDRTransferMode	transferMode
	)

protectedvirtual

Encodes a StartCallDetailRecordsTransmission message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
transferMode	The mode the PBX is to use to transfer call detail records.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeStartDataPathRequest()

virtual int EncodeStartDataPathRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		string	targetDevice
	)

protectedvirtual

Encodes a StartDataPath message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
targetDevice	Specifies the device to which a data path is to be opened.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeStopCDRTransRequest()

virtual int EncodeStopCDRTransRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		CDRCrossRefID	cdrCrossRefID
	)

protectedvirtual

Encodes a StopCallDetailRecordsTransmission message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
cdrCrossRefID	The CDR cross reference id that was returned in the response to a previously issued StartCDRTransmission() call.

Returns: The length of the encoded message, or -1 if an error occurred.

References CSTAResponseInfo.StatusMessage.

◆ EncodeStopDataPathRequest()

virtual int EncodeStopDataPathRequest	(	CSTAResponseInfo	response,
		Asn1BerEncodeBuffer	encodeBuffer,
		IOCrossRefID	ioCrossRef
	)

protectedvirtual

Encodes a StopDataPath message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
ioCrossRef	An IOCrossRef object, most likely obtained from a previous call to StartDataPath.

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

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
initiatedCall	ConnectionID of the new call initiated by the consultation call. The initiatedCall member of the ConsultationCallResult class, for example, contains this ConnectionID.
originalCall	ConnectionID 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,
		TransferCallInfo	tcInfo
	)

protectedvirtual

Encodes a TransferCall message.

Parameters

response	A CSTA ResponseInfo object.
encodeBuffer	An encode buffer object into which the message will be encoded.
tcInfo	A TransferCallInfo object.

Returns: The length of the encoded message, or -1 if an error occurred.

References TransferCallInfo.ActiveDeviceCallID, TransferCallInfo.ActiveDeviceNumber, TransferCallInfo.HeldDeviceCallID, TransferCallInfo.HeldDeviceNumber, and CSTAResponseInfo.StatusMessage.

◆ GetAgentState()

virtual CSTAResponseInfo GetAgentState ( string agentDevice )

virtual

Gets the state of the agent associated with a device.

Parameters

agentDevice The device associated with the agent.

Returns: A CSTAResponseInfo object.

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

◆ GetDoNotDisturb()

virtual CSTAResponseInfo GetDoNotDisturb ( string targetDevice )

virtual

Gets the Do Not Disturb setting for a phone.

Parameters

targetDevice The phone for which the Do Not Disturb setting is desired.

Returns: A CSTAResponseInfo object.

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

◆ GetLogicalDevInfo()

virtual CSTAResponseInfo GetLogicalDevInfo ( string targetDevice )

virtual

Gets information about the logical element of a device.

Parameters

targetDevice The device for which the information is desired.

Returns: A CSTAResponseInfo object.

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

◆ GetPhysicalDevInfo()

virtual CSTAResponseInfo GetPhysicalDevInfo ( string targetDevice )

virtual

Gets information about the physical element of a device.

Parameters

targetDevice The device for which the information is desired.

Returns: A CSTAResponseInfo object.

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

◆ GetSFDevices() [1/2]

virtual CSTAResponseInfo GetSFDevices ( )

virtual

Sends a Get Switching Function Devices request to the PBX.

Returns: A CSTAResponseInfo object.

Reimplemented in PanasonicKXNS, and PanasonicKXTDE.

◆ GetSFDevices() [2/2]

virtual CSTAResponseInfo GetSFDevices ( ReqDeviceCategory deviceCategory )

virtual

Sends a Get Switching Function Devices request to the PBX.

Parameters

deviceCategory The category of device for which the list is desired.

Returns: A CSTAResponseInfo object.

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

◆ HoldCall()

virtual CSTAResponseInfo HoldCall ( ConnectionID callToHold )

virtual

Instruct the PBX to hold a call.

Parameters

callToHold The 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

Establish an ACSE association with the PBX.

Returns: A CSTAResponseInfo object.

References PBXSession.Close(), SocketState.ReadBuffer, CSTAResponseInfo.ResponseFromPBX, PBXSession.SendACSEMessage(), CSTAResponseInfo.StatusCode, CSTAResponseInfo.StatusMessage, and SocketState.TotalLength.

◆ MakeCall() [1/2]

virtual CSTAResponseInfo MakeCall	(	string	callingDevice,
		string	calledDevice
	)

virtual

Instruct the PBX to place a call.

Parameters

callingDevice	Identifier (e.g., phone number) of the device making the call.
calledDevice	Identifier (e.g., phone number) of the device being called.

Returns: A CSTAResponseInfo object.

◆ MakeCall() [2/2]

virtual CSTAResponseInfo MakeCall	(	string	callingDevice,
		string	calledDevice,
		bool	autoOriginate
	)

virtual

Instruct the PBX to place a call.

Parameters

callingDevice	Identifier (e.g., phone number) of the device making the call.
calledDevice	Identifier (e.g., phone number) of the device being called.
autoOriginate	If true, the call will be answered automatically (if the PBX supports this feature). If false, the called device will alert.

Returns: A CSTAResponseInfo object.

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

◆ MonitorStart() [1/3]

virtual CSTAResponseInfo MonitorStart ( string deviceToMonitor )

virtual

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

Parameters

deviceToMonitor Identifier (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/3]

virtual CSTAResponseInfo MonitorStart ( long deviceToMonitor )

virtual

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

Parameters

deviceToMonitor Device number of the device to monitor.

Returns: A CSTAResponseInfo object.

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

◆ MonitorStart() [3/3]

virtual CSTAResponseInfo MonitorStart ( ConnectionID callToMonitor )

virtual

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

Parameters

callToMonitor The 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

crossRefID The 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

monitoredDevice The 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

monitoredDevice The 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().

◆ 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.

◆ RequestSystemStatus()

virtual CSTAResponseInfo RequestSystemStatus ( )

virtual

Retrieves a system status from the PBX.

Returns: A CSTAResponseInfo object.

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

◆ RetrieveCall()

virtual CSTAResponseInfo RetrieveCall ( ConnectionID callToRetrieve )

virtual

Retrieves a held call.

Parameters

callToRetrieve The ConnectionID of the call to retrieve.

Returns: A CSTAResponseInfo object.

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

◆ RingDevice()

virtual CSTAResponseInfo RingDevice	(	string	targetDevice,
		string	targetRinger,
		long	ringPattern
	)

virtual

Causes a telephony device to ring.

Parameters

targetDevice	The device to ring.
targetRinger	The id of the ringer to use for the ring. This argument can be specified as a character string (e.g, "abc"), a hex string (e.g, "'010A05'H"), or a binary string (e.g, "'000000010000101000000101'B").
ringPattern	The indicator of the ring pattern to use.

Returns: A CSTAResponseInfo object.

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

◆ SendData()

virtual CSTAResponseInfo SendData	(	IOCrossRefID	ioCrossRef,
		string	text
	)

virtual

Sends a text message to a telephony device.

Parameters

ioCrossRef	An IOCrossRefID object, most likely obtained by a previous call to StartDataPath.
text	The text to send to the telephony device.

Returns: A CSTAResponseInfo object.

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

◆ SendStoredCDR()

virtual CSTAResponseInfo SendStoredCDR ( CDRCrossRefID cdrCrossRefID )

virtual

Issues a SendStoredCallDetailRecords request to the PBX. A CDRCallback method (see PBXSession.CDRCallback) must be defined in order to receive CDR messages.

Parameters

cdrCrossRefID The CDR cross reference id that was returned in the response to a previously issued StartCDRTransmission() call.

Returns: A CSTAResponseInfo object.

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

◆ SetAgentState() [1/2]

virtual CSTAResponseInfo SetAgentState	(	string	agentDevice,
		ReqAgentState	agentState,
		AgentID	aid
	)

virtual

Sets the state of the agent associated with a device.

Parameters

agentDevice	The device associated with the agent.
agentState	The desired state for the agent.
aid	The agent id.

Returns: A CSTAResponseInfo object.

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

◆ SetAgentState() [2/2]

virtual CSTAResponseInfo SetAgentState	(	string	agentDevice,
		ReqAgentState	agentState
	)

virtual

Sets the state of the agent associated with a device.

Parameters

agentDevice	The device associated with the agent.
agentState	The desired state for the agent.

Returns: A CSTAResponseInfo object.

◆ SetDisplay()

virtual CSTAResponseInfo SetDisplay	(	string	targetDevice,
		string	text
	)

virtual

Sends text to a telephony device's display

Parameters

targetDevice	The device to which the text is to be sent.
text	The text to be sent.

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

targetDevice The 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().

◆ SetForwarding()

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

virtual

Sets the forwarding feature for a phone.

Parameters

fromDevice	The device for which forwarding is to be set. This is the device from which calls are to be forwarded to a different device.
fwdType	The type of forwarding to set.
toDevice	The device to which calls are to be forwarded from the device indicated by the fromDevice parameter.

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

targetDevice The 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().

◆ SingleStepTransfer() [1/2]

virtual CSTAResponseInfo SingleStepTransfer	(	ConnectionID	callToTransfer,
		string	transferToDevice
	)

virtual

Perform a single step transfer.

Parameters

callToTransfer	The ConnectionID of the call to transfer.
transferToDevice	The device to which the call is to be transferred.

Returns: A CSTAResponseInfo object.

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

◆ SingleStepTransfer() [2/2]

virtual CSTAResponseInfo SingleStepTransfer ( SingleStepTransferInfo sstInfo )

virtual

Perform a single step transfer.

Parameters

sstInfo A SingleStepTransferInfo object.

Returns: A CSTAResponseInfo object.

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

◆ SnapshotCall()

virtual CSTAResponseInfo SnapshotCall ( ConnectionID callToSnapshot )

virtual

Instruct the PBX to take a snapshot of a call.

Parameters

callToSnapshot The ConnectionID of the call for which the snapshot is desired.

Returns: A CSTAResponseInfo object.

References CSTAResponseInfo.ResponseFromPBX, CSTAResponseInfo.ResponsesFromPBX, 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

deviceToSnapshot Identifier (e.g., phone number) of the device for which the snapshot is desired.

Returns: A CSTAResponseInfo object.

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

◆ StartCDRTransmission()

virtual CSTAResponseInfo StartCDRTransmission ( CDRTransferMode transferMode )

virtual

Issues a StartCallDetailRecordsTransmission request to the PBX. A CDR callback method (see PBXSession.CDRCallback) must be defined in order to receive CDR messages.

Parameters

transferMode Indicates how the PBX is to transfer the CDR information.

Returns: A CSTAResponseInfo object.

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

◆ StartDataPath()

virtual CSTAResponseInfo StartDataPath ( string targetDevice )

virtual

Opens up a data path to a specified device.

Parameters

targetDevice Specifies the device to which a data path is to be opened.

Returns: A CSTAResponseInfo object.

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

◆ StopCDRTransmission()

virtual CSTAResponseInfo StopCDRTransmission ( CDRCrossRefID cdrCrossRefID )

virtual

Issues a StopCallDetailRecordsTransmission request to the PBX.

Parameters

cdrCrossRefID The CDR cross reference id that was returned in the response to a previously issued StartCDRTransmission() call.

Returns: A CSTAResponseInfo object.

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

◆ StopDataPath()

virtual CSTAResponseInfo StopDataPath ( IOCrossRefID ioCrossRef )

virtual

Stops a previously established data path

Parameters

ioCrossRef An IOCrossRef object, most likely obtained from a previous call to StartDataPath.

Returns: A CSTAResponseInfo object.

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

◆ StopRing()

virtual CSTAResponseInfo StopRing	(	string	targetDevice,
		string	targetRinger,
		long	ringPattern
	)

virtual

Stops a ringer on a telephony device.

Parameters

targetDevice	The device for which the ringer is to stop.
targetRinger	The id of the ringer to stop. This argument can be specified as a character string (e.g, "abc"), a hex string (e.g, "'010A05'H"), or a binary string (e.g, "'000000010000101000000101'B").
ringPattern	The indicator of the ring pattern to stop.

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

initiatedCall	ConnectionID of the new call initiated by the consultation call. The initiatedCall member of the ConsultationCallResult class, for example, contains this ConnectionID.
originalCall	ConnectionID 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 ( TransferCallInfo tcInfo )

virtual

Transfers a call from one device to another.

Parameters

tcInfo A TransferCallInfo object.

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.

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ GenericCSTAp3() [1/2]

◆ GenericCSTAp3() [2/2]

Member Function Documentation

◆ AcceptCall()

◆ AlternateCall()

◆ AnswerCall() [1/3]

◆ AnswerCall() [2/3]

◆ AnswerCall() [3/3]

◆ ClearConnection()

◆ ClearDoNotDisturb()

◆ ClearForwarding()

◆ ClearMessageWaiting()

◆ ConferenceCall()

◆ ConsultationCall() [1/2]

◆ ConsultationCall() [2/2]

◆ EncodeAcceptCallRequest()

◆ EncodeACSEConnectionRequest()

◆ EncodeACSEReleaseRequest()

◆ EncodeAlternateCallRequest()

◆ EncodeAnswerCallRequest() [1/3]

◆ EncodeAnswerCallRequest() [2/3]

◆ EncodeAnswerCallRequest() [3/3]

◆ EncodeClearConnectionRequest()

◆ EncodeConferenceCallRequest()

◆ EncodeConsultationCallRequest()

◆ EncodeGetAgentStateRequest()

◆ EncodeGetDNDRequest()

◆ EncodeGetLogicalDevInfoRequest()

◆ EncodeGetPhysicalDevInfoRequest()

◆ EncodeGetSFDevicesRequest()

◆ EncodeHoldCallRequest()

◆ EncodeMakeCallRequest()

◆ EncodeMonitorStartRequest() [1/3]

◆ EncodeMonitorStartRequest() [2/3]

◆ EncodeMonitorStartRequest() [3/3]

◆ EncodeMonitorStopRequest()

◆ EncodeRequestSysStatRequest()

◆ EncodeRetrieveCallRequest()

◆ EncodeROSERequestHeader()

◆ EncodeSendDataRequest()

◆ EncodeSendStoredCDRRequest()

◆ EncodeSetAgentStateRequest()

◆ EncodeSetDisplayRequest()

◆ EncodeSetOrClearDNDRequest()

◆ EncodeSetOrClearFwdRequest()

◆ EncodeSetOrClearMWRequest()

◆ EncodeSetRingerStatusRequest()

◆ EncodeSingleStepTransferRequest() [1/2]

◆ EncodeSingleStepTransferRequest() [2/2]

◆ EncodeSnapshotCallRequest()

◆ EncodeSnapshotDeviceRequest()

◆ EncodeStartCDRTransRequest()

◆ EncodeStartDataPathRequest()

◆ EncodeStopCDRTransRequest()

◆ EncodeStopDataPathRequest()

◆ EncodeTransferCallRequest() [1/2]

◆ EncodeTransferCallRequest() [2/2]

◆ GetAgentState()

◆ GetDoNotDisturb()

◆ GetLogicalDevInfo()

◆ GetPhysicalDevInfo()

◆ GetSFDevices() [1/2]

◆ GetSFDevices() [2/2]

◆ HoldCall()

◆ MakeACSEAssociation()

◆ MakeCall() [1/2]

◆ MakeCall() [2/2]

◆ MonitorStart() [1/3]

◆ MonitorStart() [2/3]

◆ MonitorStart() [3/3]

◆ MonitorStop() [1/3]

◆ MonitorStop() [2/3]

◆ MonitorStop() [3/3]

◆ ReleaseACSEAssociation()

◆ RequestSystemStatus()