PAMI\Message\Action\CoreStatusAction =============== CoreStatus action message. PHP Version 5 * Class name: CoreStatusAction * Namespace: PAMI\Message\Action * Parent class: [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) Constants ---------- ### EOL const EOL = "\r\n" ### EOM const EOM = "\r\n\r\n" Properties ---------- ### $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 ------- ### __construct void PAMI\Message\Message::__construct() Constructor. * Visibility: **public** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) ### setActionID void PAMI\Message\Action\ActionMessage::setActionID($actionID) Sets Action ID. The ActionID can be at most 69 characters long, according to [Asterisk Issue 14847](https://issues.asterisk.org/jira/browse/14847). Therefore we'll throw an exception when the ActionID is too long. * Visibility: **public** * This method is defined by [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) #### Arguments * $actionID **mixed** - <p>The Action ID to have this action known by</p> ### __sleep array<mixed,string> PAMI\Message\Message::__sleep() Serialize function. * Visibility: **public** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) ### getCreatedDate integer PAMI\Message\Message::getCreatedDate() Returns created date. * Visibility: **public** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) ### setVariable void PAMI\Message\Message::setVariable(string $key, string $value) Adds a variable to this message. * Visibility: **public** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) #### 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. * Visibility: **public** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) #### Arguments * $key **string** - <p>Variable name.</p> ### setKey void PAMI\Message\Message::setKey(string $key, string $value) Adds a variable to this message. * Visibility: **protected** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) #### 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. * Visibility: **public** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) #### Arguments * $key **string** - <p>Key name (i.e: Action).</p> ### getKeys array<mixed,string> PAMI\Message\Message::getKeys() Returns all keys for this message. * Visibility: **public** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) ### getVariables array<mixed,string> PAMI\Message\Message::getVariables() Returns all variabels for this message. * Visibility: **public** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) ### finishMessage string PAMI\Message\Message::finishMessage($message) Returns the end of message token appended to the end of a given message. * Visibility: **protected** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) #### Arguments * $message **mixed** ### serializeVariable string PAMI\Message\Message::serializeVariable(string $key, string $value) Returns the string representation for an ami action variable. * Visibility: **private** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) #### Arguments * $key **string** * $value **string** ### serialize string PAMI\Message\Message::serialize() Gives a string representation for this message, ready to be sent to ami. * Visibility: **public** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) ### getActionID string PAMI\Message\Message::getActionID() Returns key: 'ActionID'. * Visibility: **public** * This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md)