PAMI\Message\Response\SCCPShowLineResponse
A sccp show line 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 SCCPShowLineResponse
extends ComplexResponse
{
- // methods
- public void __construct()
- public string getName()
- public string getDescription()
- public string getLabel()
- public integer getID()
- public integer getPin()
- public string getVoiceMailNumber()
- public string getTransferToVoicemail()
- public boolean getMeetMeEnabled()
- public string getMeetMeNumber()
- public string getMeetMeOptions()
- public string getContext()
- public string getLanguage()
- public string getAccountCode()
- public string getMusicclass()
- public integer getAmaFlags()
- public array getCallGroup()
- public array getPickupGroup()
- public array getNamedCallGroup()
- public array getNamedPickupGroup()
- public string getParkingLot()
- public string getCallerIDName()
- public string getCallerIDNumber()
- public integer getIncomingCallsLimit()
- public integer getActiveChannelCount()
- public integer getSecDialtoneDigits()
- public integer getSecDialtone()
- public boolean getEchoCancellation()
- public boolean getSilenceSuppression()
- public boolean getCanTransfer()
- public string getDNDAction()
- public boolean getIsRealtimeLine()
- public boolean getPendingDelete()
- public boolean getPendingUpdate()
- public string getRegistrationExtension()
- public string getRegistrationContext()
- public boolean getAdhocNumberAssigned()
- public integer getMessageWaitingNew()
- public integer getMessageWaitingOld()
- public array getAttachedDevices()
- public array getMailboxes()
- public array getVariables()
- // 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.
- getAccountCode() — Returns key: 'AccountCode'.
- getActiveChannelCount() — Returns key: 'ActiveChannelCount'.
- getAdhocNumberAssigned() — Returns key: 'AdhocNumberAssigned'.
- getAmaFlags() — Returns key: 'AmaFlags'.
- getAttachedDevices() — Returns events[] related to AttachedDevices from the tables['AttachedDevices']
- getCallGroup() — Returns key: 'CallGroup'.
- getCallerIDName() — Returns key: 'CallerIDName'.
- getCallerIDNumber() — Returns key: 'CallerIDNumber'.
- getCanTransfer() — Returns key: 'CanTransfer'.
- getContext() — Returns key: 'Context'.
- getDNDAction() — Returns key: 'DNDAction'.
- getDescription() — Returns key: 'Description'.
- getEchoCancellation() — Returns key: 'EchoCancellation'.
- getID() — Returns key: 'ID'.
- getIncomingCallsLimit() — Returns key: 'IncomingCallsLimit'.
- getIsRealtimeLine() — Returns key: 'IsRealtimeLine'.
- getLabel() — Returns key: 'Label'.
- getLanguage() — Returns key: 'Language'.
- getMailboxes() — Returns an array of SCCPSCCPMailboxEntryEvent's
- getMeetMeEnabled() — Returns key: 'MeetMeEnabled'.
- getMeetMeNumber() — Returns key: 'MeetMeNumber'.
- getMeetMeOptions() — Returns key: 'MeetMeOptions'.
- getMessageWaitingNew() — Returns key: 'MessageWaitingNew'.
- getMessageWaitingOld() — Returns key: 'MessageWaitingOld'.
- getMusicclass() — Returns key: 'Musicclass'.
- getName() — Returns key: 'Name'.
- getNamedCallGroup() — Returns key: 'NamedCallGroup'.
- getNamedPickupGroup() — Returns key: 'NamedPickupGroup'.
- getParkingLot() — Returns key: 'ParkingLot'.
- getPendingDelete() — Returns key: 'PendingDelete'.
- getPendingUpdate() — Returns key: 'PendingUpdate'.
- getPickupGroup() — Returns key: 'PickupGroup'.
- getPin() — Returns key: 'Pin'.
- getRegistrationContext() — Returns key: 'RegistrationContext'.
- getRegistrationExtension() — Returns key: 'RegistrationExtension'.
- getSecDialtone() — Returns key: 'SecDialtone'.
- getSecDialtoneDigits() — Returns key: 'SecDialtoneDigits'.
- getSilenceSuppression() — Returns key: 'SilenceSuppression'.
- getTransferToVoicemail() — Returns key: 'TransferToVoicemail'.
- getVariables() — Returns an array of SCCPVariableEntryEvent's
- getVoiceMailNumber() — Returns key: 'VoiceMailNumber'.
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.