Home > Support > Documentation

GenericCSTAp3 Class Reference

Inheritance diagram for GenericCSTAp3:
SiemensHipath3000p3 IETF_CSTAp3 PanasonicKXTDE SiemensCap PanasonicKXTDA PanasonicNCP SiemensHipath4000

List of all members.

Public Member Functions

virtual CSTAResponseInfo AnswerCall (ConnectionID callToAnswer, string deviceToLift)
virtual CSTAResponseInfo AnswerCall (string deviceToLift)
virtual CSTAResponseInfo ClearMessageWaiting (string targetDevice)
virtual CSTAResponseInfo ConsultationCall (ConnectionID existingCall, string targetDevice)
virtual int EncodeROSERequestHeader (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, Phase3Opcodes.Opcodes opcode, out InvokeId savedInvokeId)
 GenericCSTAp3 ()
virtual CSTAResponseInfo GetSFDevices (ReqDeviceCategory deviceCategory)
virtual CSTAResponseInfo GetSFDevices ()
virtual CSTAResponseInfo MakeACSEAssociation ()
virtual CSTAResponseInfo MakeCall (string callingDevice, string calledDevice)
virtual CSTAResponseInfo MonitorStart (string deviceToMonitor)
virtual CSTAResponseInfo MonitorStop (MonitorCrossRefID crossRefId)
virtual CSTAResponseInfo MonitorStop (int crossRefId)
virtual CSTAResponseInfo ReleaseACSEAssociation ()
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 SetMessageWaiting (string targetDevice)
virtual CSTAResponseInfo SingleStepTransfer (SingleStepTransferInfo sstInfo)
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 existingCall, string targetDevice)
virtual CSTAResponseInfo TransferCallAfterConsult (ConnectionID initiatedCall, ConnectionID originalCall)

Detailed Description

Implements CSTA phase 3 operations using BER.

Constructor & Destructor Documentation

GenericCSTAp3 (  ) 

Default constructor. Indicates that phase 3 is in effect.

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 ( 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 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,
out InvokeId  savedInvokeId 
) [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.
savedInvokeId An InvokeId object variable that will get populated with the reference to the InvokeId object that gets encoded into the ROSE header. This is used when the response is received to match the response with the request.
Returns:
The length of the encoded message, including both the CSTA message and the ROSE header, or -1 if the encoding fails.
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 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 ( 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  crossRefId  )  [virtual]

Stop a previously started PBX monitor request.

Parameters:
crossRefId 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.
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 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 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  existingCall,
string  targetDevice 
) [virtual]

Transfers a call from one device to another.

Parameters:
existingCall ConnectionID of an existing call (such as initiated through MakeCall()).
targetDevice The device (e.g., "800") to which the call is to be transferred.
Returns:
A CSTAResponseInfo object.
virtual CSTAResponseInfo TransferCallAfterConsult ( ConnectionID  initiatedCall,
ConnectionID  originalCall 
) [virtual]

Transfers a call after a consultation call has been done.

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.