diff --git a/doc/ApiIndex.md b/doc/ApiIndex.md index 53a0fcac4..00843ad17 100644 --- a/doc/ApiIndex.md +++ b/doc/ApiIndex.md @@ -162,6 +162,56 @@ API Index * [SCCPAnswerCallAction](PAMI-Message-Action-SCCPAnswerCallAction.md) * [PJSIPShowRegistrationsOutboundAction](PAMI-Message-Action-PJSIPShowRegistrationsOutboundAction.md) * [SCCPShowLineAction](PAMI-Message-Action-SCCPShowLineAction.md) + * [BridgeDestroyAction](PAMI-Message-Action-BridgeDestroyAction.md) + * [BridgeKickAction](PAMI-Message-Action-BridgeKickAction.md) + * [BridgeTechnologyListAction](PAMI-Message-Action-BridgeTechnologyListAction.md) + * [BridgeTechnologySuspendAction](PAMI-Message-Action-BridgeTechnologySuspendAction.md) + * [BridgeTechnologyUnsuspendAction](PAMI-Message-Action-BridgeTechnologyUnsuspendAction.md) + * [CancelAtxferAction](PAMI-Message-Action-CancelAtxferAction.md) + * [ConfbridgeSetSingleVideoSrcAction](PAMI-Message-Action-ConfbridgeSetSingleVideoSrcAction.md) + * [ControlPlaybackAction](PAMI-Message-Action-ControlPlaybackAction.md) + * [DeviceStateListAction](PAMI-Message-Action-DeviceStateListAction.md) + * [ExtensionStateListAction](PAMI-Message-Action-ExtensionStateListAction.md) + * [FAXSessionAction](PAMI-Message-Action-FAXSessionAction.md) + * [FAXSessionsAction](PAMI-Message-Action-FAXSessionsAction.md) + * [FAXStatsAction](PAMI-Message-Action-FAXStatsAction.md) + * [FilterAction](PAMI-Message-Action-FilterAction.md) + * [IAXnetstatsAction](PAMI-Message-Action-IAXnetstatsAction.md) + * [IAXpeerlistAction](PAMI-Message-Action-IAXpeerlistAction.md) + * [IAXpeersAction](PAMI-Message-Action-IAXpeersAction.md) + * [IAXregistryAction](PAMI-Message-Action-IAXregistryAction.md) + * [LoggerRotateAction](PAMI-Message-Action-LoggerRotateAction.md) + * [MeetmeListRoomsAction](PAMI-Message-Action-MeetmeListRoomsAction.md) + * [MuteAudioAction](PAMI-Message-Action-MuteAudioAction.md) + * [MWIDeleteAction](PAMI-Message-Action-MWIDeleteAction.md) + * [MWIGetAction](PAMI-Message-Action-MWIGetAction.md) + * [MWIUpdateAction](PAMI-Message-Action-MWIUpdateAction.md) + * [ParkinglotsAction](PAMI-Message-Action-ParkinglotsAction.md) + * [PJSIPNotifyAction](PAMI-Message-Action-PJSIPNotifyAction.md) + * [PJSIPShowAorsAction](PAMI-Message-Action-PJSIPShowAorsAction.md) + * [PJSIPShowAuthsAction](PAMI-Message-Action-PJSIPShowAuthsAction.md) + * [PJSIPShowContactsAction](PAMI-Message-Action-PJSIPShowContactsAction.md) + * [PJSIPShowRegistrationInboundContactStatusesAction](PAMI-Message-Action-PJSIPShowRegistrationInboundContactStatusesAction.md) + * [PresenceStateAction](PAMI-Message-Action-PresenceStateAction.md) + * [PresenceStateListAction](PAMI-Message-Action-PresenceStateListAction.md) + * [PRIDebugFileSetAction](PAMI-Message-Action-PRIDebugFileSetAction.md) + * [PRIDebugFileUnsetAction](PAMI-Message-Action-PRIDebugFileUnsetAction.md) + * [PRIDebugSetAction](PAMI-Message-Action-PRIDebugSetAction.md) + * [PRIShowSpansAction](PAMI-Message-Action-PRIShowSpansAction.md) + * [QueueChangePriorityCallerAction](PAMI-Message-Action-QueueChangePriorityCallerAction.md) + * [QueueMemberRingInUseAction](PAMI-Message-Action-QueueMemberRingInUseAction.md) + * [SIPpeerstatusAction](PAMI-Message-Action-SIPpeerstatusAction.md) + * [SKINNYdevicesAction](PAMI-Message-Action-SKINNYdevicesAction.md) + * [SKINNYlinesAction](PAMI-Message-Action-SKINNYlinesAction.md) + * [SKINNYshowdeviceAction](PAMI-Message-Action-SKINNYshowdeviceAction.md) + * [SKINNYshowlineAction](PAMI-Message-Action-SKINNYshowlineAction.md) + * [SorceryMemoryCacheExpireAction](PAMI-Message-Action-SorceryMemoryCacheExpireAction.md) + * [SorceryMemoryCacheExpireObjectAction](PAMI-Message-Action-SorceryMemoryCacheExpireObjectAction.md) + * [SorceryMemoryCachePopulateAction](PAMI-Message-Action-SorceryMemoryCachePopulateAction.md) + * [SorceryMemoryCacheStaleAction](PAMI-Message-Action-SorceryMemoryCacheStaleAction.md) + * [SorceryMemoryCacheStaleObjectAction](PAMI-Message-Action-SorceryMemoryCacheStaleObjectAction.md) + * [VoicemailRefreshAction](PAMI-Message-Action-VoicemailRefreshAction.md) + * [VoicemailUserStatusAction](PAMI-Message-Action-VoicemailUserStatusAction.md) * PAMI\Message\Event * [VarSetEvent](PAMI-Message-Event-VarSetEvent.md) * [StatusEvent](PAMI-Message-Event-StatusEvent.md) diff --git a/doc/PAMI-Message-Action-AtxferAction.md b/doc/PAMI-Message-Action-AtxferAction.md new file mode 100644 index 000000000..4888c70c0 --- /dev/null +++ b/doc/PAMI-Message-Action-AtxferAction.md @@ -0,0 +1,422 @@ +PAMI\Message\Action\AtxferAction +=============== + +Atxfer Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: AtxferAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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) + + + + +### setContext + + void PAMI\Message\Action\AtxferAction::setContext(string $context) + +set Context + + + +* Visibility: **public** + + +#### Arguments +* $context **string** - <p>Context to transfer to.</p> + + + +### 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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-BridgeDestroyAction.md b/doc/PAMI-Message-Action-BridgeDestroyAction.md new file mode 100644 index 000000000..5b59b2502 --- /dev/null +++ b/doc/PAMI-Message-Action-BridgeDestroyAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\BridgeDestroyAction +=============== + +BridgeDestroy Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: BridgeDestroyAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-BridgeKickAction.md b/doc/PAMI-Message-Action-BridgeKickAction.md new file mode 100644 index 000000000..b4b009258 --- /dev/null +++ b/doc/PAMI-Message-Action-BridgeKickAction.md @@ -0,0 +1,422 @@ +PAMI\Message\Action\BridgeKickAction +=============== + +BridgeKick Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: BridgeKickAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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) + + + + +### setBridgeUniqueid + + void PAMI\Message\Action\BridgeKickAction::setBridgeUniqueid(string $bridgeuniqueid) + +set BridgeUniqueid + + + +* Visibility: **public** + + +#### Arguments +* $bridgeuniqueid **string** - <p>The unique ID of the bridge containing the channel to destroy. This parameter can be omitted, or supplied to insure that the channel is not removed from the wrong bridge.</p> + + + +### 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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-BridgeTechnologyListAction.md b/doc/PAMI-Message-Action-BridgeTechnologyListAction.md new file mode 100644 index 000000000..7088d20e8 --- /dev/null +++ b/doc/PAMI-Message-Action-BridgeTechnologyListAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\BridgeTechnologyListAction +=============== + +BridgeTechnologyList Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: BridgeTechnologyListAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-BridgeTechnologySuspendAction.md b/doc/PAMI-Message-Action-BridgeTechnologySuspendAction.md new file mode 100644 index 000000000..8d930a4c0 --- /dev/null +++ b/doc/PAMI-Message-Action-BridgeTechnologySuspendAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\BridgeTechnologySuspendAction +=============== + +BridgeTechnologySuspend Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: BridgeTechnologySuspendAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-BridgeTechnologyUnsuspendAction.md b/doc/PAMI-Message-Action-BridgeTechnologyUnsuspendAction.md new file mode 100644 index 000000000..6103d9c85 --- /dev/null +++ b/doc/PAMI-Message-Action-BridgeTechnologyUnsuspendAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\BridgeTechnologyUnsuspendAction +=============== + +BridgeTechnologyUnsuspend Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: BridgeTechnologyUnsuspendAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-CancelAtxferAction.md b/doc/PAMI-Message-Action-CancelAtxferAction.md new file mode 100644 index 000000000..a1d917ccc --- /dev/null +++ b/doc/PAMI-Message-Action-CancelAtxferAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\CancelAtxferAction +=============== + +CancelAtxfer Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: CancelAtxferAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-ConfbridgeSetSingleVideoSrcAction.md b/doc/PAMI-Message-Action-ConfbridgeSetSingleVideoSrcAction.md new file mode 100644 index 000000000..86abc3be6 --- /dev/null +++ b/doc/PAMI-Message-Action-ConfbridgeSetSingleVideoSrcAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\ConfbridgeSetSingleVideoSrcAction +=============== + +ConfbridgeSetSingleVideoSrc Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: ConfbridgeSetSingleVideoSrcAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-ControlPlaybackAction.md b/doc/PAMI-Message-Action-ControlPlaybackAction.md new file mode 100644 index 000000000..3b3dc110b --- /dev/null +++ b/doc/PAMI-Message-Action-ControlPlaybackAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\ControlPlaybackAction +=============== + +ControlPlayback Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: ControlPlaybackAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-DeviceStateListAction.md b/doc/PAMI-Message-Action-DeviceStateListAction.md new file mode 100644 index 000000000..eaa939310 --- /dev/null +++ b/doc/PAMI-Message-Action-DeviceStateListAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\DeviceStateListAction +=============== + +DeviceStateList Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: DeviceStateListAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-ExtensionStateListAction.md b/doc/PAMI-Message-Action-ExtensionStateListAction.md new file mode 100644 index 000000000..590cbd1d8 --- /dev/null +++ b/doc/PAMI-Message-Action-ExtensionStateListAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\ExtensionStateListAction +=============== + +ExtensionStateList Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: ExtensionStateListAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-FAXSessionAction.md b/doc/PAMI-Message-Action-FAXSessionAction.md new file mode 100644 index 000000000..fca5a5a84 --- /dev/null +++ b/doc/PAMI-Message-Action-FAXSessionAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\FAXSessionAction +=============== + +FAXSession Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: FAXSessionAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-FAXSessionsAction.md b/doc/PAMI-Message-Action-FAXSessionsAction.md new file mode 100644 index 000000000..c158dec2a --- /dev/null +++ b/doc/PAMI-Message-Action-FAXSessionsAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\FAXSessionsAction +=============== + +FAXSessions Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: FAXSessionsAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-FAXStatsAction.md b/doc/PAMI-Message-Action-FAXStatsAction.md new file mode 100644 index 000000000..020e529fd --- /dev/null +++ b/doc/PAMI-Message-Action-FAXStatsAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\FAXStatsAction +=============== + +FAXStats Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: FAXStatsAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-FilterAction.md b/doc/PAMI-Message-Action-FilterAction.md new file mode 100644 index 000000000..55f328d54 --- /dev/null +++ b/doc/PAMI-Message-Action-FilterAction.md @@ -0,0 +1,438 @@ +PAMI\Message\Action\FilterAction +=============== + +Filter Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: FilterAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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) + + + + +### setOperation + + void PAMI\Message\Action\FilterAction::setOperation(string $operation) + +set Operation + + + +* Visibility: **public** + + +#### Arguments +* $operation **string** + + + +### setFilter + + void PAMI\Message\Action\FilterAction::setFilter(string $filter) + +set Filter + + + +* Visibility: **public** + + +#### Arguments +* $filter **string** - <p>Filters can be whitelist or blacklist</p> + + + +### 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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-IAXnetstatsAction.md b/doc/PAMI-Message-Action-IAXnetstatsAction.md new file mode 100644 index 000000000..c64fe9b56 --- /dev/null +++ b/doc/PAMI-Message-Action-IAXnetstatsAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\IAXnetstatsAction +=============== + +IAXnetstats Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: IAXnetstatsAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-IAXpeerlistAction.md b/doc/PAMI-Message-Action-IAXpeerlistAction.md new file mode 100644 index 000000000..1cf57cdc1 --- /dev/null +++ b/doc/PAMI-Message-Action-IAXpeerlistAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\IAXpeerlistAction +=============== + +IAXpeerlist Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: IAXpeerlistAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-IAXpeersAction.md b/doc/PAMI-Message-Action-IAXpeersAction.md new file mode 100644 index 000000000..09067cf9a --- /dev/null +++ b/doc/PAMI-Message-Action-IAXpeersAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\IAXpeersAction +=============== + +IAXpeers Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: IAXpeersAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-IAXregistryAction.md b/doc/PAMI-Message-Action-IAXregistryAction.md new file mode 100644 index 000000000..13b1a8f1d --- /dev/null +++ b/doc/PAMI-Message-Action-IAXregistryAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\IAXregistryAction +=============== + +IAXregistry Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: IAXregistryAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-LoggerRotateAction.md b/doc/PAMI-Message-Action-LoggerRotateAction.md new file mode 100644 index 000000000..59b0af2fc --- /dev/null +++ b/doc/PAMI-Message-Action-LoggerRotateAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\LoggerRotateAction +=============== + +LoggerRotate Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: LoggerRotateAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-MWIDeleteAction.md b/doc/PAMI-Message-Action-MWIDeleteAction.md new file mode 100644 index 000000000..b47af2ea4 --- /dev/null +++ b/doc/PAMI-Message-Action-MWIDeleteAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\MWIDeleteAction +=============== + +MWIDelete Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: MWIDeleteAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-MWIGetAction.md b/doc/PAMI-Message-Action-MWIGetAction.md new file mode 100644 index 000000000..2b86f896d --- /dev/null +++ b/doc/PAMI-Message-Action-MWIGetAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\MWIGetAction +=============== + +MWIGet Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: MWIGetAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-MWIUpdateAction.md b/doc/PAMI-Message-Action-MWIUpdateAction.md new file mode 100644 index 000000000..b264e6295 --- /dev/null +++ b/doc/PAMI-Message-Action-MWIUpdateAction.md @@ -0,0 +1,438 @@ +PAMI\Message\Action\MWIUpdateAction +=============== + +MWIUpdate Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: MWIUpdateAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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) + + + + +### setOldMessages + + void PAMI\Message\Action\MWIUpdateAction::setOldMessages(string $oldmessages) + +set OldMessages + + + +* Visibility: **public** + + +#### Arguments +* $oldmessages **string** - <p>The number of old messages in the mailbox. Defaults to zero if missing.</p> + + + +### setNewMessages + + void PAMI\Message\Action\MWIUpdateAction::setNewMessages(string $newmessages) + +set NewMessages + + + +* Visibility: **public** + + +#### Arguments +* $newmessages **string** - <p>The number of new messages in the mailbox. Defaults to zero if missing.</p> + + + +### 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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-MeetmeListRoomsAction.md b/doc/PAMI-Message-Action-MeetmeListRoomsAction.md new file mode 100644 index 000000000..4c3542052 --- /dev/null +++ b/doc/PAMI-Message-Action-MeetmeListRoomsAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\MeetmeListRoomsAction +=============== + +MeetmeListRooms Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: MeetmeListRoomsAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-MuteAudioAction.md b/doc/PAMI-Message-Action-MuteAudioAction.md new file mode 100644 index 000000000..4ad412a5a --- /dev/null +++ b/doc/PAMI-Message-Action-MuteAudioAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\MuteAudioAction +=============== + +MuteAudio Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: MuteAudioAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PJSIPNotifyAction.md b/doc/PAMI-Message-Action-PJSIPNotifyAction.md new file mode 100644 index 000000000..343fb7654 --- /dev/null +++ b/doc/PAMI-Message-Action-PJSIPNotifyAction.md @@ -0,0 +1,454 @@ +PAMI\Message\Action\PJSIPNotifyAction +=============== + +PJSIPNotify Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PJSIPNotifyAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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) + + + + +### setEndpoint + + void PAMI\Message\Action\PJSIPNotifyAction::setEndpoint(string $endpoint) + +set Endpoint + + + +* Visibility: **public** + + +#### Arguments +* $endpoint **string** - <p>The endpoint to which to send the NOTIFY.</p> + + + +### setURI + + void PAMI\Message\Action\PJSIPNotifyAction::setURI(string $uri) + +set URI + + + +* Visibility: **public** + + +#### Arguments +* $uri **string** - <p>Abritrary URI to which to send the NOTIFY.</p> + + + +### setchannel + + void PAMI\Message\Action\PJSIPNotifyAction::setchannel(string $channel) + +set channel + + + +* Visibility: **public** + + +#### Arguments +* $channel **string** - <p>Channel name to send the NOTIFY. Must be a PJSIP channel.</p> + + + +### 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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PJSIPShowAorsAction.md b/doc/PAMI-Message-Action-PJSIPShowAorsAction.md new file mode 100644 index 000000000..accd51663 --- /dev/null +++ b/doc/PAMI-Message-Action-PJSIPShowAorsAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\PJSIPShowAorsAction +=============== + +PJSIPShowAors Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PJSIPShowAorsAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PJSIPShowAuthsAction.md b/doc/PAMI-Message-Action-PJSIPShowAuthsAction.md new file mode 100644 index 000000000..68258b030 --- /dev/null +++ b/doc/PAMI-Message-Action-PJSIPShowAuthsAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\PJSIPShowAuthsAction +=============== + +PJSIPShowAuths Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PJSIPShowAuthsAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PJSIPShowContactsAction.md b/doc/PAMI-Message-Action-PJSIPShowContactsAction.md new file mode 100644 index 000000000..da3706940 --- /dev/null +++ b/doc/PAMI-Message-Action-PJSIPShowContactsAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\PJSIPShowContactsAction +=============== + +PJSIPShowContacts Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PJSIPShowContactsAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PJSIPShowRegistrationInboundContactStatusesAction.md b/doc/PAMI-Message-Action-PJSIPShowRegistrationInboundContactStatusesAction.md new file mode 100644 index 000000000..71e35d09d --- /dev/null +++ b/doc/PAMI-Message-Action-PJSIPShowRegistrationInboundContactStatusesAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\PJSIPShowRegistrationInboundContactStatusesAction +=============== + +PJSIPShowRegistrationInboundContactStatuses Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PJSIPShowRegistrationInboundContactStatusesAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PRIDebugFileSetAction.md b/doc/PAMI-Message-Action-PRIDebugFileSetAction.md new file mode 100644 index 000000000..48311950d --- /dev/null +++ b/doc/PAMI-Message-Action-PRIDebugFileSetAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\PRIDebugFileSetAction +=============== + +PRIDebugFileSet Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PRIDebugFileSetAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PRIDebugFileUnsetAction.md b/doc/PAMI-Message-Action-PRIDebugFileUnsetAction.md new file mode 100644 index 000000000..00fdb31f7 --- /dev/null +++ b/doc/PAMI-Message-Action-PRIDebugFileUnsetAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\PRIDebugFileUnsetAction +=============== + +PRIDebugFileUnset Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PRIDebugFileUnsetAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PRIDebugSetAction.md b/doc/PAMI-Message-Action-PRIDebugSetAction.md new file mode 100644 index 000000000..4ff6269e8 --- /dev/null +++ b/doc/PAMI-Message-Action-PRIDebugSetAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\PRIDebugSetAction +=============== + +PRIDebugSet Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PRIDebugSetAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PRIShowSpansAction.md b/doc/PAMI-Message-Action-PRIShowSpansAction.md new file mode 100644 index 000000000..ac546d2ea --- /dev/null +++ b/doc/PAMI-Message-Action-PRIShowSpansAction.md @@ -0,0 +1,422 @@ +PAMI\Message\Action\PRIShowSpansAction +=============== + +PRIShowSpans Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PRIShowSpansAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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) + + + + +### setSpan + + void PAMI\Message\Action\PRIShowSpansAction::setSpan(string $span) + +set Span + + + +* Visibility: **public** + + +#### Arguments +* $span **string** - <p>Specify the specific span to show. Show all spans if zero or not present.</p> + + + +### 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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-ParkinglotsAction.md b/doc/PAMI-Message-Action-ParkinglotsAction.md new file mode 100644 index 000000000..c5e0f01b7 --- /dev/null +++ b/doc/PAMI-Message-Action-ParkinglotsAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\ParkinglotsAction +=============== + +Parkinglots Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: ParkinglotsAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PresenceStateAction.md b/doc/PAMI-Message-Action-PresenceStateAction.md new file mode 100644 index 000000000..09d520175 --- /dev/null +++ b/doc/PAMI-Message-Action-PresenceStateAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\PresenceStateAction +=============== + +PresenceState Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PresenceStateAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-PresenceStateListAction.md b/doc/PAMI-Message-Action-PresenceStateListAction.md new file mode 100644 index 000000000..2511b62c5 --- /dev/null +++ b/doc/PAMI-Message-Action-PresenceStateListAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\PresenceStateListAction +=============== + +PresenceStateList Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: PresenceStateListAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-QueueChangePriorityCallerAction.md b/doc/PAMI-Message-Action-QueueChangePriorityCallerAction.md new file mode 100644 index 000000000..bfe345385 --- /dev/null +++ b/doc/PAMI-Message-Action-QueueChangePriorityCallerAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\QueueChangePriorityCallerAction +=============== + +QueueChangePriorityCaller Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: QueueChangePriorityCallerAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-QueueMemberRingInUseAction.md b/doc/PAMI-Message-Action-QueueMemberRingInUseAction.md new file mode 100644 index 000000000..1bdb526fb --- /dev/null +++ b/doc/PAMI-Message-Action-QueueMemberRingInUseAction.md @@ -0,0 +1,422 @@ +PAMI\Message\Action\QueueMemberRingInUseAction +=============== + +QueueMemberRingInUse Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: QueueMemberRingInUseAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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) + + + + +### setQueue + + void PAMI\Message\Action\QueueMemberRingInUseAction::setQueue(string $queue) + +set Queue + + + +* Visibility: **public** + + +#### Arguments +* $queue **string** + + + +### 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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-SIPpeerstatusAction.md b/doc/PAMI-Message-Action-SIPpeerstatusAction.md new file mode 100644 index 000000000..eff403942 --- /dev/null +++ b/doc/PAMI-Message-Action-SIPpeerstatusAction.md @@ -0,0 +1,422 @@ +PAMI\Message\Action\SIPpeerstatusAction +=============== + +SIPpeerstatus Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: SIPpeerstatusAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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) + + + + +### setPeer + + void PAMI\Message\Action\SIPpeerstatusAction::setPeer(string $peer) + +set Peer + + + +* Visibility: **public** + + +#### Arguments +* $peer **string** - <p>The peer name you want to check.</p> + + + +### 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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-SKINNYdevicesAction.md b/doc/PAMI-Message-Action-SKINNYdevicesAction.md new file mode 100644 index 000000000..65122f2de --- /dev/null +++ b/doc/PAMI-Message-Action-SKINNYdevicesAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\SKINNYdevicesAction +=============== + +SKINNYdevices Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: SKINNYdevicesAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-SKINNYlinesAction.md b/doc/PAMI-Message-Action-SKINNYlinesAction.md new file mode 100644 index 000000000..df49a2c2e --- /dev/null +++ b/doc/PAMI-Message-Action-SKINNYlinesAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\SKINNYlinesAction +=============== + +SKINNYlines Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: SKINNYlinesAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-SKINNYshowdeviceAction.md b/doc/PAMI-Message-Action-SKINNYshowdeviceAction.md new file mode 100644 index 000000000..c21c61afe --- /dev/null +++ b/doc/PAMI-Message-Action-SKINNYshowdeviceAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\SKINNYshowdeviceAction +=============== + +SKINNYshowdevice Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: SKINNYshowdeviceAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-SKINNYshowlineAction.md b/doc/PAMI-Message-Action-SKINNYshowlineAction.md new file mode 100644 index 000000000..10dd7414f --- /dev/null +++ b/doc/PAMI-Message-Action-SKINNYshowlineAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\SKINNYshowlineAction +=============== + +SKINNYshowline Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: SKINNYshowlineAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-SorceryMemoryCacheExpireAction.md b/doc/PAMI-Message-Action-SorceryMemoryCacheExpireAction.md new file mode 100644 index 000000000..e06c9c417 --- /dev/null +++ b/doc/PAMI-Message-Action-SorceryMemoryCacheExpireAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\SorceryMemoryCacheExpireAction +=============== + +SorceryMemoryCacheExpire Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: SorceryMemoryCacheExpireAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-SorceryMemoryCacheExpireObjectAction.md b/doc/PAMI-Message-Action-SorceryMemoryCacheExpireObjectAction.md new file mode 100644 index 000000000..fd417d36d --- /dev/null +++ b/doc/PAMI-Message-Action-SorceryMemoryCacheExpireObjectAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\SorceryMemoryCacheExpireObjectAction +=============== + +SorceryMemoryCacheExpireObject Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: SorceryMemoryCacheExpireObjectAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-SorceryMemoryCachePopulateAction.md b/doc/PAMI-Message-Action-SorceryMemoryCachePopulateAction.md new file mode 100644 index 000000000..6699955be --- /dev/null +++ b/doc/PAMI-Message-Action-SorceryMemoryCachePopulateAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\SorceryMemoryCachePopulateAction +=============== + +SorceryMemoryCachePopulate Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: SorceryMemoryCachePopulateAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-SorceryMemoryCacheStaleAction.md b/doc/PAMI-Message-Action-SorceryMemoryCacheStaleAction.md new file mode 100644 index 000000000..f8655f0d2 --- /dev/null +++ b/doc/PAMI-Message-Action-SorceryMemoryCacheStaleAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\SorceryMemoryCacheStaleAction +=============== + +SorceryMemoryCacheStale Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: SorceryMemoryCacheStaleAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-SorceryMemoryCacheStaleObjectAction.md b/doc/PAMI-Message-Action-SorceryMemoryCacheStaleObjectAction.md new file mode 100644 index 000000000..016c711f0 --- /dev/null +++ b/doc/PAMI-Message-Action-SorceryMemoryCacheStaleObjectAction.md @@ -0,0 +1,422 @@ +PAMI\Message\Action\SorceryMemoryCacheStaleObjectAction +=============== + +SorceryMemoryCacheStaleObject Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: SorceryMemoryCacheStaleObjectAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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) + + + + +### setReload + + void PAMI\Message\Action\SorceryMemoryCacheStaleObjectAction::setReload(string $reload) + +set Reload + + + +* Visibility: **public** + + +#### Arguments +* $reload **string** - <p>If true, then immediately reload the object from the backend cache instead of waiting for the next retrieval</p> + + + +### 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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-VoicemailRefreshAction.md b/doc/PAMI-Message-Action-VoicemailRefreshAction.md new file mode 100644 index 000000000..a9fb830d5 --- /dev/null +++ b/doc/PAMI-Message-Action-VoicemailRefreshAction.md @@ -0,0 +1,438 @@ +PAMI\Message\Action\VoicemailRefreshAction +=============== + +VoicemailRefresh Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: VoicemailRefreshAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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) + + + + +### setContext + + void PAMI\Message\Action\VoicemailRefreshAction::setContext(string $context) + +set Context + + + +* Visibility: **public** + + +#### Arguments +* $context **string** + + + +### setMailbox + + void PAMI\Message\Action\VoicemailRefreshAction::setMailbox(string $mailbox) + +set Mailbox + + + +* Visibility: **public** + + +#### Arguments +* $mailbox **string** + + + +### 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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/doc/PAMI-Message-Action-VoicemailUserStatusAction.md b/doc/PAMI-Message-Action-VoicemailUserStatusAction.md new file mode 100644 index 000000000..0411091fd --- /dev/null +++ b/doc/PAMI-Message-Action-VoicemailUserStatusAction.md @@ -0,0 +1,406 @@ +PAMI\Message\Action\VoicemailUserStatusAction +=============== + +VoicemailUserStatus Action + +Note: Auto Generated using xsltproc + +PHP Version 5 + + +* Class name: VoicemailUserStatusAction +* 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 +---------- + + +### $responseHandler + + private string $responseHandler = null + +String of the Class name to handle the Response to this Message + + + +* Visibility: **private** + + +### $lines + + protected array $lines + +Message content, line by line. This is what it gets sent +or received literally. + + + +* Visibility: **protected** + + +### $variables + + protected array $variables + +Metadata. Message variables (key/value). + + + +* Visibility: **protected** + + +### $keys + + protected array $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> + + + +### getResponseHandler + + string|null PAMI\Message\OutgoingMessage::getResponseHandler() + +Returns the class name of the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + + + +### setResponseHandler + + void PAMI\Message\OutgoingMessage::setResponseHandler($newResponseHandler) + +Set the response handler. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\OutgoingMessage](PAMI-Message-OutgoingMessage.md) + + +#### Arguments +* $newResponseHandler **mixed** + + + +### __sleep + + array 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> + + + +### sanitizeInput + + \PAMI\Message\typed PAMI\Message\Message::sanitizeInput(string $value) + +Sanitize incoming value + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $value **string** - <p>Key value.</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> + + + +### setSanitizedKey + + void PAMI\Message\Message::setSanitizedKey(string $key, string $value) + +Adds a variable to this message after sanitizing it first. + + + +* 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> + + + +### getBoolKey + + string PAMI\Message\Message::getBoolKey(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 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 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) + + + diff --git a/docs/nav.html b/docs/nav.html index 16189410b..195ca94d0 100644 --- a/docs/nav.html +++ b/docs/nav.html @@ -1,3 +1,3 @@ -API Documentation