PAMI\Message\Response\ResponseMessage

A generic response message from ami.

PHP Version 5

Constants

EOL

const EOL = "\r\n"

EOM

const EOM = "\r\n\r\n"

Properties

$events

private array<mixed,\PAMI\Message\Event\EventMessage> $events

Child events.

  • Visibility: private

$completed

private boolean $completed

Is this response completed? (with all its events).

  • Visibility: private

$rawContent

protected string $rawContent

Holds original message.

  • Visibility: protected

$channelVariables

protected array<mixed,string> $channelVariables

Metadata. Specific channel variables.

  • Visibility: protected

$lines

protected array<mixed,string> $lines

Message content, line by line. This is what it gets sent or received literally.

  • Visibility: protected

$variables

protected array<mixed,string> $variables

Metadata. Message variables (key/value).

  • Visibility: protected

$keys

protected array<mixed,string> $keys

Metadata. Message "keys" i.e: Action: login

  • Visibility: protected

$createdDate

protected integer $createdDate

Created date (unix timestamp).

  • Visibility: protected

Methods

__sleep

array<mixed,string> PAMI\Message\Message::__sleep()

Serialize function.

isComplete

boolean PAMI\Message\Response\ResponseMessage::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.

  • Visibility: public

addEvent

void PAMI\Message\Response\ResponseMessage::addEvent(\PAMI\Message\Event\EventMessage $event)

Adds an event to this response.

  • Visibility: public

Arguments

getEvents

array<mixed,\PAMI\Message\Event\EventMessage> PAMI\Message\Response\ResponseMessage::getEvents()

Returns all associated events for this response.

  • Visibility: public

isSuccess

boolean PAMI\Message\Response\ResponseMessage::isSuccess()

Checks if the Response field has the word Error in it.

  • Visibility: public

isList

boolean PAMI\Message\Response\ResponseMessage::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

  • Visibility: public

getMessage

string PAMI\Message\Response\ResponseMessage::getMessage()

Returns key: 'Privilege'.

  • Visibility: public

setActionId

void PAMI\Message\Response\ResponseMessage::setActionId(string $actionId)

Sets an action id. This should not be necessary, but asterisk sometimes decides to not send the Response: or Event: headers.

  • Visibility: public

Arguments

  • $actionId string - <p>New ActionId.</p>

__construct

void PAMI\Message\Message::__construct()

Constructor.

getEventList

string PAMI\Message\IncomingMessage::getEventList()

Returns key 'EventList'. In respones, this will surely be a "start". In events, should be a "complete".

getRawContent

string PAMI\Message\IncomingMessage::getRawContent()

Returns the original message content without parsing.

getAllChannelVariables

array PAMI\Message\IncomingMessage::getAllChannelVariables()

Returns the channel variables for all reported channels.

https://github.com/marcelog/PAMI/issues/85

The channel names will be lowercased.

getChannelVariables

array PAMI\Message\IncomingMessage::getChannelVariables(string $channel)

Returns the channel variables for the given channel.

https://github.com/marcelog/PAMI/issues/85

Arguments

  • $channel string - <p>Channel name. If not given, will return variables for the "current" channel.</p>

getCreatedDate

integer PAMI\Message\Message::getCreatedDate()

Returns created date.

setVariable

void PAMI\Message\Message::setVariable(string $key, string $value)

Adds a variable to this message.

Arguments

  • $key string - <p>Variable name.</p>
  • $value string - <p>Variable value.</p>

getVariable

string PAMI\Message\Message::getVariable(string $key)

Returns a variable by name.

Arguments

  • $key string - <p>Variable name.</p>

setKey

void PAMI\Message\Message::setKey(string $key, string $value)

Adds a variable to this message.

Arguments

  • $key string - <p>Key name (i.e: Action).</p>
  • $value string - <p>Key value.</p>

getKey

string PAMI\Message\Message::getKey(string $key)

Returns a key by name.

Arguments

  • $key string - <p>Key name (i.e: Action).</p>

getKeys

array<mixed,string> PAMI\Message\Message::getKeys()

Returns all keys for this message.

getVariables

array<mixed,string> PAMI\Message\Message::getVariables()

Returns all variabels for this message.

finishMessage

string PAMI\Message\Message::finishMessage($message)

Returns the end of message token appended to the end of a given message.

Arguments

  • $message mixed

serializeVariable

string PAMI\Message\Message::serializeVariable(string $key, string $value)

Returns the string representation for an ami action variable.

Arguments

  • $key string
  • $value string

serialize

string PAMI\Message\Message::serialize()

Gives a string representation for this message, ready to be sent to ami.

getActionID

string PAMI\Message\Message::getActionID()

Returns key: 'ActionID'.