Inheritance diagram for PanasonicKXNS:

Public Types
enum	DeviceDataTypes

Public Member Functions
CSTAResponseInfo	AcquireControlRight (string targetDevice)

CSTAResponseInfo	ClearMessageWaiting (string originatingDevice, string targetDevice)

CSTAResponseInfo	GetDeviceData (string device, DeviceDataTypes eDataType)

CSTAResponseInfo	GetGroupMembers (int groupDevice)

override CSTAResponseInfo	GetSFDevices ()

	PanasonicKXNS (string pbxSystem, int port)

	PanasonicKXNS (PBXSession sessionObject)

CSTAResponseInfo	PDFStart (string targetDevice)

CSTAResponseInfo	PDFStop (string targetDevice)

CSTAResponseInfo	ReleaseControlRight (string targetDevice)

CSTAResponseInfo	ResetDisplay (string targetDevice)

CSTAResponseInfo	SendKmeMessage (Asn1BerEncodeBuffer encodeBuffer)

CSTAResponseInfo	SetMessageWaiting (string originatingDevice, string targetDevice)

Public Member Functions inherited from IETF_CSTAp3
	IETF_CSTAp3 (string pbxSystem, int port)

	IETF_CSTAp3 (PBXSession sessionObject)

Public Member Functions inherited from GenericCSTAp3
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 (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
override int	EncodeACSEConnectionRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer)

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

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

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

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	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	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)

Additional Inherited Members
Properties inherited from GenericCSTAp3
PBXSession	SessionObject `[get]`

CSTAContext	ThreadContext `[get]`

Detailed Description

Implements CSTA phase 3 operations for the Panasonic KX-NS PBX device. The PBX device must be running firmware version 8.4 or higher.

Member Enumeration Documentation

◆ DeviceDataTypes

enum DeviceDataTypes

strong

Provides symbolic names for the types of device information tha can be obtained from a Panasonic PBX.

Constructor & Destructor Documentation

◆ PanasonicKXNS() [1/2]

PanasonicKXNS	(	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.

◆ PanasonicKXNS() [2/2]

PanasonicKXNS ( PBXSession sessionObject )

Constructs an instance associated with the given PBXSession object.

Parameters

sessionObject A PBXSession object.

Member Function Documentation

◆ AcquireControlRight()

CSTAResponseInfo AcquireControlRight ( string targetDevice )

Acquires the right to control a telephony device. This method will cause a "PDF (Physical Device Feature) Start" Escape message to be sent to the PBX.

Parameters

targetDevice The target telephony device.

Returns: A CSTAResponseInfo object.

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

◆ ClearMessageWaiting()

CSTAResponseInfo ClearMessageWaiting	(	string	originatingDevice,
		string	targetDevice
	)

Turns off a device's message waiting indicator.

Parameters

originatingDevice	The device that originated the call back request.
targetDevice	The device for which the message waiting indicator is to be turned off.

Returns: A CSTAResponseInfo object.

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

◆ EncodeACSEConnectionRequest()

override 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 from GenericCSTAp3.

References CSTAResponseInfo.StatusMessage.

◆ EncodeMakeCallRequest()

override 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 from GenericCSTAp3.

References CSTAResponseInfo.StatusMessage.

◆ EncodeSetDisplayRequest()

override 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 from GenericCSTAp3.

References CSTAResponseInfo.StatusMessage.

◆ GetDeviceData()

CSTAResponseInfo GetDeviceData	(	string	device,
		DeviceDataTypes	eDataType
	)

Gets information about a device.

Parameters

device	The device (e.g., "101") about which the information is desired.
eDataType	The type of data requested (must be from the DeviceDataTypes enum in this class).

Returns

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

◆ GetGroupMembers()

CSTAResponseInfo GetGroupMembers ( int groupDevice )

Gets the members associated with a group device (for example, the extensions associated with an incoming call distribution group device).

Parameters

groupDevice The group device designation (e.g, 601).

Returns: A CSTAResponseInfo object.

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

◆ GetSFDevices()

override CSTAResponseInfo GetSFDevices ( )

virtual

Returns a list of station (i.e., telephone) devices known to the PBX by sending a Get Switching Function Devices message that specifies just station devices.

Returns: A CSTAResponseInfo object.

Reimplemented from GenericCSTAp3.

◆ PDFStart()

CSTAResponseInfo PDFStart ( string targetDevice )

Sends a "PDF (Physical Device Feature) Start" Escape message to the PBX. This method is a convenience method that does the same thing as the AcquireControlRight() method.

Parameters

targetDevice The target telephony device.

Returns: A CSTAResponseInfo object.

◆ PDFStop()

CSTAResponseInfo PDFStop ( string targetDevice )

Sends a "PDF (Physical Device Feature) Stop" Escape message to the PBX. This method is a convenience method that does the same thing as the ReleaseControlRight() method.

Parameters

targetDevice The target telephony device.

Returns: A CSTAResponseInfo object.

◆ ReleaseControlRight()

CSTAResponseInfo ReleaseControlRight ( string targetDevice )

Releases the right to control a telephony device. This method will cause a "PDF (Physical Device Feature) Stop" Escape message to be sent to the PBX.

Parameters

targetDevice The target telephony device.

Returns: A CSTAResponseInfo object.

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

◆ ResetDisplay()

CSTAResponseInfo ResetDisplay ( string targetDevice )

Resets a telephony device's display

Parameters

targetDevice The device which is to be reset.

Returns: A CSTAResponseInfo object.

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

◆ SendKmeMessage()

CSTAResponseInfo SendKmeMessage ( Asn1BerEncodeBuffer encodeBuffer )

Sends a Panasonic-specific KME message to the PBX.

Parameters

encodeBuffer A BER encode buffer instance containing a completely encoded KME message. The message must include the PanCSTAv80_KMESpecificPrivateData segment, the EscapeArgument, and the ROSE header.

Returns

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

◆ SetMessageWaiting()

CSTAResponseInfo SetMessageWaiting	(	string	originatingDevice,
		string	targetDevice
	)

Turns on a device's message waiting indicator.

Parameters

originatingDevice	The device that originated the call back request.
targetDevice	The device for which the message waiting indicator is to be turned on.

Returns: A CSTAResponseInfo object.

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

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DeviceDataTypes

Constructor & Destructor Documentation

◆ PanasonicKXNS() [1/2]

◆ PanasonicKXNS() [2/2]

Member Function Documentation

◆ AcquireControlRight()

◆ ClearMessageWaiting()

◆ EncodeACSEConnectionRequest()

◆ EncodeMakeCallRequest()

◆ EncodeSetDisplayRequest()

◆ GetDeviceData()

◆ GetGroupMembers()

◆ GetSFDevices()

◆ PDFStart()

◆ PDFStop()

◆ ReleaseControlRight()

◆ ResetDisplay()

◆ SendKmeMessage()

◆ SetMessageWaiting()