PAMI\Message\Response\ComplexResponse

A generic SCCP response message from ami.

PHP Version 5

Synopsis

class ComplexResponse extends Response {
  • // Inherited constants from Message
  • const EOL = "\r\n";
  • const EOM = "\r\n\r\n";
}

Hierarchy

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

Inherited from PAMI\Message\Message

public