PAMI\Message\Response\ComplexResponse
A generic SCCP response message from ami.
PHP Version 5
- Author: Marcelo Gornstein <marcelog@gmail.com>
- License: http://marcelog.github.com/PAMI/ Apache License 2.0
Synopsis
class ComplexResponse
extends Response
{
- // methods
- 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
Extends
Constants
Name | Value |
---|---|
EOL | "\r\n" |
EOM | "\r\n\r\n" |
Methods
public
- __construct() — Constructor.
- 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.