PanasonicKXTDE Class Reference

Inheritance diagram for PanasonicKXTDE:
IETF_CSTAp3 GenericCSTAp3 PanasonicKXTDA PanasonicNCP

List of all members.

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 (string groupDevice)
override CSTAResponseInfo GetSFDevices ()
 PanasonicKXTDE (PBXSession sessionObject)
 PanasonicKXTDE (string pbxSystem, int port)
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)

Protected Member Functions

override int EncodeACSEConnectionRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer)
override int EncodeMakeCallRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string callingDevice, string calledDevice)
override int EncodeSetDisplayRequest (CSTAResponseInfo response, Asn1BerEncodeBuffer encodeBuffer, string targetDevice, string text)

Detailed Description

Implements CSTA phase 3 operations for the Panasonic KX-TDE PBX device.


Member Enumeration Documentation

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


Constructor & Destructor Documentation

PanasonicKXTDE ( 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.
PanasonicKXTDE ( PBXSession  sessionObject  ) 

Constructs an instance associated with the given PBXSession object.

Parameters:
sessionObject A PBXSession object.

Member Function Documentation

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.
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.
override int EncodeACSEConnectionRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer 
) [protected, virtual]

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.

override int EncodeMakeCallRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  callingDevice,
string  calledDevice 
) [protected, virtual]

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.
Returns:
The length of the encoded message, or -1 if an error occurred.

Reimplemented from GenericCSTAp3.

override int EncodeSetDisplayRequest ( CSTAResponseInfo  response,
Asn1BerEncodeBuffer  encodeBuffer,
string  targetDevice,
string  text 
) [protected, virtual]

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.

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:
CSTAResponseInfo GetGroupMembers ( string  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.
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.

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.
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.
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.
CSTAResponseInfo ResetDisplay ( string  targetDevice  ) 

Resets a telephony device's display

Parameters:
targetDevice The device which is to be reset.
Returns:
A CSTAResponseInfo object.
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 KMESpecificPrivateData segment, the EscapeArgument, and the ROSE header.
Returns:
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.