GenericCSTAp3 Class Reference

Inheritance diagram for GenericCSTAp3:

List of all members.

Public Member Functions
virtual CSTAResponseInfo	AnswerCall (ConnectionID callToAnswer, string deviceToLift)
virtual CSTAResponseInfo	AnswerCall (ConnectionID callToAnswer)
virtual CSTAResponseInfo	AnswerCall (string deviceToLift)
virtual CSTAResponseInfo	ClearConnection (ConnectionID connToClear)
virtual CSTAResponseInfo	ClearDoNotDisturb (string targetDevice)
virtual CSTAResponseInfo	ClearMessageWaiting (string targetDevice)
virtual CSTAResponseInfo	ConsultationCall (ConnectionID existingCall, string targetDevice)
virtual int	EncodeROSERequestHeader (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, Phase3Opcodes.Opcodes opcode)
	GenericCSTAp3 (PBXSession sessionObject)
	GenericCSTAp3 (string pbxSystem, int port)
virtual CSTAResponseInfo	GetAgentState (string targetDevice)
virtual CSTAResponseInfo	GetDoNotDisturb (string targetDevice)
virtual CSTAResponseInfo	GetSFDevices (ReqDeviceCategory deviceCategory)
virtual CSTAResponseInfo	GetSFDevices ()
virtual CSTAResponseInfo	HoldCall (ConnectionID callToHold)
virtual CSTAResponseInfo	MakeACSEAssociation ()
virtual CSTAResponseInfo	MakeCall (string callingDevice, string calledDevice)
virtual CSTAResponseInfo	MonitorStart (string deviceToMonitor)
virtual CSTAResponseInfo	MonitorStop (string monitoredDevice)
virtual CSTAResponseInfo	MonitorStop (MonitorCrossRefID crossRefID)
virtual CSTAResponseInfo	MonitorStop (int crossRefInt)
virtual CSTAResponseInfo	ReleaseACSEAssociation ()
virtual CSTAResponseInfo	RetrieveCall (ConnectionID callToRetrieve)
virtual CSTAResponseInfo	RingDevice (string targetDevice, string targetRinger, long ringPattern)
virtual CSTAResponseInfo	SendData (IOCrossRefID ioCrossRef, string text)
virtual CSTAResponseInfo	SetDisplay (string targetDevice, string text)
virtual CSTAResponseInfo	SetDoNotDisturb (string targetDevice)
virtual CSTAResponseInfo	SetMessageWaiting (string targetDevice)
virtual CSTAResponseInfo	SingleStepTransfer (SingleStepTransferInfo sstInfo)
virtual CSTAResponseInfo	SingleStepTransfer (ConnectionID callToTransfer, string transferToDevice)
virtual CSTAResponseInfo	SnapshotCall (ConnectionID callToSnapshot)
virtual CSTAResponseInfo	SnapshotDevice (string deviceToSnapshot)
virtual CSTAResponseInfo	StartDataPath (string targetDevice)
virtual CSTAResponseInfo	StopDataPath (IOCrossRefID ioCrossRef)
virtual CSTAResponseInfo	StopRing (string targetDevice, string targetRinger, long ringPattern)
virtual CSTAResponseInfo	TransferCall (TransferCallInfo tcInfo)
virtual CSTAResponseInfo	TransferCall (ConnectionID initiatedCall, ConnectionID originalCall)
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	(	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

(

PBXSession

sessionObject

)

Constructs an instance associated with the given PBXSession object.

Parameters:

sessionObject

A PBXSession object.

---

Member Function Documentation

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.

virtual CSTAResponseInfo AnswerCall

(

ConnectionID

callToAnswer

)

[virtual]

Answers a call.

Parameters:

callToAnswer

The ConnectionID of the call to answer.

Returns:

A CSTAResponseInfo object.

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.

virtual CSTAResponseInfo ClearConnection

(

ConnectionID

connToClear

)

[virtual]

Clears a connection.

Parameters:

connToClear

The ConnectionID of the connection to clear.

Returns:

A CSTAResponseInfo object.

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.

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.

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.

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.

virtual CSTAResponseInfo GetAgentState

(

string

targetDevice

)

[virtual]

Gets the state of the agent associated with a device.

Parameters:

targetDevice

The device whose agent state is desired.

Returns:

A CSTAResponseInfo object.

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.

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.

virtual CSTAResponseInfo GetSFDevices

(

)

[virtual]

Sends a Get Switching Function Devices request to the PBX.

Returns:

A CSTAResponseInfo object.

Reimplemented in PanasonicKXTDE.

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.

virtual CSTAResponseInfo MakeACSEAssociation

(

)

[virtual]

Establish an ACSE association with the PBX.

Returns:

A CSTAResponseInfo object.

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.

virtual CSTAResponseInfo MonitorStart

(

string

deviceToMonitor

)

[virtual]

Issues a MonitorStart request to the PBX.

Parameters:

deviceToMonitor

Identifier (e.g., telephone number) of the device to monitor.

Returns:

A CSTAResponseInfo object.

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.

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.

virtual CSTAResponseInfo MonitorStop

(

int

crossRefInt

)

[virtual]

Stop a previously started PBX monitor request.

Parameters:

crossRefInt

The cross reference id of the monitor request as an integer.

Returns:

A CSTAResponseInfo object.

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.

virtual CSTAResponseInfo RetrieveCall

(

ConnectionID

callToRetrieve

)

[virtual]

Retrieves a held call.

Parameters:

callToRetrieve

The ConnectionID of the call to retrieve.

Returns:

A CSTAResponseInfo object.

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.

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.

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.

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.

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.

virtual CSTAResponseInfo SingleStepTransfer

(

SingleStepTransferInfo

sstInfo

)

[virtual]

Perform a single step transfer.

Parameters:

sstInfo

A SingleStepTransferInfo object.

Returns:

A CSTAResponseInfo object.

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.

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.

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.

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.

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.

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.

virtual CSTAResponseInfo TransferCall

(

TransferCallInfo

tcInfo

)

[virtual]

Transfers a call from one device to another.

Parameters:

tcInfo

A TransferCallInfo object.

Returns:

A CSTAResponseInfo object.

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.

---

Property Documentation

PBXSession SessionObject [get]

The PBXSession object associated with this instance.

CSTAContext ThreadContext [get]

The CSTAContext structure for this thread.