$treeview $search $mathjax $extrastylesheet
CSTADLL
2.3.4
$projectbrief
|
$projectbrief
|
$searchbox |
Public Member Functions | |
virtual CSTAResponseInfo | AlternateCall (ConnectionID heldCall, ConnectionID activeCall) |
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 | ConferenceCall (ConnectionID heldCall, ConnectionID activeCall) |
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 agentDevice) |
virtual CSTAResponseInfo | GetDoNotDisturb (string targetDevice) |
virtual CSTAResponseInfo | GetLogicalDevInfo (string targetDevice) |
virtual CSTAResponseInfo | GetPhysicalDevInfo (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 (ConnectionID callToMonitor) |
virtual CSTAResponseInfo | MonitorStart (long deviceToMonitor) |
virtual CSTAResponseInfo | MonitorStart (string deviceToMonitor) |
virtual CSTAResponseInfo | MonitorStop (string monitoredDevice) |
virtual CSTAResponseInfo | MonitorStop (MonitorCrossRefID crossRefID) |
virtual CSTAResponseInfo | MonitorStop (int crossRefInt) |
virtual CSTAResponseInfo | MonitorStopAtNumericDevice (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) |
virtual CSTAResponseInfo | SetAgentState (string agentDevice, ReqAgentState agentState, AgentID aid) |
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 | 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 (TransferCallInfo tcInfo) |
virtual CSTAResponseInfo | TransferCall (ConnectionID initiatedCall, ConnectionID originalCall) |
Protected Member Functions | |
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, ConnectionID callToAnswer, string deviceToLift) |
virtual int | EncodeAnswerCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToAnswer) |
virtual int | EncodeAnswerCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, 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 | 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) |
virtual int | EncodeMonitorStartRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToMonitor) |
virtual int | EncodeMonitorStartRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, long deviceToMonitor) |
virtual int | EncodeMonitorStartRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string deviceToMonitor) |
virtual int | EncodeMonitorStopRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, MonitorCrossRefID crossRefObj) |
virtual int | EncodeMonitorStopRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, int crossRefInt, out MonitorCrossRefID crossRefID) |
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) |
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 | 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, SingleStepTransferInfo sstInfo) |
virtual int | EncodeSingleStepTransferRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID callToTransfer, string transferToDevice) |
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, TransferCallInfo tcInfo) |
virtual int | EncodeTransferCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, ConnectionID initiatedCall, ConnectionID originalCall) |
Properties | |
PBXSession | SessionObject [get] |
CSTAContext | ThreadContext [get] |
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.
GenericCSTAp3 | ( | string | pbxSystem, | |
int | port | |||
) |
Constructs an instance associated with the given PBX identifier and port.
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.
sessionObject | A PBXSession object. |
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).
heldCall | The held call to be retrieved. | |
activeCall | The active call to be placed on hold. |
virtual CSTAResponseInfo AnswerCall | ( | ConnectionID | callToAnswer, | |
string | deviceToLift | |||
) | [virtual] |
Answers a call.
callToAnswer | ConnectionID of an existing call (such as initiated through MakeCall()). | |
deviceToLift | The device (e.g., "800") that is to answer the call. |
virtual CSTAResponseInfo AnswerCall | ( | ConnectionID | callToAnswer | ) | [virtual] |
Answers a call.
callToAnswer | The ConnectionID of the call to answer. |
virtual CSTAResponseInfo AnswerCall | ( | string | deviceToLift | ) | [virtual] |
Answers a call.
deviceToLift | The identification (e.g., phone number) of the device to answer. |
virtual CSTAResponseInfo ClearConnection | ( | ConnectionID | connToClear | ) | [virtual] |
Clears a connection.
connToClear | The ConnectionID of the connection to clear. |
virtual CSTAResponseInfo ClearDoNotDisturb | ( | string | targetDevice | ) | [virtual] |
Turns off the Do Not Disturb functionality for a phone.
targetDevice | The device for which the Do Not Disturb functionality is to be turned off. |
virtual CSTAResponseInfo ClearMessageWaiting | ( | string | targetDevice | ) | [virtual] |
Turns off the message waiting indicator on a device's display.
targetDevice | The device for which the indicator is to be turned off. |
virtual CSTAResponseInfo ConferenceCall | ( | ConnectionID | heldCall, | |
ConnectionID | activeCall | |||
) | [virtual] |
Brings a held call into conference with an active call.
heldCall | The held call to be brought into conference. | |
activeCall | The active call. |
virtual CSTAResponseInfo ConsultationCall | ( | ConnectionID | existingCall, | |
string | targetDevice | |||
) | [virtual] |
Instruct the PBX to do a consultation call.
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. |
virtual int EncodeACSEConnectionRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer | |||
) | [protected, virtual] |
Encodes an ACSE Association Request message.
response | A CSTA ResponseInfo object. | |
encodeBuffer | An encode buffer object into which the message will be encoded. |
Reimplemented in PanasonicKXTDE, SiemensCap, SiemensHipath3000p3, and UnifyOpenscape4000BER.
virtual int EncodeACSEReleaseRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer | |||
) | [protected, virtual] |
Encodes an ACSE Release Request message.
response | A CSTA ResponseInfo object. | |
encodeBuffer | An encode buffer object into which the message will be encoded. |
virtual int EncodeAlternateCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | heldCall, | |||
ConnectionID | activeCall | |||
) | [protected, virtual] |
Encodes an AlternateCall message.
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. |
virtual int EncodeAnswerCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | callToAnswer, | |||
string | deviceToLift | |||
) | [protected, virtual] |
Encodes an AnswerCall message.
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. |
virtual int EncodeAnswerCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | callToAnswer | |||
) | [protected, virtual] |
Encodes an AnswerCall message.
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. |
virtual int EncodeAnswerCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | deviceToLift | |||
) | [protected, virtual] |
Encodes an AnswerCall message.
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. |
virtual int EncodeClearConnectionRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | connToClear | |||
) | [protected, virtual] |
Encodes a ClearConnection message.
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. |
virtual int EncodeConferenceCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | heldCall, | |||
ConnectionID | activeCall | |||
) | [protected, virtual] |
Encodes a ConferenceCall message.
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. |
virtual int EncodeConsultationCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | existingCall, | |||
string | targetDevice | |||
) | [protected, virtual] |
Encodes a ConsultationCall message.
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. |
virtual int EncodeGetAgentStateRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | agentDevice | |||
) | [protected, virtual] |
Encodes a GetAgentState message.
response | A CSTA ResponseInfo object. | |
encodeBuffer | An encode buffer object into which the message will be encoded. | |
agentDevice | The device associated with the agent. |
virtual int EncodeGetDNDRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | targetDevice | |||
) | [protected, virtual] |
Encodes a GetDoNotDisturb message.
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. |
virtual int EncodeGetLogicalDevInfoRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | targetDevice | |||
) | [protected, virtual] |
Encodes a GetLogicalDeviceInformation message.
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. |
virtual int EncodeGetPhysicalDevInfoRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | targetDevice | |||
) | [protected, virtual] |
Encodes a GetPhysicalDeviceInformation message.
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. |
virtual int EncodeGetSFDevicesRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ReqDeviceCategory | deviceCategory | |||
) | [protected, virtual] |
Encodes a GetSwitchingFunctionDevices message.
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. |
virtual int EncodeHoldCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | callToHold | |||
) | [protected, virtual] |
Encodes a HoldCall message.
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. |
virtual int EncodeMakeCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | callingDevice, | |||
string | calledDevice | |||
) | [protected, virtual] |
Encodes a MakeCall message.
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. |
Reimplemented in PanasonicKXTDE.
virtual int EncodeMonitorStartRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | callToMonitor | |||
) | [protected, virtual] |
Encodes a MonitorStart message to monitor a call.
response | A CSTA ResponseInfo object. | |
encodeBuffer | An encode buffer object into which the message will be encoded. | |
callToMonitor | The call to monitor. |
virtual int EncodeMonitorStartRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
long | deviceToMonitor | |||
) | [protected, virtual] |
Encodes a MonitorStart message to monitor a device.
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. |
virtual int EncodeMonitorStartRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | deviceToMonitor | |||
) | [protected, virtual] |
Encodes a MonitorStart message to monitor a device.
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. |
virtual int EncodeMonitorStopRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
MonitorCrossRefID | crossRefObj | |||
) | [protected, virtual] |
Encodes a MonitorStop message.
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. |
virtual int EncodeMonitorStopRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
int | crossRefInt, | |||
out MonitorCrossRefID | crossRefID | |||
) | [protected, virtual] |
Encodes a MonitorStop message.
response | A CSTA ResponseInfo object. | |
encodeBuffer | An encode buffer object into which the message will be encoded. | |
crossRefInt | The cross reference id of the monitor request as an integer. | |
crossRefID | A reference to a variable of type MonitorCrossRefID that will be populated with a MonitorCrossRefID object that corresponds to the specified integer cross reference id. |
virtual int EncodeRequestSysStatRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer | |||
) | [protected, virtual] |
Encodes a RequestSystemStatus message.
response | A CSTA ResponseInfo object. | |
encodeBuffer | An encode buffer object into which the message will be encoded. |
virtual int EncodeRetrieveCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | callToRetrieve | |||
) | [protected, virtual] |
Encodes a RetrieveCall message.
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. |
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.
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. |
virtual int EncodeSendDataRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
IOCrossRefID | ioCrossRef, | |||
string | text | |||
) | [protected, virtual] |
Encodes a SendData message.
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. |
virtual int EncodeSendStoredCDRRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
CDRCrossRefID | cdrCrossRefID | |||
) | [protected, virtual] |
Encodes a SendStoredCallDetailRecords message.
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. |
virtual int EncodeSetAgentStateRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | agentDevice, | |||
ReqAgentState | agentState | |||
) | [protected, virtual] |
Encodes a SetAgentState message.
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. |
virtual int EncodeSetAgentStateRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | agentDevice, | |||
ReqAgentState | agentState, | |||
AgentID | aid | |||
) | [protected, virtual] |
Encodes a SetAgentState message.
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. |
virtual int EncodeSetDisplayRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | targetDevice, | |||
string | text | |||
) | [protected, virtual] |
Encodes a SetDisplay message.
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. |
Reimplemented in PanasonicKXTDE.
virtual int EncodeSetOrClearDNDRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | targetDevice, | |||
bool | dndOn | |||
) | [protected, virtual] |
Encodes a SetDoNotDisturb message.
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. |
virtual int EncodeSetOrClearMWRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | targetDevice, | |||
bool | indicatorOn | |||
) | [protected, virtual] |
Encodes a SetMessageWaiting message.
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. |
virtual int EncodeSetRingerStatusRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | targetDevice, | |||
string | targetRinger, | |||
RingMode | mode, | |||
long | ringPattern | |||
) | [protected, virtual] |
Encodes a SetRingerStatus message.
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. |
virtual int EncodeSingleStepTransferRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
SingleStepTransferInfo | sstInfo | |||
) | [protected, virtual] |
Encodes a SingleStepTransfer message.
response | A CSTA ResponseInfo object. | |
encodeBuffer | An encode buffer object into which the message will be encoded. | |
sstInfo | A SingleStepTransferInfo object. |
Reimplemented in SiemensHipath3000p3.
virtual int EncodeSingleStepTransferRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | callToTransfer, | |||
string | transferToDevice | |||
) | [protected, virtual] |
Encodes a SingleStepTransfer message.
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. |
virtual int EncodeSnapshotCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | callToSnapshot | |||
) | [protected, virtual] |
Encodes a SnapshotCall message.
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. |
virtual int EncodeSnapshotDeviceRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | deviceToSnapshot | |||
) | [protected, virtual] |
Encodes a SnapshotDevice message.
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. |
virtual int EncodeStartCDRTransRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
CDRTransferMode | transferMode | |||
) | [protected, virtual] |
Encodes a StartCallDetailRecordsTransmission message.
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. |
virtual int EncodeStartDataPathRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
string | targetDevice | |||
) | [protected, virtual] |
Encodes a StartDataPath message.
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. |
virtual int EncodeStopCDRTransRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
CDRCrossRefID | cdrCrossRefID | |||
) | [protected, virtual] |
Encodes a StopCallDetailRecordsTransmission message.
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. |
virtual int EncodeStopDataPathRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
IOCrossRefID | ioCrossRef | |||
) | [protected, virtual] |
Encodes a StopDataPath message.
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. |
virtual int EncodeTransferCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
TransferCallInfo | tcInfo | |||
) | [protected, virtual] |
Encodes a TransferCall message.
response | A CSTA ResponseInfo object. | |
encodeBuffer | An encode buffer object into which the message will be encoded. | |
tcInfo | A TransferCallInfo object. |
virtual int EncodeTransferCallRequest | ( | CSTAResponseInfo | response, | |
Asn1BerEncodeBuffer | encodeBuffer, | |||
ConnectionID | initiatedCall, | |||
ConnectionID | originalCall | |||
) | [protected, virtual] |
Encodes a TransferCall message.
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. |
virtual CSTAResponseInfo GetAgentState | ( | string | agentDevice | ) | [virtual] |
Gets the state of the agent associated with a device.
agentDevice | The device associated with the agent. |
virtual CSTAResponseInfo GetDoNotDisturb | ( | string | targetDevice | ) | [virtual] |
Gets the Do Not Disturb setting for a phone.
targetDevice | The phone for which the Do Not Disturb setting is desired. |
virtual CSTAResponseInfo GetLogicalDevInfo | ( | string | targetDevice | ) | [virtual] |
Gets information about the logical element of a device.
targetDevice | The device for which the information is desired. |
virtual CSTAResponseInfo GetPhysicalDevInfo | ( | string | targetDevice | ) | [virtual] |
Gets information about the physical element of a device.
targetDevice | The device for which the information is desired. |
virtual CSTAResponseInfo GetSFDevices | ( | ReqDeviceCategory | deviceCategory | ) | [virtual] |
Sends a Get Switching Function Devices request to the PBX.
deviceCategory | The category of device for which the list is desired. |
virtual CSTAResponseInfo GetSFDevices | ( | ) | [virtual] |
Sends a Get Switching Function Devices request to the PBX.
Reimplemented in PanasonicKXTDE.
virtual CSTAResponseInfo HoldCall | ( | ConnectionID | callToHold | ) | [virtual] |
Instruct the PBX to hold a call.
callToHold | The ConnectionID of the call to be held. |
virtual CSTAResponseInfo MakeACSEAssociation | ( | ) | [virtual] |
Establish an ACSE association with the PBX.
virtual CSTAResponseInfo MakeCall | ( | string | callingDevice, | |
string | calledDevice | |||
) | [virtual] |
Instruct the PBX to place a call.
callingDevice | Identifier (e.g., phone number) of the device making the call. | |
calledDevice | Identifier (e.g., phone number) of the device being called. |
virtual CSTAResponseInfo MonitorStart | ( | ConnectionID | callToMonitor | ) | [virtual] |
Issues a MonitorStart request to the PBX to monitor a call.
callToMonitor | The call to monitor. |
virtual CSTAResponseInfo MonitorStart | ( | long | deviceToMonitor | ) | [virtual] |
Issues a MonitorStart request to the PBX to monitor a device.
deviceToMonitor | Device number of the device to monitor. |
virtual CSTAResponseInfo MonitorStart | ( | string | deviceToMonitor | ) | [virtual] |
Issues a MonitorStart request to the PBX to monitor a device.
deviceToMonitor | Identifier (e.g., telephone number) of the device to monitor. |
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.
monitoredDevice | The monitored device (e.g., extension). |
virtual CSTAResponseInfo MonitorStop | ( | MonitorCrossRefID | crossRefID | ) | [virtual] |
Stop a previously started PBX monitor request.
crossRefID | The cross reference id of the monitor request as a MonitorCrossRefID object. |
virtual CSTAResponseInfo MonitorStop | ( | int | crossRefInt | ) | [virtual] |
Stop a previously started PBX monitor request.
crossRefInt | The cross reference id of the monitor request as an integer. |
virtual CSTAResponseInfo MonitorStopAtNumericDevice | ( | 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.
monitoredDevice | The device number of the monitored device. |
virtual CSTAResponseInfo ReleaseACSEAssociation | ( | ) | [virtual] |
Releases an ACSE association with a PBX device.
virtual CSTAResponseInfo RequestSystemStatus | ( | ) | [virtual] |
Retrieves a system status from the PBX.
virtual CSTAResponseInfo RetrieveCall | ( | ConnectionID | callToRetrieve | ) | [virtual] |
Retrieves a held call.
callToRetrieve | The ConnectionID of the call to retrieve. |
virtual CSTAResponseInfo RingDevice | ( | string | targetDevice, | |
string | targetRinger, | |||
long | ringPattern | |||
) | [virtual] |
Causes a telephony device to ring.
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. |
virtual CSTAResponseInfo SendData | ( | IOCrossRefID | ioCrossRef, | |
string | text | |||
) | [virtual] |
Sends a text message to a telephony device.
ioCrossRef | An IOCrossRefID object, most likely obtained by a previous call to StartDataPath. | |
text | The text to send to the telephony device. |
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.
cdrCrossRefID | The CDR cross reference id that was returned in the response to a previously issued StartCDRTransmission() call. |
virtual CSTAResponseInfo SetAgentState | ( | string | agentDevice, | |
ReqAgentState | agentState | |||
) | [virtual] |
Sets the state of the agent associated with a device.
agentDevice | The device associated with the agent. | |
agentState | The desired state for the agent. |
virtual CSTAResponseInfo SetAgentState | ( | string | agentDevice, | |
ReqAgentState | agentState, | |||
AgentID | aid | |||
) | [virtual] |
Sets the state of the agent associated with a device.
agentDevice | The device associated with the agent. | |
agentState | The desired state for the agent. | |
aid | The agent id. |
virtual CSTAResponseInfo SetDisplay | ( | string | targetDevice, | |
string | text | |||
) | [virtual] |
Sends text to a telephony device's display
targetDevice | The device to which the text is to be sent. | |
text | The text to be sent. |
virtual CSTAResponseInfo SetDoNotDisturb | ( | string | targetDevice | ) | [virtual] |
Sets the Do Not Disturb feature for a phone.
targetDevice | The device for which Do Not Disturb is to be set. |
virtual CSTAResponseInfo SetMessageWaiting | ( | string | targetDevice | ) | [virtual] |
Turns on the message waiting indicator on a device's display.
targetDevice | The device for which the indicator is to be turned on. |
virtual CSTAResponseInfo SingleStepTransfer | ( | SingleStepTransferInfo | sstInfo | ) | [virtual] |
Perform a single step transfer.
sstInfo | A SingleStepTransferInfo object. |
virtual CSTAResponseInfo SingleStepTransfer | ( | ConnectionID | callToTransfer, | |
string | transferToDevice | |||
) | [virtual] |
Perform a single step transfer.
callToTransfer | The ConnectionID of the call to transfer. | |
transferToDevice | The device to which the call is to be transferred. |
virtual CSTAResponseInfo SnapshotCall | ( | ConnectionID | callToSnapshot | ) | [virtual] |
Instruct the PBX to take a snapshot of a call.
callToSnapshot | The ConnectionID of the call for which the snapshot is desired. |
virtual CSTAResponseInfo SnapshotDevice | ( | string | deviceToSnapshot | ) | [virtual] |
Instruct the PBX to take a snapshot of calls active at a device.
deviceToSnapshot | Identifier (e.g., phone number) of the device for which the snapshot is desired. |
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.
transferMode | Indicates how the PBX is to transfer the CDR information. |
virtual CSTAResponseInfo StartDataPath | ( | string | targetDevice | ) | [virtual] |
Opens up a data path to a specified device.
targetDevice | Specifies the device to which a data path is to be opened. |
virtual CSTAResponseInfo StopCDRTransmission | ( | CDRCrossRefID | cdrCrossRefID | ) | [virtual] |
Issues a StopCallDetailRecordsTransmission request to the PBX.
cdrCrossRefID | The CDR cross reference id that was returned in the response to a previously issued StartCDRTransmission() call. |
virtual CSTAResponseInfo StopDataPath | ( | IOCrossRefID | ioCrossRef | ) | [virtual] |
Stops a previously established data path
ioCrossRef | An IOCrossRef object, most likely obtained from a previous call to StartDataPath. |
virtual CSTAResponseInfo StopRing | ( | string | targetDevice, | |
string | targetRinger, | |||
long | ringPattern | |||
) | [virtual] |
Stops a ringer on a telephony device.
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. |
virtual CSTAResponseInfo TransferCall | ( | TransferCallInfo | tcInfo | ) | [virtual] |
Transfers a call from one device to another.
tcInfo | A TransferCallInfo object. |
virtual CSTAResponseInfo TransferCall | ( | ConnectionID | initiatedCall, | |
ConnectionID | originalCall | |||
) | [virtual] |
Transfers a call. A consultation call must be done before calling this method.
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. |
PBXSession SessionObject [get] |
The PBXSession object associated with this instance.
CSTAContext ThreadContext [get] |
The CSTAContext structure for this thread.