PAMI\Message\Response\SCCPShowDeviceResponse
An sccp showdevice response message from ami.
PHP Version 5
- Author: Diederik de Groot <ddegroot@users.sf.net>
- License: http://marcelog.github.com/PAMI/ Apache License 2.0
Synopsis
class SCCPShowDeviceResponse
extends ComplexResponse
{
- // methods
- public void __construct()
- public string getMACAddress()
- public string getDeviceName()
- public string getProtocolVersion()
- public string getProtocolInUse()
- public string getDeviceFeatures()
- public string getTokenstate()
- public integer getKeepalive()
- public string getRegistrationState()
- public string getState()
- public string getMWILight()
- public boolean getMWIHandsetLight()
- public string getDescription()
- public string getConfigPhoneType()
- public string getSkinnyPhoneType()
- public boolean getSoftkeySupport()
- public string getSoftkeyset()
- public boolean getBTemplateSupport()
- public boolean getLinesRegistered()
- public string getImageVersion()
- public integer getTimezoneOffset()
- public array getCapabilities()
- public array getCodecsPreference()
- public integer getAudioTOS()
- public integer getAudioCOS()
- public integer getVideoTOS()
- public integer getVideoCOS()
- public boolean getDNDFeatureEnabled()
- public string getDNDStatus()
- public string getDNDAction()
- public boolean getCanTransfer()
- public boolean getCanPark()
- public boolean getCanCFWDALL()
- public boolean getCanCFWBUSY()
- public boolean getCanCFWNOANSWER()
- public boolean getAllowRinginNotification()
- public boolean getPrivateSoftkey()
- public string getDtmfMode()
- public string getNat()
- public boolean getVideosupport()
- public boolean getDirectRTP()
- public string getBindAddress()
- public string getServerAddress()
- public string getDenyPermit()
- public string getPermitHosts()
- public string getEarlyRTP()
- public string getDeviceStateAcc()
- public string getLastUsedAccessory()
- public string getLastDialedNumber()
- public integer getDefaultLineInstance()
- public string getCustomBackgroundImage()
- public string getCustomRingTone()
- public boolean getUsePlacedCalls()
- public boolean getPendingUpdate()
- public boolean getPendingDelete()
- public boolean getDirectedPickup()
- public string getPickupContext()
- public boolean getPickupModeAnswer()
- public boolean getallowConference()
- public boolean getconfPlayGeneralAnnounce()
- public boolean getconfPlayPartAnnounce()
- public boolean getconfMuteOnEntry()
- public string getconfMusicOnHoldClass()
- public boolean getconfShowConflist()
- public boolean getconflistActive()
- public array getButtons()
- public array getLineButtons()
- public array getSpeeddialButtons()
- public array getServiceURLButtons()
- public array getFeatureButtons()
- public array getVariables()
- public array getCallStatistics()
- // Inherited methods from ComplexResponse
- public void addEvent()
- public boolean hasTable()
- public array getTableNames()
- public array getTable()
- public array getJSON()
- public void __construct()
- // Inherited methods from Response
- public array __sleep()
- public boolean isComplete()
- public void addEvent()
- public array getEvents()
- public boolean isSuccess()
- public boolean isList()
- public string getMessage()
- public void setActionId()
- public void __construct()
- // Inherited methods from IncomingMessage
- public array __sleep()
- public string getEventList()
- public string getRawContent()
- public array getAllChannelVariables()
- public array getChannelVariables()
- public array getAllStatusVariables()
- public array getStatusVariables()
- public void __construct()
- // Inherited methods from Message
- public integer getCreatedDate()
- public void setVariable()
- public string getVariable()
- public string getKey()
- public string getBoolKey()
- public array getKeys()
- public array getVariables()
- public string serialize()
- public string getActionID()
- public void __construct()
Hierarchy
Constants
Name | Value |
---|---|
EOL | "\r\n" |
EOM | "\r\n\r\n" |
Methods
public
- __construct() — Constructor.
- getAllowRinginNotification() — Returns key: 'AllowRinginNotification'.
- getAudioCOS() — Returns key: 'AudioCOS'.
- getAudioTOS() — Returns key: 'AudioTOS'.
- getBTemplateSupport() — Returns key: 'BTemplateSupport'.
- getBindAddress() — Returns key: 'BindAddress'.
- getButtons() — Returns an array of SCCPDeviceButtonEntryEvent's
- getCallStatistics() — Returns an array of SCCPDeviceCalStatisticEntryEvent's
- getCanCFWBUSY() — Returns key: 'CanCFWBUSY'.
- getCanCFWDALL() — Returns key: 'CanCFWDALL'.
- getCanCFWNOANSWER() — Returns key: 'CanCFWNOANSWER'.
- getCanPark() — Returns key: 'CanPark'.
- getCanTransfer() — Returns key: 'CanTransfer'.
- getCapabilities() — Returns key: 'Capabilities'.
- getCodecsPreference() — Returns key: 'CodecsPreference'.
- getConfigPhoneType() — Returns key: 'ConfigPhoneType'.
- getCustomBackgroundImage() — Returns key: 'CustomBackgroundImage'.
- getCustomRingTone() — Returns key: 'CustomRingTone'.
- getDNDAction() — Returns key: 'DNDAction'.
- getDNDFeatureEnabled() — Returns key: 'DNDFeatureEnabled'.
- getDNDStatus() — Returns key: 'DNDStatus'.
- getDefaultLineInstance() — Returns key: 'DefaultLineInstance'.
- getDenyPermit() — Returns key: 'DenyPermit'.
- getDescription() — Returns key: 'Description'.
- getDeviceFeatures() — Returns key: 'DeviceFeatures'.
- getDeviceName() — Returns key: 'DeviceName'.
- getDeviceStateAcc() — Returns key: 'DeviceStateAcc'.
- getDirectRTP() — Returns key: 'DirectRTP'.
- getDirectedPickup() — Returns key: 'DirectedPickup'.
- getDtmfMode() — Returns key: 'DtmfMode'.
- getEarlyRTP() — Returns key: 'EarlyRTP'.
- getFeatureButtons() — Returns an array of SCCPDeviceFeatureButtonEntryEvent's
- getImageVersion() — Returns key: 'ImageVersion'.
- getKeepalive() — Returns key: 'Keepalive'.
- getLastDialedNumber() — Returns key: 'LastDialedNumber'.
- getLastUsedAccessory() — Returns key: 'LastUsedAccessory'.
- getLineButtons() — Returns an array of SCCPDeviceLineButtonEntryEvent's
- getLinesRegistered() — Returns key: 'linesRegistered'.
- getMACAddress() — Returns key: 'MACAddress'.
- getMWIHandsetLight() — Returns key: 'MWIHandsetLight'.
- getMWILight() — Returns key: 'MWILight'.
- getNat() — Returns key: 'Nat'.
- getPendingDelete() — Returns key: 'PendingDelete'.
- getPendingUpdate() — Returns key: 'PendingUpdate'.
- getPermitHosts() — Returns key: 'PermitHosts'.
- getPickupContext() — Returns key: 'PickupContext'.
- getPickupModeAnswer() — Returns key: 'PickupModeAnswer'.
- getPrivateSoftkey() — Returns key: 'PrivateSoftkey'.
- getProtocolInUse() — Returns key: 'ProtocolInUse'.
- getProtocolVersion() — Returns key: 'ProtocolVersion'.
- getRegistrationState() — Returns key: 'RegistrationState'.
- getServerAddress() — Returns key: 'ServerAddress'.
- getServiceURLButtons() — Returns an array of SCCPDeviceServiceURLButtonEntryEvent's
- getSkinnyPhoneType() — Returns key: 'SkinnyPhoneType'.
- getSoftkeySupport() — Returns key: 'SoftkeySupport'.
- getSoftkeyset() — Returns key: 'Softkeyset'.
- getSpeeddialButtons() — Returns an array of SCCPDeviceSpeeddialButtonEntryEvent's
- getState() — Returns key: 'State'.
- getTimezoneOffset() — Returns key: 'TimezoneOffset'.
- getTokenstate() — Returns key: 'Tokenstate'.
- getUsePlacedCalls() — Returns key: 'UsePlacedCalls'.
- getVariables() — Returns an array of SCCPVariableEntryEvent's
- getVideoCOS() — Returns key: 'VideoCOS'.
- getVideoTOS() — Returns key: 'VideoTOS'.
- getVideosupport() — Returns key: 'Videosupport'.
- getallowConference() — Returns key: 'allowConference'.
- getconfMusicOnHoldClass() — Returns key: 'confMusicOnHoldClass'.
- getconfMuteOnEntry() — Returns key: 'confMuteOnEntry'.
- getconfPlayGeneralAnnounce() — Returns key: 'confPlayGeneralAnnounce'.
- getconfPlayPartAnnounce() — Returns key: 'confPlayPartAnnounce'.
- getconfShowConflist() — Returns key: 'confShowConflist'.
- getconflistActive() — Returns key: 'conflistActive'.
Inherited from PAMI\Message\Response\ComplexResponse
public
- addEvent() — Adds an event to this response.
- getJSON() — Returns decoded version of the 'JSON' key if present.
- getTable() — Returns all associated events for this response->tablename.
- getTableNames() — Returns all eventtabless for this response.
- hasTable() — Returns true if this Response Message contains an events tables (TableStart/TableEnd)
Inherited from PAMI\Message\Response\Response
public
- __sleep() — Serialize function.
- addEvent() — Adds an event to this response.
- getEvents() — Returns all associated events for this response.
- getMessage() — Returns key: 'Privilege'.
- isComplete() — True if this response is complete. A response is considered complete if it's not a list OR it's a list with its last child event containing an EventList = Complete.
- isList() — Returns true if this response contains the key EventList with the word 'start' in it. Another way is to have a Message key, like: Message: Result will follow
- isSuccess() — Checks if the Response field has the word Error in it.
- setActionId() — Sets an action id. This should not be necessary, but asterisk sometimes decides to not send the Response: or Event: headers.
Inherited from PAMI\Message\IncomingMessage
public
- __sleep() — Serialize function.
- getAllChannelVariables() — Returns the channel variables for all reported channels.
- getAllStatusVariables() — Returns the channel variables for all reported channels.
- getChannelVariables() — Returns the channel variables for the given channel.
- getEventList() — Returns key 'EventList'. In respones, this will surely be a "start". In events, should be a "complete".
- getRawContent() — Returns the original message content without parsing.
- getStatusVariables() — Returns the channel variables for the given channel.
Inherited from PAMI\Message\Message
public
- getActionID() — Returns key: 'ActionID'.
- getBoolKey() — Returns a key by name.
- getCreatedDate() — Returns created date.
- getKey() — Returns a key by name.
- getKeys() — Returns all keys for this message.
- getVariable() — Returns a variable by name.
- getVariables() — Returns all variabels for this message.
- serialize() — Gives a string representation for this message, ready to be sent to ami.
- setVariable() — Adds a variable to this message.