From 9112003eaf1c259c2fa57f1e1f60a515474af557 Mon Sep 17 00:00:00 2001 From: wizzle Date: Tue, 16 Jan 2018 17:32:54 +0300 Subject: [PATCH 01/11] added bridge list action and event --- README.md | 2 + src/PAMI/Message/Action/BridgeListAction.php | 30 +++++++ .../Message/Event/BridgeListItemEvent.php | 78 +++++++++++++++++++ 3 files changed, 110 insertions(+) create mode 100644 src/PAMI/Message/Action/BridgeListAction.php create mode 100644 src/PAMI/Message/Event/BridgeListItemEvent.php diff --git a/README.md b/README.md index 0be4e82b9..cfe5e48b8 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,7 @@ can still catch them. If you catch one of these, please report it! * Bridge * BridgeInfoChannel * BridgeInfoComplete +* BridgeListItem * CEL * ChannelUpdate * ConfbridgeEnd @@ -204,6 +205,7 @@ can still catch them. If you catch one of these, please report it! * Atxfer (asterisk 1.8?) * Bridge * BridgeInfo +* BridgeList * ChangeMonitor * Command * ConfbridgeList diff --git a/src/PAMI/Message/Action/BridgeListAction.php b/src/PAMI/Message/Action/BridgeListAction.php new file mode 100644 index 000000000..c0508a8c5 --- /dev/null +++ b/src/PAMI/Message/Action/BridgeListAction.php @@ -0,0 +1,30 @@ +setKey('BridgeType', $bridgeType); + } + } +} \ No newline at end of file diff --git a/src/PAMI/Message/Event/BridgeListItemEvent.php b/src/PAMI/Message/Event/BridgeListItemEvent.php new file mode 100644 index 000000000..6ee41c195 --- /dev/null +++ b/src/PAMI/Message/Event/BridgeListItemEvent.php @@ -0,0 +1,78 @@ +getKey('BridgeUniqueid'); + } + + /** + * Returns key: 'BridgeType'. + * + * @return string + */ + public function getBridgeType() + { + return $this->getKey('BridgeType'); + } + + /** + * Returns key: 'BridgeTechnology'. + * + * @return string + */ + public function getBridgeTechnology() + { + return $this->getKey('BridgeTechnology'); + } + + /** + * Returns key: 'BridgeCreator'. + * + * @return string + */ + public function getBridgeCreator() + { + return $this->getKey('BridgeCreator'); + } + + /** + * Returns key: 'BridgeName'. + * + * @return string + */ + public function getBridgeName() + { + return $this->getKey('BridgeName'); + } + + /** + * Returns key: 'BridgeNumChannels'. + * + * @return string + */ + public function getBridgeNumChannels() + { + return $this->getKey('BridgeNumChannels'); + } + + /** + * Returns key: 'BridgeNumChannels'. + * + * @return string + */ + public function getBridgeVideoSourceMode() + { + return $this->getKey('BridgeVideoSourceMode'); + } +} \ No newline at end of file From 94f311d01bfc43128b4398da401a86b9eb126d61 Mon Sep 17 00:00:00 2001 From: wizzle Date: Tue, 16 Jan 2018 17:47:24 +0300 Subject: [PATCH 02/11] added test on bridge list action, added some phpdoc --- src/PAMI/Message/Action/BridgeListAction.php | 2 +- .../Message/Event/BridgeListItemEvent.php | 43 ++++++++++++++++++- test/actions/Test_Actions.php | 13 ++++++ 3 files changed, 55 insertions(+), 3 deletions(-) diff --git a/src/PAMI/Message/Action/BridgeListAction.php b/src/PAMI/Message/Action/BridgeListAction.php index c0508a8c5..d02bf79b9 100644 --- a/src/PAMI/Message/Action/BridgeListAction.php +++ b/src/PAMI/Message/Action/BridgeListAction.php @@ -27,4 +27,4 @@ public function __construct($bridgeType = false, $actionId = '') $this->setKey('BridgeType', $bridgeType); } } -} \ No newline at end of file +} diff --git a/src/PAMI/Message/Event/BridgeListItemEvent.php b/src/PAMI/Message/Event/BridgeListItemEvent.php index 6ee41c195..ce7f05f1c 100644 --- a/src/PAMI/Message/Event/BridgeListItemEvent.php +++ b/src/PAMI/Message/Event/BridgeListItemEvent.php @@ -1,8 +1,47 @@ + * @license http://marcelog.github.com/PAMI/ Apache License 2.0 + * @version SVN: $Id$ + * @link http://marcelog.github.com/PAMI/ + * + * Copyright 2011 Marcelo Gornstein + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ namespace PAMI\Message\Event; - +/** + * Event triggered when an action BridgeList was issued. + * + * PHP Version 5 + * + * @category Pami + * @package Message + * @subpackage Event + * @author Maxim Dorofeev + * @license http://marcelog.github.com/PAMI/ Apache License 2.0 + * @link http://marcelog.github.com/PAMI/ + */ class BridgeListItemEvent extends EventMessage { @@ -75,4 +114,4 @@ public function getBridgeVideoSourceMode() { return $this->getKey('BridgeVideoSourceMode'); } -} \ No newline at end of file +} diff --git a/test/actions/Test_Actions.php b/test/actions/Test_Actions.php index 28f9138df..4194358ab 100644 --- a/test/actions/Test_Actions.php +++ b/test/actions/Test_Actions.php @@ -232,6 +232,19 @@ public function can_bridge_info() $action = new \PAMI\Message\Action\BridgeInfoAction($bridge_uniqueid); $client = $this->_start($write, $action); } + /** + * @test + */ + public function can_bridge_list() + { + $write = array(implode("\r\n", array( + 'action: BridgeList', + 'actionid: 1432.123', + '' + ))); + $action = new \PAMI\Message\Action\BridgeListAction(); + $client = $this->_start($write, $action); + } /** * @test */ From 98b3152032f6f715097dfff292295c1cca4477b2 Mon Sep 17 00:00:00 2001 From: wizzle Date: Tue, 16 Jan 2018 18:01:56 +0300 Subject: [PATCH 03/11] test --- src/PAMI/Message/Event/BridgeListItemEvent.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/PAMI/Message/Event/BridgeListItemEvent.php b/src/PAMI/Message/Event/BridgeListItemEvent.php index ce7f05f1c..8f8c47d24 100644 --- a/src/PAMI/Message/Event/BridgeListItemEvent.php +++ b/src/PAMI/Message/Event/BridgeListItemEvent.php @@ -8,7 +8,7 @@ * @category Pami * @package Message * @subpackage Event - * @author Maxim Dorofeev + * @author Maxim Dorofeev * @license http://marcelog.github.com/PAMI/ Apache License 2.0 * @version SVN: $Id$ * @link http://marcelog.github.com/PAMI/ From 684d90a6fa9f7bd808db6da5fd1d7a272fae7609 Mon Sep 17 00:00:00 2001 From: wizzle Date: Tue, 16 Jan 2018 18:15:10 +0300 Subject: [PATCH 04/11] remove whitespace --- src/PAMI/Message/Event/BridgeListItemEvent.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/PAMI/Message/Event/BridgeListItemEvent.php b/src/PAMI/Message/Event/BridgeListItemEvent.php index 8f8c47d24..ce7f05f1c 100644 --- a/src/PAMI/Message/Event/BridgeListItemEvent.php +++ b/src/PAMI/Message/Event/BridgeListItemEvent.php @@ -8,7 +8,7 @@ * @category Pami * @package Message * @subpackage Event - * @author Maxim Dorofeev + * @author Maxim Dorofeev * @license http://marcelog.github.com/PAMI/ Apache License 2.0 * @version SVN: $Id$ * @link http://marcelog.github.com/PAMI/ From 32960b80a0a66b2968e214abfb8ea65c5a0d8064 Mon Sep 17 00:00:00 2001 From: wizzle Date: Tue, 16 Jan 2018 19:35:10 +0300 Subject: [PATCH 05/11] added new actual php version --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 2052749a2..4d1c522a5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,6 +4,7 @@ php: - '5.5' - '5.6' - '7.0' + - '7.1' before_script: - phpenv config-add test/resources/php.ini From f714777afddd57a03a3f2a4f7bbcbd8c529ae4ef Mon Sep 17 00:00:00 2001 From: wizzle Date: Tue, 16 Jan 2018 20:36:55 +0300 Subject: [PATCH 06/11] added test for the bridge list event --- test/events/Test_Events.php | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/test/events/Test_Events.php b/test/events/Test_Events.php index 580fccd13..8bb979e05 100644 --- a/test/events/Test_Events.php +++ b/test/events/Test_Events.php @@ -90,6 +90,7 @@ public function can_report_events() 'BridgeDestroy', 'BridgeEnter', 'BridgeLeave', + 'BridgeList', 'MusicOnHoldStart', 'MusicOnHoldStop', 'ConfbridgeStart', @@ -1234,6 +1235,15 @@ public function can_report_events() 'Priority' => 'Priority', 'Uniqueid' => 'Uniqueid', ), + 'BridgeList' => array( + 'BridgeUniqueid' => 'BridgeUniqueid', + 'BridgeType' => 'BridgeType', + 'BridgeTechnology' => 'BridgeTechnology', + 'BridgeCreator' => 'BridgeCreator', + 'BridgeName' => 'BridgeName', + 'BridgeNumChannels' => 'BridgeNumChannels', + 'BridgeVideoSourceMode' => 'BridgeVideoSourceMode', + ), 'MusicOnHoldStart' => array( 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', From ab9a413578ae966b14ecb33fdec82450e1e981a6 Mon Sep 17 00:00:00 2001 From: wizzle Date: Wed, 17 Jan 2018 11:01:32 +0300 Subject: [PATCH 07/11] fixed events test --- test/events/Test_Events.php | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/test/events/Test_Events.php b/test/events/Test_Events.php index 8bb979e05..00b11ca34 100644 --- a/test/events/Test_Events.php +++ b/test/events/Test_Events.php @@ -90,7 +90,7 @@ public function can_report_events() 'BridgeDestroy', 'BridgeEnter', 'BridgeLeave', - 'BridgeList', + 'BridgeListItem', 'MusicOnHoldStart', 'MusicOnHoldStop', 'ConfbridgeStart', @@ -1235,7 +1235,7 @@ public function can_report_events() 'Priority' => 'Priority', 'Uniqueid' => 'Uniqueid', ), - 'BridgeList' => array( + 'BridgeListItem' => array( 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', 'BridgeTechnology' => 'BridgeTechnology', @@ -1570,10 +1570,9 @@ private function _testEvent($eventName, array $getters, array $values, array $tr if (isset($translatedValues[$eventName][$key])) { $value = $translatedValues[$eventName][$key]; } - $this->assertTrue( method_exists($event, $methodName), - sprintf('Method %s doesn\'t exixt in event %s', $methodName, get_class($event)) + sprintf('Method %s doesn\'t exist in the event %s', $methodName, get_class($event)) ); $this->assertEquals($event->$methodName(), $value, $eventName); From 85d51e1bfcf442316fd8b840e156d8b1691e168a Mon Sep 17 00:00:00 2001 From: wizzle Date: Fri, 19 Jan 2018 15:18:11 +0300 Subject: [PATCH 08/11] addede documentation by phing --- doc/ApiIndex.md | 360 ++-- doc/PAMI-Client-Impl-ClientImpl.md | 13 +- ...PAMI-Message-Action-BlindTransferAction.md | 310 ++++ doc/PAMI-Message-Action-BridgeListAction.md | 311 ++++ doc/PAMI-Message-Action-ChallengeAction.md | 310 ++++ ...PAMI-Message-Action-DAHDITransferAction.md | 310 ++++ ...AMI-Message-Action-MixMonitorMuteAction.md | 367 +++++ doc/PAMI-Message-Action-OriginateAction.md | 4 +- doc/PAMI-Message-Action-UserEventAction.md | 310 ++++ doc/PAMI-Message-Action-VGSMSMSTxAction.md | 4 +- doc/PAMI-Message-Action-WaitEventAction.md | 310 ++++ doc/PAMI-Message-Event-AGIExecEndEvent.md | 610 +++++++ doc/PAMI-Message-Event-AGIExecStartEvent.md | 584 +++++++ doc/PAMI-Message-Event-AsyncAGIEndEvent.md | 558 +++++++ doc/PAMI-Message-Event-AsyncAGIExecEvent.md | 584 +++++++ doc/PAMI-Message-Event-AsyncAGIStartEvent.md | 571 +++++++ ...AMI-Message-Event-AttendedTransferEvent.md | 1453 +++++++++++++++++ doc/PAMI-Message-Event-BlindTransferEvent.md | 918 +++++++++++ doc/PAMI-Message-Event-BridgeCreateEvent.md | 480 ++++++ doc/PAMI-Message-Event-BridgeDestroyEvent.md | 480 ++++++ doc/PAMI-Message-Event-BridgeEnterEvent.md | 649 ++++++++ doc/PAMI-Message-Event-BridgeLeaveEvent.md | 636 ++++++++ doc/PAMI-Message-Event-BridgeListItemEvent.md | 480 ++++++ doc/PAMI-Message-Event-ConfbridgeEndEvent.md | 493 ++++++ doc/PAMI-Message-Event-ConfbridgeJoinEvent.md | 675 ++++++++ ...PAMI-Message-Event-ConfbridgeLeaveEvent.md | 675 ++++++++ doc/PAMI-Message-Event-ConfbridgeMuteEvent.md | 675 ++++++++ ...PAMI-Message-Event-ConfbridgeStartEvent.md | 493 ++++++ ...MI-Message-Event-ConfbridgeTalkingEvent.md | 688 ++++++++ ...AMI-Message-Event-ConfbridgeUnmuteEvent.md | 675 ++++++++ doc/PAMI-Message-Event-DNDStateEvent.md | 441 +++++ doc/PAMI-Message-Event-DTMFBeginEvent.md | 585 +++++++ doc/PAMI-Message-Event-DTMFEndEvent.md | 598 +++++++ doc/PAMI-Message-Event-DialBeginEvent.md | 740 +++++++++ doc/PAMI-Message-Event-DialEndEvent.md | 727 +++++++++ ...AMI-Message-Event-MusicOnHoldStartEvent.md | 571 +++++++ ...PAMI-Message-Event-MusicOnHoldStopEvent.md | 558 +++++++ doc/PAMI-Message-Event-NewextenEvent.md | 13 + doc/PAMI-Message-Event-ParkedCallEvent.md | 208 +++ ...AMI-Message-Event-ParkedCallGiveUpEvent.md | 779 +++++++++ ...MI-Message-Event-ParkedCallTimeOutEvent.md | 779 +++++++++ ...I-Message-Event-QueueCallerAbandonEvent.md | 610 +++++++ ...PAMI-Message-Event-QueueCallerJoinEvent.md | 597 +++++++ ...AMI-Message-Event-QueueCallerLeaveEvent.md | 597 +++++++ doc/PAMI-Message-Event-UnParkedCallEvent.md | 533 ++++++ 45 files changed, 23159 insertions(+), 163 deletions(-) create mode 100644 doc/PAMI-Message-Action-BlindTransferAction.md create mode 100644 doc/PAMI-Message-Action-BridgeListAction.md create mode 100644 doc/PAMI-Message-Action-ChallengeAction.md create mode 100644 doc/PAMI-Message-Action-DAHDITransferAction.md create mode 100644 doc/PAMI-Message-Action-MixMonitorMuteAction.md create mode 100644 doc/PAMI-Message-Action-UserEventAction.md create mode 100644 doc/PAMI-Message-Action-WaitEventAction.md create mode 100644 doc/PAMI-Message-Event-AGIExecEndEvent.md create mode 100644 doc/PAMI-Message-Event-AGIExecStartEvent.md create mode 100644 doc/PAMI-Message-Event-AsyncAGIEndEvent.md create mode 100644 doc/PAMI-Message-Event-AsyncAGIExecEvent.md create mode 100644 doc/PAMI-Message-Event-AsyncAGIStartEvent.md create mode 100644 doc/PAMI-Message-Event-AttendedTransferEvent.md create mode 100644 doc/PAMI-Message-Event-BlindTransferEvent.md create mode 100644 doc/PAMI-Message-Event-BridgeCreateEvent.md create mode 100644 doc/PAMI-Message-Event-BridgeDestroyEvent.md create mode 100644 doc/PAMI-Message-Event-BridgeEnterEvent.md create mode 100644 doc/PAMI-Message-Event-BridgeLeaveEvent.md create mode 100644 doc/PAMI-Message-Event-BridgeListItemEvent.md create mode 100644 doc/PAMI-Message-Event-ConfbridgeEndEvent.md create mode 100644 doc/PAMI-Message-Event-ConfbridgeJoinEvent.md create mode 100644 doc/PAMI-Message-Event-ConfbridgeLeaveEvent.md create mode 100644 doc/PAMI-Message-Event-ConfbridgeMuteEvent.md create mode 100644 doc/PAMI-Message-Event-ConfbridgeStartEvent.md create mode 100644 doc/PAMI-Message-Event-ConfbridgeTalkingEvent.md create mode 100644 doc/PAMI-Message-Event-ConfbridgeUnmuteEvent.md create mode 100644 doc/PAMI-Message-Event-DNDStateEvent.md create mode 100644 doc/PAMI-Message-Event-DTMFBeginEvent.md create mode 100644 doc/PAMI-Message-Event-DTMFEndEvent.md create mode 100644 doc/PAMI-Message-Event-DialBeginEvent.md create mode 100644 doc/PAMI-Message-Event-DialEndEvent.md create mode 100644 doc/PAMI-Message-Event-MusicOnHoldStartEvent.md create mode 100644 doc/PAMI-Message-Event-MusicOnHoldStopEvent.md create mode 100644 doc/PAMI-Message-Event-ParkedCallGiveUpEvent.md create mode 100644 doc/PAMI-Message-Event-ParkedCallTimeOutEvent.md create mode 100644 doc/PAMI-Message-Event-QueueCallerAbandonEvent.md create mode 100644 doc/PAMI-Message-Event-QueueCallerJoinEvent.md create mode 100644 doc/PAMI-Message-Event-QueueCallerLeaveEvent.md diff --git a/doc/ApiIndex.md b/doc/ApiIndex.md index d1c7caa1b..845f9fade 100644 --- a/doc/ApiIndex.md +++ b/doc/ApiIndex.md @@ -2,199 +2,243 @@ API Index ========= * PAMI - * PAMI\AsyncAgi - * [AsyncClientImpl](PAMI-AsyncAgi-AsyncClientImpl.md) - * PAMI\Client - * PAMI\Client\Exception - * [ClientException](PAMI-Client-Exception-ClientException.md) - * [IClient](PAMI-Client-IClient.md) - * PAMI\Client\Impl - * [ClientImpl](PAMI-Client-Impl-ClientImpl.md) - * PAMI\Exception - * [PAMIException](PAMI-Exception-PAMIException.md) * PAMI\Listener * [IEventListener](PAMI-Listener-IEventListener.md) * PAMI\Message + * PAMI\Message\Response + * [ResponseMessage](PAMI-Message-Response-ResponseMessage.md) * PAMI\Message\Action - * [AbsoluteTimeoutAction](PAMI-Message-Action-AbsoluteTimeoutAction.md) - * [ActionMessage](PAMI-Message-Action-ActionMessage.md) - * [AgentLogoffAction](PAMI-Message-Action-AgentLogoffAction.md) - * [AgentsAction](PAMI-Message-Action-AgentsAction.md) - * [AGIAction](PAMI-Message-Action-AGIAction.md) - * [AttendedTransferAction](PAMI-Message-Action-AttendedTransferAction.md) - * [BridgeAction](PAMI-Message-Action-BridgeAction.md) - * [ChangeMonitorAction](PAMI-Message-Action-ChangeMonitorAction.md) - * [CommandAction](PAMI-Message-Action-CommandAction.md) - * [ConfbridgeMuteAction](PAMI-Message-Action-ConfbridgeMuteAction.md) - * [ConfbridgeUnmuteAction](PAMI-Message-Action-ConfbridgeUnmuteAction.md) - * [CoreSettingsAction](PAMI-Message-Action-CoreSettingsAction.md) - * [CoreShowChannelsAction](PAMI-Message-Action-CoreShowChannelsAction.md) - * [CoreStatusAction](PAMI-Message-Action-CoreStatusAction.md) - * [CreateConfigAction](PAMI-Message-Action-CreateConfigAction.md) - * [DAHDIDialOffHookAction](PAMI-Message-Action-DAHDIDialOffHookAction.md) - * [DAHDIDNDOffAction](PAMI-Message-Action-DAHDIDNDOffAction.md) - * [DAHDIDNDOnAction](PAMI-Message-Action-DAHDIDNDOnAction.md) - * [DAHDIHangupAction](PAMI-Message-Action-DAHDIHangupAction.md) - * [DAHDIRestartAction](PAMI-Message-Action-DAHDIRestartAction.md) - * [DAHDIShowChannelsAction](PAMI-Message-Action-DAHDIShowChannelsAction.md) - * [DBDelAction](PAMI-Message-Action-DBDelAction.md) + * [SIPShowRegistryAction](PAMI-Message-Action-SIPShowRegistryAction.md) * [DBDelTreeAction](PAMI-Message-Action-DBDelTreeAction.md) - * [DBGetAction](PAMI-Message-Action-DBGetAction.md) - * [DBPutAction](PAMI-Message-Action-DBPutAction.md) - * [DongleReloadAction](PAMI-Message-Action-DongleReloadAction.md) - * [DongleResetAction](PAMI-Message-Action-DongleResetAction.md) + * [BlindTransferAction](PAMI-Message-Action-BlindTransferAction.md) * [DongleRestartAction](PAMI-Message-Action-DongleRestartAction.md) - * [DongleSendPDUAction](PAMI-Message-Action-DongleSendPDUAction.md) + * [ExtensionStateAction](PAMI-Message-Action-ExtensionStateAction.md) * [DongleSendSMSAction](PAMI-Message-Action-DongleSendSMSAction.md) - * [DongleSendUSSDAction](PAMI-Message-Action-DongleSendUSSDAction.md) + * [QueueUnpauseAction](PAMI-Message-Action-QueueUnpauseAction.md) * [DongleShowDevicesAction](PAMI-Message-Action-DongleShowDevicesAction.md) - * [DongleStartAction](PAMI-Message-Action-DongleStartAction.md) - * [DongleStopAction](PAMI-Message-Action-DongleStopAction.md) - * [EventsAction](PAMI-Message-Action-EventsAction.md) - * [ExtensionStateAction](PAMI-Message-Action-ExtensionStateAction.md) - * [GetConfigAction](PAMI-Message-Action-GetConfigAction.md) + * [PlayDTMFAction](PAMI-Message-Action-PlayDTMFAction.md) + * [PauseMonitorAction](PAMI-Message-Action-PauseMonitorAction.md) + * [ModuleReloadAction](PAMI-Message-Action-ModuleReloadAction.md) + * [VGSMSMSTxAction](PAMI-Message-Action-VGSMSMSTxAction.md) * [GetConfigJSONAction](PAMI-Message-Action-GetConfigJSONAction.md) - * [GetVarAction](PAMI-Message-Action-GetVarAction.md) + * [UpdateConfigAction](PAMI-Message-Action-UpdateConfigAction.md) + * [SIPNotifyAction](PAMI-Message-Action-SIPNotifyAction.md) + * [DAHDIDNDOnAction](PAMI-Message-Action-DAHDIDNDOnAction.md) + * [SetVarAction](PAMI-Message-Action-SetVarAction.md) + * [DongleStartAction](PAMI-Message-Action-DongleStartAction.md) + * [ShowDialPlanAction](PAMI-Message-Action-ShowDialPlanAction.md) + * [QueueRemoveAction](PAMI-Message-Action-QueueRemoveAction.md) + * [QueueResetAction](PAMI-Message-Action-QueueResetAction.md) + * [WaitEventAction](PAMI-Message-Action-WaitEventAction.md) + * [CoreSettingsAction](PAMI-Message-Action-CoreSettingsAction.md) * [HangupAction](PAMI-Message-Action-HangupAction.md) - * [JabberSendAction](PAMI-Message-Action-JabberSendAction.md) - * [ListCategoriesAction](PAMI-Message-Action-ListCategoriesAction.md) - * [ListCommandsAction](PAMI-Message-Action-ListCommandsAction.md) - * [LocalOptimizeAwayAction](PAMI-Message-Action-LocalOptimizeAwayAction.md) - * [LoginAction](PAMI-Message-Action-LoginAction.md) - * [LogoffAction](PAMI-Message-Action-LogoffAction.md) - * [MailboxCountAction](PAMI-Message-Action-MailboxCountAction.md) + * [MonitorAction](PAMI-Message-Action-MonitorAction.md) * [MailboxStatusAction](PAMI-Message-Action-MailboxStatusAction.md) - * [MeetmeListAction](PAMI-Message-Action-MeetmeListAction.md) + * [MixMonitorMuteAction](PAMI-Message-Action-MixMonitorMuteAction.md) + * [SIPQualifyPeerAction](PAMI-Message-Action-SIPQualifyPeerAction.md) + * [BridgeAction](PAMI-Message-Action-BridgeAction.md) + * [OriginateAction](PAMI-Message-Action-OriginateAction.md) + * [MailboxCountAction](PAMI-Message-Action-MailboxCountAction.md) + * [UserEventAction](PAMI-Message-Action-UserEventAction.md) + * [ChangeMonitorAction](PAMI-Message-Action-ChangeMonitorAction.md) + * [QueueAddAction](PAMI-Message-Action-QueueAddAction.md) + * [DAHDIDialOffHookAction](PAMI-Message-Action-DAHDIDialOffHookAction.md) + * [AbsoluteTimeoutAction](PAMI-Message-Action-AbsoluteTimeoutAction.md) + * [ChallengeAction](PAMI-Message-Action-ChallengeAction.md) + * [ConfbridgeListAction](PAMI-Message-Action-ConfbridgeListAction.md) + * [CreateConfigAction](PAMI-Message-Action-CreateConfigAction.md) + * [AgentLogoffAction](PAMI-Message-Action-AgentLogoffAction.md) + * [SIPShowPeerAction](PAMI-Message-Action-SIPShowPeerAction.md) + * [DAHDIHangupAction](PAMI-Message-Action-DAHDIHangupAction.md) + * [ListCategoriesAction](PAMI-Message-Action-ListCategoriesAction.md) + * [PingAction](PAMI-Message-Action-PingAction.md) * [MeetmeMuteAction](PAMI-Message-Action-MeetmeMuteAction.md) - * [MeetmeUnmuteAction](PAMI-Message-Action-MeetmeUnmuteAction.md) - * [MixMonitorAction](PAMI-Message-Action-MixMonitorAction.md) - * [ModuleCheckAction](PAMI-Message-Action-ModuleCheckAction.md) + * [LoginAction](PAMI-Message-Action-LoginAction.md) + * [ActionMessage](PAMI-Message-Action-ActionMessage.md) + * [UnpauseMonitorAction](PAMI-Message-Action-UnpauseMonitorAction.md) * [ModuleLoadAction](PAMI-Message-Action-ModuleLoadAction.md) - * [ModuleReloadAction](PAMI-Message-Action-ModuleReloadAction.md) + * [DongleResetAction](PAMI-Message-Action-DongleResetAction.md) + * [GetConfigAction](PAMI-Message-Action-GetConfigAction.md) + * [DAHDIShowChannelsAction](PAMI-Message-Action-DAHDIShowChannelsAction.md) + * [ReloadAction](PAMI-Message-Action-ReloadAction.md) + * [RedirectAction](PAMI-Message-Action-RedirectAction.md) + * [DongleReloadAction](PAMI-Message-Action-DongleReloadAction.md) + * [DBGetAction](PAMI-Message-Action-DBGetAction.md) + * [SIPPeersAction](PAMI-Message-Action-SIPPeersAction.md) * [ModuleUnloadAction](PAMI-Message-Action-ModuleUnloadAction.md) - * [MonitorAction](PAMI-Message-Action-MonitorAction.md) - * [OriginateAction](PAMI-Message-Action-OriginateAction.md) - * [ParkAction](PAMI-Message-Action-ParkAction.md) + * [MixMonitorAction](PAMI-Message-Action-MixMonitorAction.md) + * [DongleStopAction](PAMI-Message-Action-DongleStopAction.md) + * [QueueSummaryAction](PAMI-Message-Action-QueueSummaryAction.md) + * [CoreStatusAction](PAMI-Message-Action-CoreStatusAction.md) + * [DAHDITransferAction](PAMI-Message-Action-DAHDITransferAction.md) * [ParkedCallsAction](PAMI-Message-Action-ParkedCallsAction.md) - * [PauseMonitorAction](PAMI-Message-Action-PauseMonitorAction.md) - * [PingAction](PAMI-Message-Action-PingAction.md) - * [PlayDTMFAction](PAMI-Message-Action-PlayDTMFAction.md) - * [QueueAddAction](PAMI-Message-Action-QueueAddAction.md) - * [QueueLogAction](PAMI-Message-Action-QueueLogAction.md) - * [QueuePauseAction](PAMI-Message-Action-QueuePauseAction.md) - * [QueuePenaltyAction](PAMI-Message-Action-QueuePenaltyAction.md) - * [QueueReloadAction](PAMI-Message-Action-QueueReloadAction.md) - * [QueueRemoveAction](PAMI-Message-Action-QueueRemoveAction.md) - * [QueueResetAction](PAMI-Message-Action-QueueResetAction.md) - * [QueueRuleAction](PAMI-Message-Action-QueueRuleAction.md) * [QueuesAction](PAMI-Message-Action-QueuesAction.md) - * [QueueStatusAction](PAMI-Message-Action-QueueStatusAction.md) - * [QueueSummaryAction](PAMI-Message-Action-QueueSummaryAction.md) - * [QueueUnpauseAction](PAMI-Message-Action-QueueUnpauseAction.md) - * [RedirectAction](PAMI-Message-Action-RedirectAction.md) - * [ReloadAction](PAMI-Message-Action-ReloadAction.md) - * [SendTextAction](PAMI-Message-Action-SendTextAction.md) - * [SetVarAction](PAMI-Message-Action-SetVarAction.md) - * [ShowDialPlanAction](PAMI-Message-Action-ShowDialPlanAction.md) - * [SIPNotifyAction](PAMI-Message-Action-SIPNotifyAction.md) - * [SIPPeersAction](PAMI-Message-Action-SIPPeersAction.md) - * [SIPQualifyPeerAction](PAMI-Message-Action-SIPQualifyPeerAction.md) - * [SIPShowPeerAction](PAMI-Message-Action-SIPShowPeerAction.md) - * [SIPShowRegistryAction](PAMI-Message-Action-SIPShowRegistryAction.md) + * [AttendedTransferAction](PAMI-Message-Action-AttendedTransferAction.md) + * [DAHDIDNDOffAction](PAMI-Message-Action-DAHDIDNDOffAction.md) + * [BridgeListAction](PAMI-Message-Action-BridgeListAction.md) + * [BridgeInfoAction](PAMI-Message-Action-BridgeInfoAction.md) * [StatusAction](PAMI-Message-Action-StatusAction.md) + * [QueueRuleAction](PAMI-Message-Action-QueueRuleAction.md) * [StopMixMonitorAction](PAMI-Message-Action-StopMixMonitorAction.md) - * [StopMonitorAction](PAMI-Message-Action-StopMonitorAction.md) - * [UnpauseMonitorAction](PAMI-Message-Action-UnpauseMonitorAction.md) - * [UpdateConfigAction](PAMI-Message-Action-UpdateConfigAction.md) - * [VGSMSMSTxAction](PAMI-Message-Action-VGSMSMSTxAction.md) + * [QueuePenaltyAction](PAMI-Message-Action-QueuePenaltyAction.md) + * [DongleSendUSSDAction](PAMI-Message-Action-DongleSendUSSDAction.md) * [VoicemailUsersListAction](PAMI-Message-Action-VoicemailUsersListAction.md) + * [CommandAction](PAMI-Message-Action-CommandAction.md) + * [EventsAction](PAMI-Message-Action-EventsAction.md) + * [ModuleCheckAction](PAMI-Message-Action-ModuleCheckAction.md) + * [AGIAction](PAMI-Message-Action-AGIAction.md) + * [LocalOptimizeAwayAction](PAMI-Message-Action-LocalOptimizeAwayAction.md) + * [MeetmeUnmuteAction](PAMI-Message-Action-MeetmeUnmuteAction.md) + * [QueueLogAction](PAMI-Message-Action-QueueLogAction.md) + * [QueueReloadAction](PAMI-Message-Action-QueueReloadAction.md) + * [LogoffAction](PAMI-Message-Action-LogoffAction.md) + * [DongleSendPDUAction](PAMI-Message-Action-DongleSendPDUAction.md) + * [ParkAction](PAMI-Message-Action-ParkAction.md) + * [GetVarAction](PAMI-Message-Action-GetVarAction.md) + * [DBPutAction](PAMI-Message-Action-DBPutAction.md) + * [ConfbridgeMuteAction](PAMI-Message-Action-ConfbridgeMuteAction.md) + * [DAHDIRestartAction](PAMI-Message-Action-DAHDIRestartAction.md) + * [SendTextAction](PAMI-Message-Action-SendTextAction.md) + * [MeetmeListAction](PAMI-Message-Action-MeetmeListAction.md) + * [QueuePauseAction](PAMI-Message-Action-QueuePauseAction.md) + * [DBDelAction](PAMI-Message-Action-DBDelAction.md) + * [AgentsAction](PAMI-Message-Action-AgentsAction.md) + * [JabberSendAction](PAMI-Message-Action-JabberSendAction.md) + * [ConfbridgeUnmuteAction](PAMI-Message-Action-ConfbridgeUnmuteAction.md) + * [StopMonitorAction](PAMI-Message-Action-StopMonitorAction.md) + * [CoreShowChannelsAction](PAMI-Message-Action-CoreShowChannelsAction.md) + * [QueueStatusAction](PAMI-Message-Action-QueueStatusAction.md) + * [ListCommandsAction](PAMI-Message-Action-ListCommandsAction.md) + * [OutgoingMessage](PAMI-Message-OutgoingMessage.md) + * [IncomingMessage](PAMI-Message-IncomingMessage.md) * PAMI\Message\Event - * [AgentConnectEvent](PAMI-Message-Event-AgentConnectEvent.md) - * [AgentloginEvent](PAMI-Message-Event-AgentloginEvent.md) - * [AgentlogoffEvent](PAMI-Message-Event-AgentlogoffEvent.md) - * [AgentsCompleteEvent](PAMI-Message-Event-AgentsCompleteEvent.md) - * [AgentsEvent](PAMI-Message-Event-AgentsEvent.md) + * [AsyncAGIStartEvent](PAMI-Message-Event-AsyncAGIStartEvent.md) + * [DAHDIShowChannelsCompleteEvent](PAMI-Message-Event-DAHDIShowChannelsCompleteEvent.md) + * [ExtensionStatusEvent](PAMI-Message-Event-ExtensionStatusEvent.md) + * [QueueMemberPausedEvent](PAMI-Message-Event-QueueMemberPausedEvent.md) + * [UnknownEvent](PAMI-Message-Event-UnknownEvent.md) + * [ConfbridgeEndEvent](PAMI-Message-Event-ConfbridgeEndEvent.md) + * [VarSetEvent](PAMI-Message-Event-VarSetEvent.md) + * [NewchannelEvent](PAMI-Message-Event-NewchannelEvent.md) + * [BridgeInfoChannelEvent](PAMI-Message-Event-BridgeInfoChannelEvent.md) + * [MusicOnHoldStartEvent](PAMI-Message-Event-MusicOnHoldStartEvent.md) + * [NewstateEvent](PAMI-Message-Event-NewstateEvent.md) + * [RenameEvent](PAMI-Message-Event-RenameEvent.md) + * [LeaveEvent](PAMI-Message-Event-LeaveEvent.md) + * [AsyncAGIExecEvent](PAMI-Message-Event-AsyncAGIExecEvent.md) + * [ParkedCallEvent](PAMI-Message-Event-ParkedCallEvent.md) * [AGIExecEvent](PAMI-Message-Event-AGIExecEvent.md) - * [AsyncAGIEvent](PAMI-Message-Event-AsyncAGIEvent.md) - * [BridgeEvent](PAMI-Message-Event-BridgeEvent.md) - * [CELEvent](PAMI-Message-Event-CELEvent.md) - * [ChannelUpdateEvent](PAMI-Message-Event-ChannelUpdateEvent.md) - * [CoreShowChannelEvent](PAMI-Message-Event-CoreShowChannelEvent.md) + * [RTPSenderStatEvent](PAMI-Message-Event-RTPSenderStatEvent.md) + * [BlindTransferEvent](PAMI-Message-Event-BlindTransferEvent.md) + * [DongleNewCUSDEvent](PAMI-Message-Event-DongleNewCUSDEvent.md) + * [DongleSMSStatusEvent](PAMI-Message-Event-DongleSMSStatusEvent.md) * [CoreShowChannelsCompleteEvent](PAMI-Message-Event-CoreShowChannelsCompleteEvent.md) - * [DAHDIShowChannelsCompleteEvent](PAMI-Message-Event-DAHDIShowChannelsCompleteEvent.md) - * [DAHDIShowChannelsEvent](PAMI-Message-Event-DAHDIShowChannelsEvent.md) - * [DBGetResponseEvent](PAMI-Message-Event-DBGetResponseEvent.md) + * [BridgeDestroyEvent](PAMI-Message-Event-BridgeDestroyEvent.md) * [DialEvent](PAMI-Message-Event-DialEvent.md) + * [ConfbridgeListEvent](PAMI-Message-Event-ConfbridgeListEvent.md) + * [ConfbridgeLeaveEvent](PAMI-Message-Event-ConfbridgeLeaveEvent.md) + * [DialEndEvent](PAMI-Message-Event-DialEndEvent.md) * [DongleDeviceEntryEvent](PAMI-Message-Event-DongleDeviceEntryEvent.md) - * [DongleNewCUSDEvent](PAMI-Message-Event-DongleNewCUSDEvent.md) - * [DongleNewUSSDBase64Event](PAMI-Message-Event-DongleNewUSSDBase64Event.md) - * [DongleNewUSSDEvent](PAMI-Message-Event-DongleNewUSSDEvent.md) - * [DongleShowDevicesCompleteEvent](PAMI-Message-Event-DongleShowDevicesCompleteEvent.md) - * [DongleSMSStatusEvent](PAMI-Message-Event-DongleSMSStatusEvent.md) - * [DongleStatusEvent](PAMI-Message-Event-DongleStatusEvent.md) - * [DongleUSSDStatusEvent](PAMI-Message-Event-DongleUSSDStatusEvent.md) - * [DTMFEvent](PAMI-Message-Event-DTMFEvent.md) - * [EventMessage](PAMI-Message-Event-EventMessage.md) - * [ExtensionStatusEvent](PAMI-Message-Event-ExtensionStatusEvent.md) - * PAMI\Message\Event\Factory - * PAMI\Message\Event\Factory\Impl - * [EventFactoryImpl](PAMI-Message-Event-Factory-Impl-EventFactoryImpl.md) - * [FullyBootedEvent](PAMI-Message-Event-FullyBootedEvent.md) - * [HangupEvent](PAMI-Message-Event-HangupEvent.md) - * [HoldEvent](PAMI-Message-Event-HoldEvent.md) + * [BridgeInfoCompleteEvent](PAMI-Message-Event-BridgeInfoCompleteEvent.md) + * [QueueMemberAddedEvent](PAMI-Message-Event-QueueMemberAddedEvent.md) + * [AgentlogoffEvent](PAMI-Message-Event-AgentlogoffEvent.md) + * [ChannelUpdateEvent](PAMI-Message-Event-ChannelUpdateEvent.md) * [JabberEventEvent](PAMI-Message-Event-JabberEventEvent.md) - * [JoinEvent](PAMI-Message-Event-JoinEvent.md) - * [LeaveEvent](PAMI-Message-Event-LeaveEvent.md) - * [LinkEvent](PAMI-Message-Event-LinkEvent.md) - * [ListDialPlanEvent](PAMI-Message-Event-ListDialPlanEvent.md) - * [MasqueradeEvent](PAMI-Message-Event-MasqueradeEvent.md) + * [ConfbridgeMuteEvent](PAMI-Message-Event-ConfbridgeMuteEvent.md) + * [VoicemailUserEntryEvent](PAMI-Message-Event-VoicemailUserEntryEvent.md) + * [AGIExecEndEvent](PAMI-Message-Event-AGIExecEndEvent.md) * [MessageWaitingEvent](PAMI-Message-Event-MessageWaitingEvent.md) - * [MusicOnHoldEvent](PAMI-Message-Event-MusicOnHoldEvent.md) - * [NewAccountCodeEvent](PAMI-Message-Event-NewAccountCodeEvent.md) - * [NewCalleridEvent](PAMI-Message-Event-NewCalleridEvent.md) - * [NewchannelEvent](PAMI-Message-Event-NewchannelEvent.md) - * [NewextenEvent](PAMI-Message-Event-NewextenEvent.md) - * [NewstateEvent](PAMI-Message-Event-NewstateEvent.md) - * [OriginateResponseEvent](PAMI-Message-Event-OriginateResponseEvent.md) - * [ParkedCallEvent](PAMI-Message-Event-ParkedCallEvent.md) - * [ParkedCallsCompleteEvent](PAMI-Message-Event-ParkedCallsCompleteEvent.md) + * [ListDialPlanEvent](PAMI-Message-Event-ListDialPlanEvent.md) * [PeerEntryEvent](PAMI-Message-Event-PeerEntryEvent.md) + * [ConfbridgeUnmuteEvent](PAMI-Message-Event-ConfbridgeUnmuteEvent.md) + * [QueueCallerJoinEvent](PAMI-Message-Event-QueueCallerJoinEvent.md) + * [JoinEvent](PAMI-Message-Event-JoinEvent.md) + * [StatusEvent](PAMI-Message-Event-StatusEvent.md) * [PeerlistCompleteEvent](PAMI-Message-Event-PeerlistCompleteEvent.md) - * [PeerStatusEvent](PAMI-Message-Event-PeerStatusEvent.md) - * [QueueMemberAddedEvent](PAMI-Message-Event-QueueMemberAddedEvent.md) - * [QueueMemberEvent](PAMI-Message-Event-QueueMemberEvent.md) - * [QueueMemberPausedEvent](PAMI-Message-Event-QueueMemberPausedEvent.md) + * [DongleStatusEvent](PAMI-Message-Event-DongleStatusEvent.md) + * [VgsmSmsRxEvent](PAMI-Message-Event-VgsmSmsRxEvent.md) + * [HoldEvent](PAMI-Message-Event-HoldEvent.md) + * [ParkedCallGiveUpEvent](PAMI-Message-Event-ParkedCallGiveUpEvent.md) + * [ShowDialPlanCompleteEvent](PAMI-Message-Event-ShowDialPlanCompleteEvent.md) + * [RegistrationsCompleteEvent](PAMI-Message-Event-RegistrationsCompleteEvent.md) + * [AgentsEvent](PAMI-Message-Event-AgentsEvent.md) + * [CoreShowChannelEvent](PAMI-Message-Event-CoreShowChannelEvent.md) + * [DNDStateEvent](PAMI-Message-Event-DNDStateEvent.md) + * [RTCPReceiverStatEvent](PAMI-Message-Event-RTCPReceiverStatEvent.md) + * [UnParkedCallEvent](PAMI-Message-Event-UnParkedCallEvent.md) * [QueueMemberRemovedEvent](PAMI-Message-Event-QueueMemberRemovedEvent.md) + * [ParkedCallsCompleteEvent](PAMI-Message-Event-ParkedCallsCompleteEvent.md) + * [VgsmMeStateEvent](PAMI-Message-Event-VgsmMeStateEvent.md) + * [DongleShowDevicesCompleteEvent](PAMI-Message-Event-DongleShowDevicesCompleteEvent.md) + * [OriginateResponseEvent](PAMI-Message-Event-OriginateResponseEvent.md) + * [LinkEvent](PAMI-Message-Event-LinkEvent.md) + * [FullyBootedEvent](PAMI-Message-Event-FullyBootedEvent.md) + * [VoicemailUserEntryCompleteEvent](PAMI-Message-Event-VoicemailUserEntryCompleteEvent.md) * [QueueMemberStatusEvent](PAMI-Message-Event-QueueMemberStatusEvent.md) - * [QueueParamsEvent](PAMI-Message-Event-QueueParamsEvent.md) + * [DTMFEvent](PAMI-Message-Event-DTMFEvent.md) + * [UnlinkEvent](PAMI-Message-Event-UnlinkEvent.md) + * [StatusCompleteEvent](PAMI-Message-Event-StatusCompleteEvent.md) + * [ConfbridgeStartEvent](PAMI-Message-Event-ConfbridgeStartEvent.md) + * [DongleUSSDStatusEvent](PAMI-Message-Event-DongleUSSDStatusEvent.md) + * [CELEvent](PAMI-Message-Event-CELEvent.md) * [QueueStatusCompleteEvent](PAMI-Message-Event-QueueStatusCompleteEvent.md) + * [MasqueradeEvent](PAMI-Message-Event-MasqueradeEvent.md) + * [NewCalleridEvent](PAMI-Message-Event-NewCalleridEvent.md) + * [NewAccountCodeEvent](PAMI-Message-Event-NewAccountCodeEvent.md) + * [HangupEvent](PAMI-Message-Event-HangupEvent.md) + * [DongleNewUSSDBase64Event](PAMI-Message-Event-DongleNewUSSDBase64Event.md) + * [DialBeginEvent](PAMI-Message-Event-DialBeginEvent.md) + * [DTMFBeginEvent](PAMI-Message-Event-DTMFBeginEvent.md) + * [MusicOnHoldStopEvent](PAMI-Message-Event-MusicOnHoldStopEvent.md) + * [PeerStatusEvent](PAMI-Message-Event-PeerStatusEvent.md) + * [BridgeCreateEvent](PAMI-Message-Event-BridgeCreateEvent.md) + * [DTMFEndEvent](PAMI-Message-Event-DTMFEndEvent.md) + * [AsyncAGIEndEvent](PAMI-Message-Event-AsyncAGIEndEvent.md) + * [QueueParamsEvent](PAMI-Message-Event-QueueParamsEvent.md) + * [VgsmNetStateEvent](PAMI-Message-Event-VgsmNetStateEvent.md) + * [AgentsCompleteEvent](PAMI-Message-Event-AgentsCompleteEvent.md) + * [QueueCallerAbandonEvent](PAMI-Message-Event-QueueCallerAbandonEvent.md) + * [AgentloginEvent](PAMI-Message-Event-AgentloginEvent.md) + * [ParkedCallTimeOutEvent](PAMI-Message-Event-ParkedCallTimeOutEvent.md) + * [BridgeEvent](PAMI-Message-Event-BridgeEvent.md) + * [AttendedTransferEvent](PAMI-Message-Event-AttendedTransferEvent.md) + * [RTPReceiverStatEvent](PAMI-Message-Event-RTPReceiverStatEvent.md) + * [ConfbridgeJoinEvent](PAMI-Message-Event-ConfbridgeJoinEvent.md) + * [AGIExecStartEvent](PAMI-Message-Event-AGIExecStartEvent.md) + * [TransferEvent](PAMI-Message-Event-TransferEvent.md) + * [BridgeEnterEvent](PAMI-Message-Event-BridgeEnterEvent.md) * [QueueSummaryCompleteEvent](PAMI-Message-Event-QueueSummaryCompleteEvent.md) + * [DBGetResponseEvent](PAMI-Message-Event-DBGetResponseEvent.md) + * [QueueCallerLeaveEvent](PAMI-Message-Event-QueueCallerLeaveEvent.md) + * [DAHDIShowChannelsEvent](PAMI-Message-Event-DAHDIShowChannelsEvent.md) + * [RTCPReceivedEvent](PAMI-Message-Event-RTCPReceivedEvent.md) + * [MusicOnHoldEvent](PAMI-Message-Event-MusicOnHoldEvent.md) + * [BridgeLeaveEvent](PAMI-Message-Event-BridgeLeaveEvent.md) + * [ConfbridgeTalkingEvent](PAMI-Message-Event-ConfbridgeTalkingEvent.md) + * [QueueMemberEvent](PAMI-Message-Event-QueueMemberEvent.md) * [QueueSummaryEvent](PAMI-Message-Event-QueueSummaryEvent.md) - * [RegistrationsCompleteEvent](PAMI-Message-Event-RegistrationsCompleteEvent.md) + * [BridgeListItemEvent](PAMI-Message-Event-BridgeListItemEvent.md) + * [DongleNewUSSDEvent](PAMI-Message-Event-DongleNewUSSDEvent.md) * [RegistryEvent](PAMI-Message-Event-RegistryEvent.md) - * [RenameEvent](PAMI-Message-Event-RenameEvent.md) - * [RTCPReceivedEvent](PAMI-Message-Event-RTCPReceivedEvent.md) - * [RTCPReceiverStatEvent](PAMI-Message-Event-RTCPReceiverStatEvent.md) * [RTCPSentEvent](PAMI-Message-Event-RTCPSentEvent.md) - * [RTPReceiverStatEvent](PAMI-Message-Event-RTPReceiverStatEvent.md) - * [RTPSenderStatEvent](PAMI-Message-Event-RTPSenderStatEvent.md) - * [ShowDialPlanCompleteEvent](PAMI-Message-Event-ShowDialPlanCompleteEvent.md) - * [StatusCompleteEvent](PAMI-Message-Event-StatusCompleteEvent.md) - * [StatusEvent](PAMI-Message-Event-StatusEvent.md) - * [TransferEvent](PAMI-Message-Event-TransferEvent.md) - * [UnknownEvent](PAMI-Message-Event-UnknownEvent.md) - * [UnlinkEvent](PAMI-Message-Event-UnlinkEvent.md) - * [UnParkedCallEvent](PAMI-Message-Event-UnParkedCallEvent.md) + * [AsyncAGIEvent](PAMI-Message-Event-AsyncAGIEvent.md) + * [ConfbridgeListCompleteEvent](PAMI-Message-Event-ConfbridgeListCompleteEvent.md) + * PAMI\Message\Event\Factory + * PAMI\Message\Event\Factory\Impl + * [EventFactoryImpl](PAMI-Message-Event-Factory-Impl-EventFactoryImpl.md) + * [AgentConnectEvent](PAMI-Message-Event-AgentConnectEvent.md) + * [EventMessage](PAMI-Message-Event-EventMessage.md) + * [NewextenEvent](PAMI-Message-Event-NewextenEvent.md) * [UserEventEvent](PAMI-Message-Event-UserEventEvent.md) - * [VarSetEvent](PAMI-Message-Event-VarSetEvent.md) - * [VgsmMeStateEvent](PAMI-Message-Event-VgsmMeStateEvent.md) - * [VgsmNetStateEvent](PAMI-Message-Event-VgsmNetStateEvent.md) - * [VgsmSmsRxEvent](PAMI-Message-Event-VgsmSmsRxEvent.md) - * [VoicemailUserEntryCompleteEvent](PAMI-Message-Event-VoicemailUserEntryCompleteEvent.md) - * [VoicemailUserEntryEvent](PAMI-Message-Event-VoicemailUserEntryEvent.md) - * [IncomingMessage](PAMI-Message-IncomingMessage.md) * [Message](PAMI-Message-Message.md) - * [OutgoingMessage](PAMI-Message-OutgoingMessage.md) - * PAMI\Message\Response - * [ResponseMessage](PAMI-Message-Response-ResponseMessage.md) + * PAMI\AsyncAgi + * [AsyncClientImpl](PAMI-AsyncAgi-AsyncClientImpl.md) + * PAMI\Exception + * [PAMIException](PAMI-Exception-PAMIException.md) + * PAMI\Client + * PAMI\Client\Impl + * [ClientImpl](PAMI-Client-Impl-ClientImpl.md) + * PAMI\Client\Exception + * [ClientException](PAMI-Client-Exception-ClientException.md) + * [IClient](PAMI-Client-IClient.md) diff --git a/doc/PAMI-Client-Impl-ClientImpl.md b/doc/PAMI-Client-Impl-ClientImpl.md index f629c179a..10a3afc38 100644 --- a/doc/PAMI-Client-Impl-ClientImpl.md +++ b/doc/PAMI-Client-Impl-ClientImpl.md @@ -19,7 +19,7 @@ Properties ### $logger - private \PAMI\Client\Impl\Logger $logger + private \Psr\Log\LoggerInterface $logger PSR-3 logger. @@ -181,6 +181,17 @@ corresponding ActionId. +* Visibility: **private** + + +### $eventMask + + private string $eventMask + +Event mask to apply on login action. + + + * Visibility: **private** diff --git a/doc/PAMI-Message-Action-BlindTransferAction.md b/doc/PAMI-Message-Action-BlindTransferAction.md new file mode 100644 index 000000000..a7d4d5d92 --- /dev/null +++ b/doc/PAMI-Message-Action-BlindTransferAction.md @@ -0,0 +1,310 @@ +PAMI\Message\Action\BlindTransferAction +=============== + +BlindTransfer action message. + +PHP Version 5 + + +* Class name: BlindTransferAction +* Namespace: PAMI\Message\Action +* Parent class: [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $lines + + protected array $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> + + + +### __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> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-BridgeListAction.md b/doc/PAMI-Message-Action-BridgeListAction.md new file mode 100644 index 000000000..00cbbded7 --- /dev/null +++ b/doc/PAMI-Message-Action-BridgeListAction.md @@ -0,0 +1,311 @@ +PAMI\Message\Action\BridgeListAction +=============== + +BridgeList action message. + +Get a list of bridges in the system. +Returns a list of bridges, optionally filtering on a bridge type. + + +* Class name: BridgeListAction +* Namespace: PAMI\Message\Action +* Parent class: [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $lines + + protected array $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> + + + +### __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> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-ChallengeAction.md b/doc/PAMI-Message-Action-ChallengeAction.md new file mode 100644 index 000000000..9759d10ce --- /dev/null +++ b/doc/PAMI-Message-Action-ChallengeAction.md @@ -0,0 +1,310 @@ +PAMI\Message\Action\ChallengeAction +=============== + +Challenge action message. + +PHP Version 5 + + +* Class name: ChallengeAction +* Namespace: PAMI\Message\Action +* Parent class: [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $lines + + protected array $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> + + + +### __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> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-DAHDITransferAction.md b/doc/PAMI-Message-Action-DAHDITransferAction.md new file mode 100644 index 000000000..4ed4c9afe --- /dev/null +++ b/doc/PAMI-Message-Action-DAHDITransferAction.md @@ -0,0 +1,310 @@ +PAMI\Message\Action\DAHDITransferAction +=============== + +DAHDITransfer action message. + +PHP Version 5 + + +* Class name: DAHDITransferAction +* Namespace: PAMI\Message\Action +* Parent class: [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $lines + + protected array $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> + + + +### __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> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-MixMonitorMuteAction.md b/doc/PAMI-Message-Action-MixMonitorMuteAction.md new file mode 100644 index 000000000..638567cb0 --- /dev/null +++ b/doc/PAMI-Message-Action-MixMonitorMuteAction.md @@ -0,0 +1,367 @@ +PAMI\Message\Action\MixMonitorMuteAction +=============== + +MixMonitorMute action message. + +PHP Version 5 + + +* Class name: MixMonitorMuteAction +* Namespace: PAMI\Message\Action +* Parent class: [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) + + + +Constants +---------- + + +### DIRECTION_READ + + const DIRECTION_READ = 'read' + + + + + +### DIRECTION_WRITE + + const DIRECTION_WRITE = 'write' + + + + + +### DIRECTION_BOTH + + const DIRECTION_BOTH = 'both' + + + + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $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 +------- + + +### setState + + void PAMI\Message\Action\MixMonitorMuteAction::setState(boolean $state) + +Sets state key. + + + +* Visibility: **public** + + +#### Arguments +* $state **boolean** - <p>Mute state</p> + + + +### setDirection + + void PAMI\Message\Action\MixMonitorMuteAction::setDirection(string $direction) + +Sets state key. + + + +* Visibility: **public** + + +#### Arguments +* $direction **string** - <p>Which part of the recording to mute: +read, write or both (from channel, to channel or both channels).</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setActionID + + void PAMI\Message\Action\ActionMessage::setActionID($actionID) + +Sets Action ID. + +The ActionID can be at most 69 characters long, according to +[Asterisk Issue 14847](https://issues.asterisk.org/jira/browse/14847). + +Therefore we'll throw an exception when the ActionID is too long. + +* Visibility: **public** +* This method is defined by [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) + + +#### Arguments +* $actionID **mixed** - <p>The Action ID to have this action known by</p> + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-OriginateAction.md b/doc/PAMI-Message-Action-OriginateAction.md index 0e3c3d3f3..23241d1fb 100644 --- a/doc/PAMI-Message-Action-OriginateAction.md +++ b/doc/PAMI-Message-Action-OriginateAction.md @@ -199,7 +199,7 @@ Sets CallerID key. ### setAccount - void PAMI\Message\Action\OriginateAction::setAccount($account) + void PAMI\Message\Action\OriginateAction::setAccount(string $account) Sets Account key. @@ -209,7 +209,7 @@ Sets Account key. #### Arguments -* $account **mixed** +* $account **string** - <p>Account code.</p> diff --git a/doc/PAMI-Message-Action-UserEventAction.md b/doc/PAMI-Message-Action-UserEventAction.md new file mode 100644 index 000000000..151423979 --- /dev/null +++ b/doc/PAMI-Message-Action-UserEventAction.md @@ -0,0 +1,310 @@ +PAMI\Message\Action\UserEventAction +=============== + +UserEvent action message. + +PHP Version 5 + + +* Class name: UserEventAction +* Namespace: PAMI\Message\Action +* Parent class: [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $lines + + protected array $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> + + + +### __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> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-VGSMSMSTxAction.md b/doc/PAMI-Message-Action-VGSMSMSTxAction.md index 6cf332c44..901d997ba 100644 --- a/doc/PAMI-Message-Action-VGSMSMSTxAction.md +++ b/doc/PAMI-Message-Action-VGSMSMSTxAction.md @@ -235,7 +235,7 @@ setConcatRefId and setConcatSeqNum ### setAccount - void PAMI\Message\Action\VGSMSMSTxAction::setAccount($account) + void PAMI\Message\Action\VGSMSMSTxAction::setAccount(string $account) Sets Account key. @@ -245,7 +245,7 @@ Sets Account key. #### Arguments -* $account **mixed** +* $account **string** - <p>Account code.</p> diff --git a/doc/PAMI-Message-Action-WaitEventAction.md b/doc/PAMI-Message-Action-WaitEventAction.md new file mode 100644 index 000000000..8c11acb6a --- /dev/null +++ b/doc/PAMI-Message-Action-WaitEventAction.md @@ -0,0 +1,310 @@ +PAMI\Message\Action\WaitEventAction +=============== + +WaitEvent action message. + +PHP Version 5 + + +* Class name: WaitEventAction +* Namespace: PAMI\Message\Action +* Parent class: [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $lines + + protected array $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> + + + +### __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> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-AGIExecEndEvent.md b/doc/PAMI-Message-Event-AGIExecEndEvent.md new file mode 100644 index 000000000..889ed0477 --- /dev/null +++ b/doc/PAMI-Message-Event-AGIExecEndEvent.md @@ -0,0 +1,610 @@ +PAMI\Message\Event\AGIExecEndEvent +=============== + +Event triggered when a received AGI command completes processing. + +PHP Version 5 + + +* Class name: AGIExecEndEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\AGIExecEndEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\AGIExecEndEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\AGIExecEndEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\AGIExecEndEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\AGIExecEndEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\AGIExecEndEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\AGIExecEndEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\AGIExecEndEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\AGIExecEndEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\AGIExecEndEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\AGIExecEndEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\AGIExecEndEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\AGIExecEndEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getCommand + + string PAMI\Message\Event\AGIExecEndEvent::getCommand() + +Returns key: 'Command'. + + + +* Visibility: **public** + + + + +### getCommandId + + string PAMI\Message\Event\AGIExecEndEvent::getCommandId() + +Returns key: 'CommandId'. + + + +* Visibility: **public** + + + + +### getResultCode + + string PAMI\Message\Event\AGIExecEndEvent::getResultCode() + +Returns key: 'ResultCode'. + + + +* Visibility: **public** + + + + +### getResult + + string PAMI\Message\Event\AGIExecEndEvent::getResult() + +Returns key: 'Result'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-AGIExecStartEvent.md b/doc/PAMI-Message-Event-AGIExecStartEvent.md new file mode 100644 index 000000000..864d419a2 --- /dev/null +++ b/doc/PAMI-Message-Event-AGIExecStartEvent.md @@ -0,0 +1,584 @@ +PAMI\Message\Event\AGIExecStartEvent +=============== + +Event triggered when a received AGI command starts processing. + +PHP Version 5 + + +* Class name: AGIExecStartEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\AGIExecStartEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\AGIExecStartEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\AGIExecStartEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\AGIExecStartEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\AGIExecStartEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\AGIExecStartEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\AGIExecStartEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\AGIExecStartEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\AGIExecStartEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\AGIExecStartEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\AGIExecStartEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\AGIExecStartEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\AGIExecStartEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getCommand + + string PAMI\Message\Event\AGIExecStartEvent::getCommand() + +Returns key: 'Command'. + + + +* Visibility: **public** + + + + +### getCommandId + + string PAMI\Message\Event\AGIExecStartEvent::getCommandId() + +Returns key: 'CommandId'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-AsyncAGIEndEvent.md b/doc/PAMI-Message-Event-AsyncAGIEndEvent.md new file mode 100644 index 000000000..ad23ce78f --- /dev/null +++ b/doc/PAMI-Message-Event-AsyncAGIEndEvent.md @@ -0,0 +1,558 @@ +PAMI\Message\Event\AsyncAGIEndEvent +=============== + +Event triggered when a channel stops AsyncAGI command processing. + +PHP Version 5 + + +* Class name: AsyncAGIEndEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\AsyncAGIEndEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\AsyncAGIEndEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\AsyncAGIEndEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\AsyncAGIEndEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\AsyncAGIEndEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\AsyncAGIEndEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\AsyncAGIEndEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\AsyncAGIEndEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\AsyncAGIEndEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\AsyncAGIEndEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\AsyncAGIEndEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\AsyncAGIEndEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\AsyncAGIEndEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-AsyncAGIExecEvent.md b/doc/PAMI-Message-Event-AsyncAGIExecEvent.md new file mode 100644 index 000000000..d8fc4a647 --- /dev/null +++ b/doc/PAMI-Message-Event-AsyncAGIExecEvent.md @@ -0,0 +1,584 @@ +PAMI\Message\Event\AsyncAGIExecEvent +=============== + +Event triggered when AsyncAGI completes an AGI command. + +PHP Version 5 + + +* Class name: AsyncAGIExecEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\AsyncAGIExecEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\AsyncAGIExecEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\AsyncAGIExecEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\AsyncAGIExecEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\AsyncAGIExecEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\AsyncAGIExecEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\AsyncAGIExecEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\AsyncAGIExecEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\AsyncAGIExecEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\AsyncAGIExecEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\AsyncAGIExecEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\AsyncAGIExecEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\AsyncAGIExecEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getCommandID + + string PAMI\Message\Event\AsyncAGIExecEvent::getCommandID() + +Returns key: 'CommandID'. + + + +* Visibility: **public** + + + + +### getResult + + string PAMI\Message\Event\AsyncAGIExecEvent::getResult() + +Returns key: 'Result'. + + + +* Visibility: **public** + + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-AsyncAGIStartEvent.md b/doc/PAMI-Message-Event-AsyncAGIStartEvent.md new file mode 100644 index 000000000..611c47e78 --- /dev/null +++ b/doc/PAMI-Message-Event-AsyncAGIStartEvent.md @@ -0,0 +1,571 @@ +PAMI\Message\Event\AsyncAGIStartEvent +=============== + +Event triggered when a channel starts AsyncAGI command processing. + +PHP Version 5 + + +* Class name: AsyncAGIStartEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\AsyncAGIStartEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\AsyncAGIStartEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\AsyncAGIStartEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\AsyncAGIStartEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\AsyncAGIStartEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\AsyncAGIStartEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\AsyncAGIStartEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\AsyncAGIStartEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\AsyncAGIStartEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\AsyncAGIStartEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\AsyncAGIStartEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\AsyncAGIStartEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\AsyncAGIStartEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getEnv + + string PAMI\Message\Event\AsyncAGIStartEvent::getEnv() + +Returns key: 'Env'. + + + +* Visibility: **public** + + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-AttendedTransferEvent.md b/doc/PAMI-Message-Event-AttendedTransferEvent.md new file mode 100644 index 000000000..07354a39e --- /dev/null +++ b/doc/PAMI-Message-Event-AttendedTransferEvent.md @@ -0,0 +1,1453 @@ +PAMI\Message\Event\AttendedTransferEvent +=============== + +Event triggered when an attended transfer is complete. + +PHP Version 5 + + +* Class name: AttendedTransferEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### RESULT_FAIL + + const RESULT_FAIL = 'Fail' + + + + + +### RESULT_INVALID + + const RESULT_INVALID = 'Invalid' + + + + + +### RESULT_NOT_PERMITTED + + const RESULT_NOT_PERMITTED = 'Not Permitted' + + + + + +### RESULT_SUCCESS + + const RESULT_SUCCESS = 'Success' + + + + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getResult + + string PAMI\Message\Event\AttendedTransferEvent::getResult() + +Returns key: 'Result'. + +Result - Indicates if the transfer was successful or if it failed. + +- Fail - An internal error occurred. +- Invalid - Invalid configuration for transfer (e.g. Not bridged) +- Not Permitted - Bridge does not permit transfers +- Success - Transfer completed successfully + +* Visibility: **public** + + + + +### getOrigTransfererChannel + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererChannel() + +Returns key: 'OrigTransfererChannel'. + + + +* Visibility: **public** + + + + +### getOrigTransfererChannelState + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererChannelState() + +Returns key: 'OrigTransfererChannelState'. + + + +* Visibility: **public** + + + + +### getOrigTransfererChannelStateDesc + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererChannelStateDesc() + +Returns key: 'OrigTransfererChannelStateDesc'. + +Down +Rsrvd +OffHook +Dialing +Ring +Ringing +Up +Busy +Dialing Offhook +Pre-ring +Unknown + +* Visibility: **public** + + + + +### getOrigTransfererCallerIDNum + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererCallerIDNum() + +Returns key: 'OrigTransfererCallerIDNum'. + + + +* Visibility: **public** + + + + +### getOrigTransfererCallerIDName + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererCallerIDName() + +Returns key: 'OrigTransfererCallerIDName'. + + + +* Visibility: **public** + + + + +### getOrigTransfererConnectedLineNum + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererConnectedLineNum() + +Returns key: 'OrigTransfererConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getOrigTransfererConnectedLineName + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererConnectedLineName() + +Returns key: 'OrigTransfererConnectedLineName'. + + + +* Visibility: **public** + + + + +### getOrigTransfererAccountCode + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererAccountCode() + +Returns key: 'OrigTransfererAccountCode'. + + + +* Visibility: **public** + + + + +### getOrigTransfererContext + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererContext() + +Returns key: 'OrigTransfererContext'. + + + +* Visibility: **public** + + + + +### getOrigTransfererExten + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererExten() + +Returns key: 'OrigTransfererExten'. + + + +* Visibility: **public** + + + + +### getOrigTransfererPriority + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererPriority() + +Returns key: 'OrigTransfererPriority'. + + + +* Visibility: **public** + + + + +### getOrigTransfererUniqueid + + string PAMI\Message\Event\AttendedTransferEvent::getOrigTransfererUniqueid() + +Returns key: 'OrigTransfererUniqueid'. + + + +* Visibility: **public** + + + + +### getOrigBridgeUniqueid + + string PAMI\Message\Event\AttendedTransferEvent::getOrigBridgeUniqueid() + +Returns key: 'OrigBridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getOrigBridgeType + + string PAMI\Message\Event\AttendedTransferEvent::getOrigBridgeType() + +Returns key: 'OrigBridgeType'. + + + +* Visibility: **public** + + + + +### getOrigBridgeTechnology + + string PAMI\Message\Event\AttendedTransferEvent::getOrigBridgeTechnology() + +Returns key: 'OrigBridgeTechnology'. + + + +* Visibility: **public** + + + + +### getOrigBridgeCreator + + string PAMI\Message\Event\AttendedTransferEvent::getOrigBridgeCreator() + +Returns key: 'OrigBridgeCreator'. + + + +* Visibility: **public** + + + + +### getOrigBridgeName + + string PAMI\Message\Event\AttendedTransferEvent::getOrigBridgeName() + +Returns key: 'OrigBridgeName'. + + + +* Visibility: **public** + + + + +### getOrigBridgeNumChannels + + string PAMI\Message\Event\AttendedTransferEvent::getOrigBridgeNumChannels() + +Returns key: 'OrigBridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getSecondTransfererChannel + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererChannel() + +Returns key: 'SecondTransfererChannel'. + + + +* Visibility: **public** + + + + +### getSecondTransfererChannelState + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererChannelState() + +Returns key: 'SecondTransfererChannelState'. + + + +* Visibility: **public** + + + + +### getSecondTransfererChannelStateDesc + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererChannelStateDesc() + +Returns key: 'SecondTransfererChannelStateDesc'. + +Down +Rsrvd +OffHook +Dialing +Ring +Ringing +Up +Busy +Dialing Offhook +Pre-ring +Unknown + +* Visibility: **public** + + + + +### getSecondTransfererCallerIDNum + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererCallerIDNum() + +Returns key: 'SecondTransfererCallerIDNum'. + + + +* Visibility: **public** + + + + +### getSecondTransfererCallerIDName + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererCallerIDName() + +Returns key: 'SecondTransfererCallerIDName'. + + + +* Visibility: **public** + + + + +### getSecondTransfererConnectedLineNum + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererConnectedLineNum() + +Returns key: 'SecondTransfererConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getSecondTransfererConnectedLineName + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererConnectedLineName() + +Returns key: 'SecondTransfererConnectedLineName'. + + + +* Visibility: **public** + + + + +### getSecondTransfererAccountCode + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererAccountCode() + +Returns key: 'SecondTransfererAccountCode'. + + + +* Visibility: **public** + + + + +### getSecondTransfererContext + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererContext() + +Returns key: 'SecondTransfererContext'. + + + +* Visibility: **public** + + + + +### getSecondTransfererExten + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererExten() + +Returns key: 'SecondTransfererExten'. + + + +* Visibility: **public** + + + + +### getSecondTransfererPriority + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererPriority() + +Returns key: 'SecondTransfererPriority'. + + + +* Visibility: **public** + + + + +### getSecondTransfererUniqueid + + string PAMI\Message\Event\AttendedTransferEvent::getSecondTransfererUniqueid() + +Returns key: 'SecondTransfererUniqueid'. + + + +* Visibility: **public** + + + + +### getSecondBridgeUniqueid + + string PAMI\Message\Event\AttendedTransferEvent::getSecondBridgeUniqueid() + +Returns key: 'SecondBridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getSecondBridgeType + + string PAMI\Message\Event\AttendedTransferEvent::getSecondBridgeType() + +Returns key: 'SecondBridgeType'. + + + +* Visibility: **public** + + + + +### getSecondBridgeTechnology + + string PAMI\Message\Event\AttendedTransferEvent::getSecondBridgeTechnology() + +Returns key: 'SecondBridgeTechnology'. + + + +* Visibility: **public** + + + + +### getSecondBridgeCreator + + string PAMI\Message\Event\AttendedTransferEvent::getSecondBridgeCreator() + +Returns key: 'SecondBridgeCreator'. + + + +* Visibility: **public** + + + + +### getSecondBridgeName + + string PAMI\Message\Event\AttendedTransferEvent::getSecondBridgeName() + +Returns key: 'SecondBridgeName'. + + + +* Visibility: **public** + + + + +### getSecondBridgeNumChannels + + string PAMI\Message\Event\AttendedTransferEvent::getSecondBridgeNumChannels() + +Returns key: 'SecondBridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getDestType + + string PAMI\Message\Event\AttendedTransferEvent::getDestType() + +Returns key: 'DestType'. + +DestType - Indicates the method by which the attended transfer completed. + +Bridge - The transfer was accomplished by merging two bridges into one. +App - The transfer was accomplished by having a channel or bridge run a dialplan application. +Link - The transfer was accomplished by linking two bridges together using a local channel pair. +Threeway - The transfer was accomplished by placing all parties into a threeway call. +Fail - The transfer failed. + +* Visibility: **public** + + + + +### getDestBridgeUniqueid + + string PAMI\Message\Event\AttendedTransferEvent::getDestBridgeUniqueid() + +Returns key: 'DestBridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getDestApp + + string PAMI\Message\Event\AttendedTransferEvent::getDestApp() + +Returns key: 'DestApp'. + + + +* Visibility: **public** + + + + +### getLocalOneChannel + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneChannel() + +Returns key: 'LocalOneChannel'. + + + +* Visibility: **public** + + + + +### getLocalOneChannelState + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneChannelState() + +Returns key: 'LocalOneChannelState'. + + + +* Visibility: **public** + + + + +### getLocalOneChannelStateDesc + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneChannelStateDesc() + +Returns key: 'LocalOneChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getLocalOneCallerIDNum + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneCallerIDNum() + +Returns key: 'LocalOneCallerIDNum'. + + + +* Visibility: **public** + + + + +### getLocalOneCallerIDName + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneCallerIDName() + +Returns key: 'LocalOneCallerIDName'. + + + +* Visibility: **public** + + + + +### getLocalOneConnectedLineNum + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneConnectedLineNum() + +Returns key: 'LocalOneConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getLocalOneConnectedLineName + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneConnectedLineName() + +Returns key: 'LocalOneConnectedLineName'. + + + +* Visibility: **public** + + + + +### getLocalOneAccountCode + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneAccountCode() + +Returns key: 'LocalOneAccountCode'. + + + +* Visibility: **public** + + + + +### getLocalOneContext + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneContext() + +Returns key: 'LocalOneContext'. + + + +* Visibility: **public** + + + + +### getLocalOneExten + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneExten() + +Returns key: 'LocalOneExten'. + + + +* Visibility: **public** + + + + +### getLocalOnePriority + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOnePriority() + +Returns key: 'LocalOnePriority'. + + + +* Visibility: **public** + + + + +### getLocalOneUniqueid + + string PAMI\Message\Event\AttendedTransferEvent::getLocalOneUniqueid() + +Returns key: 'LocalOneUniqueid'. + + + +* Visibility: **public** + + + + +### getLocalTwoChannel + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoChannel() + +Returns key: 'LocalTwoChannel'. + + + +* Visibility: **public** + + + + +### getLocalTwoChannelState + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoChannelState() + +Returns key: 'LocalTwoChannelState'. + + + +* Visibility: **public** + + + + +### getLocalTwoChannelStateDesc + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoChannelStateDesc() + +Returns key: 'LocalTwoChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getLocalTwoCallerIDNum + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoCallerIDNum() + +Returns key: 'LocalTwoCallerIDNum'. + + + +* Visibility: **public** + + + + +### getLocalTwoCallerIDName + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoCallerIDName() + +Returns key: 'LocalTwoCallerIDName'. + + + +* Visibility: **public** + + + + +### getLocalTwoConnectedLineNum + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoConnectedLineNum() + +Returns key: 'LocalTwoConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getLocalTwoConnectedLineName + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoConnectedLineName() + +Returns key: 'LocalTwoConnectedLineName'. + + + +* Visibility: **public** + + + + +### getLocalTwoAccountCode + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoAccountCode() + +Returns key: 'LocalTwoAccountCode'. + + + +* Visibility: **public** + + + + +### getLocalTwoContext + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoContext() + +Returns key: 'LocalTwoContext'. + + + +* Visibility: **public** + + + + +### getLocalTwoExten + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoExten() + +Returns key: 'LocalTwoExten'. + + + +* Visibility: **public** + + + + +### getLocalTwoPriority + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoPriority() + +Returns key: 'LocalTwoPriority'. + + + +* Visibility: **public** + + + + +### getLocalTwoUniqueid + + string PAMI\Message\Event\AttendedTransferEvent::getLocalTwoUniqueid() + +Returns key: 'LocalTwoUniqueid'. + + + +* Visibility: **public** + + + + +### getDestTransfererChannel + + string PAMI\Message\Event\AttendedTransferEvent::getDestTransfererChannel() + +Returns key: 'DestTransfererChannel'. + + + +* Visibility: **public** + + + + +### getTransfereeChannel + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeChannel() + +Returns key: 'TransfereeChannel'. + + + +* Visibility: **public** + + + + +### getTransfereeChannelState + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeChannelState() + +Returns key: 'TransfereeChannelState'. + + + +* Visibility: **public** + + + + +### getTransfereeChannelStateDesc + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeChannelStateDesc() + +Returns key: 'TransfereeChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getTransfereeCallerIDNum + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeCallerIDNum() + +Returns key: 'TransfereeCallerIDNum'. + + + +* Visibility: **public** + + + + +### getTransfereeCallerIDName + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeCallerIDName() + +Returns key: 'TransfereeCallerIDName'. + + + +* Visibility: **public** + + + + +### getTransfereeConnectedLineNum + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeConnectedLineNum() + +Returns key: 'TransfereeConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getTransfereeConnectedLineName + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeConnectedLineName() + +Returns key: 'TransfereeConnectedLineName'. + + + +* Visibility: **public** + + + + +### getTransfereeAccountCode + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeAccountCode() + +Returns key: 'TransfereeAccountCode'. + + + +* Visibility: **public** + + + + +### getTransfereeContext + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeContext() + +Returns key: 'TransfereeContext'. + + + +* Visibility: **public** + + + + +### getTransfereeExten + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeExten() + +Returns key: 'TransfereeExten'. + + + +* Visibility: **public** + + + + +### getTransfereePriority + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereePriority() + +Returns key: 'TransfereePriority'. + + + +* Visibility: **public** + + + + +### getTransfereeUniqueid + + string PAMI\Message\Event\AttendedTransferEvent::getTransfereeUniqueid() + +Returns key: 'TransfereeUniqueid'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-BlindTransferEvent.md b/doc/PAMI-Message-Event-BlindTransferEvent.md new file mode 100644 index 000000000..27ebf70b7 --- /dev/null +++ b/doc/PAMI-Message-Event-BlindTransferEvent.md @@ -0,0 +1,918 @@ +PAMI\Message\Event\BlindTransferEvent +=============== + +Event triggered when a blind transfer is complete. + +PHP Version 5 + + +* Class name: BlindTransferEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### RESULT_FAIL + + const RESULT_FAIL = 'Fail' + + + + + +### RESULT_INVALID + + const RESULT_INVALID = 'Invalid' + + + + + +### RESULT_NOT_PERMITTED + + const RESULT_NOT_PERMITTED = 'Not Permitted' + + + + + +### RESULT_SUCCESS + + const RESULT_SUCCESS = 'Success' + + + + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\BlindTransferEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getResult + + string PAMI\Message\Event\BlindTransferEvent::getResult() + +Returns key: 'Result'. + +Result - Indicates if the transfer was successful or if it failed. + +- Fail - An internal error occurred. +- Invalid - Invalid configuration for transfer (e.g. Not bridged) +- Not Permitted - Bridge does not permit transfers +- Success - Transfer completed successfully + +* Visibility: **public** + + + + +### getTransfererChannel + + string PAMI\Message\Event\BlindTransferEvent::getTransfererChannel() + +Returns key: 'TransfererChannel'. + + + +* Visibility: **public** + + + + +### getTransfererChannelState + + string PAMI\Message\Event\BlindTransferEvent::getTransfererChannelState() + +Returns key: 'TransfererChannelState'. + +TransfererChannelState - A numeric code for the channel's current state, related to TransfererChannelStateDesc + +* Visibility: **public** + + + + +### getTransfererChannelStateDesc + + string PAMI\Message\Event\BlindTransferEvent::getTransfererChannelStateDesc() + +Returns key: 'TransfererChannelStateDesc'. + +Down +Rsrvd +OffHook +Dialing +Ring +Ringing +Up +Busy +Dialing Offhook +Pre-ring +Unknown + +* Visibility: **public** + + + + +### getTransfererCallerIDNum + + string PAMI\Message\Event\BlindTransferEvent::getTransfererCallerIDNum() + +Returns key: 'TransfererCallerIDNum'. + + + +* Visibility: **public** + + + + +### getTransfererCallerIDName + + string PAMI\Message\Event\BlindTransferEvent::getTransfererCallerIDName() + +Returns key: 'TransfererCallerIDName'. + + + +* Visibility: **public** + + + + +### getTransfererConnectedLineNum + + string PAMI\Message\Event\BlindTransferEvent::getTransfererConnectedLineNum() + +Returns key: 'TransfererConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getTransfererConnectedLineName + + string PAMI\Message\Event\BlindTransferEvent::getTransfererConnectedLineName() + +Returns key: 'TransfererConnectedLineName'. + + + +* Visibility: **public** + + + + +### getTransfererAccountCode + + string PAMI\Message\Event\BlindTransferEvent::getTransfererAccountCode() + +Returns key: 'TransfererAccountCode'. + + + +* Visibility: **public** + + + + +### getTransfererContext + + string PAMI\Message\Event\BlindTransferEvent::getTransfererContext() + +Returns key: 'TransfererContext'. + + + +* Visibility: **public** + + + + +### getTransfererExten + + string PAMI\Message\Event\BlindTransferEvent::getTransfererExten() + +Returns key: 'TransfererExten'. + + + +* Visibility: **public** + + + + +### getTransfererPriority + + string PAMI\Message\Event\BlindTransferEvent::getTransfererPriority() + +Returns key: 'TransfererPriority'. + + + +* Visibility: **public** + + + + +### getTransfererUniqueid + + string PAMI\Message\Event\BlindTransferEvent::getTransfererUniqueid() + +Returns key: 'TransfererUniqueid'. + + + +* Visibility: **public** + + + + +### getTransfereeChannel + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeChannel() + +Returns key: 'TransfereeChannel'. + + + +* Visibility: **public** + + + + +### getTransfereeChannelState + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeChannelState() + +Returns key: 'TransfereeChannelState'. + +TransfereeChannelState - A numeric code for the channel's current state, related to TransfereeChannelStateDesc + +* Visibility: **public** + + + + +### getTransfereeChannelStateDesc + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeChannelStateDesc() + +Returns key: 'TransfereeChannelStateDesc'. + +Down +Rsrvd +OffHook +Dialing +Ring +Ringing +Up +Busy +Dialing Offhook +Pre-ring +Unknown + +* Visibility: **public** + + + + +### getTransfereeCallerIDNum + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeCallerIDNum() + +Returns key: 'TransfereeCallerIDNum'. + + + +* Visibility: **public** + + + + +### getTransfereeCallerIDName + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeCallerIDName() + +Returns key: 'TransfereeCallerIDName'. + + + +* Visibility: **public** + + + + +### getTransfereeConnectedLineNum + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeConnectedLineNum() + +Returns key: 'TransfereeConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getTransfereeConnectedLineName + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeConnectedLineName() + +Returns key: 'TransfereeConnectedLineName'. + + + +* Visibility: **public** + + + + +### getTransfereeAccountCode + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeAccountCode() + +Returns key: 'TransfereeAccountCode'. + + + +* Visibility: **public** + + + + +### getTransfereeContext + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeContext() + +Returns key: 'TransfereeContext'. + + + +* Visibility: **public** + + + + +### getTransfereeExten + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeExten() + +Returns key: 'TransfereeExten'. + + + +* Visibility: **public** + + + + +### getTransfereePriority + + string PAMI\Message\Event\BlindTransferEvent::getTransfereePriority() + +Returns key: 'TransfereePriority'. + + + +* Visibility: **public** + + + + +### getTransfereeUniqueid + + string PAMI\Message\Event\BlindTransferEvent::getTransfereeUniqueid() + +Returns key: 'TransfereeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\BlindTransferEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\BlindTransferEvent::getBridgeType() + +Returns key: 'BridgeType'. + +BridgeType - The type of bridge + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\BlindTransferEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + +BridgeTechnology - Technology in use by the bridge + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\BlindTransferEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + +BridgeCreator - Entity that created the bridge if applicable + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\BlindTransferEvent::getBridgeName() + +Returns key: 'BridgeName'. + +BridgeName - Name used to refer to the bridge by its BridgeCreator if applicable + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\BlindTransferEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + +BridgeNumChannels - Number of channels in the bridge + +* Visibility: **public** + + + + +### getIsExternal + + string PAMI\Message\Event\BlindTransferEvent::getIsExternal() + +Returns key: 'IsExternal'. + +IsExternal - Indicates if the transfer was performed outside of Asterisk. +For instance, a channel protocol native transfer is external. A DTMF transfer is internal. + +Yes +No + +* Visibility: **public** + + + + +### isExternal + + boolean PAMI\Message\Event\BlindTransferEvent::isExternal() + +Indicates if the transfer was performed outside of Asterisk. + +For instance, a channel protocol native transfer is external. A DTMF transfer is internal. + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\BlindTransferEvent::getContext() + +Returns key: 'Context'. + +Context - Destination context for the blind transfer. + +* Visibility: **public** + + + + +### getExtension + + string PAMI\Message\Event\BlindTransferEvent::getExtension() + +Returns key: 'Extension'. + +Extension - Destination extension for the blind transfer. + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-BridgeCreateEvent.md b/doc/PAMI-Message-Event-BridgeCreateEvent.md new file mode 100644 index 000000000..919ae0994 --- /dev/null +++ b/doc/PAMI-Message-Event-BridgeCreateEvent.md @@ -0,0 +1,480 @@ +PAMI\Message\Event\BridgeCreateEvent +=============== + +Event triggered when a bridge is created. + +PHP Version 5 + + +* Class name: BridgeCreateEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\BridgeCreateEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\BridgeCreateEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\BridgeCreateEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\BridgeCreateEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\BridgeCreateEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\BridgeCreateEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\BridgeCreateEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-BridgeDestroyEvent.md b/doc/PAMI-Message-Event-BridgeDestroyEvent.md new file mode 100644 index 000000000..1292c3cac --- /dev/null +++ b/doc/PAMI-Message-Event-BridgeDestroyEvent.md @@ -0,0 +1,480 @@ +PAMI\Message\Event\BridgeDestroyEvent +=============== + +Event triggered when a bridge is destroyed. + +PHP Version 5 + + +* Class name: BridgeDestroyEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\BridgeDestroyEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\BridgeDestroyEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\BridgeDestroyEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\BridgeDestroyEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\BridgeDestroyEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\BridgeDestroyEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\BridgeDestroyEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-BridgeEnterEvent.md b/doc/PAMI-Message-Event-BridgeEnterEvent.md new file mode 100644 index 000000000..0b6ae0f49 --- /dev/null +++ b/doc/PAMI-Message-Event-BridgeEnterEvent.md @@ -0,0 +1,649 @@ +PAMI\Message\Event\BridgeEnterEvent +=============== + +Event triggered when a channel enters a bridge. + +PHP Version 5 + + +* Class name: BridgeEnterEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\BridgeEnterEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\BridgeEnterEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\BridgeEnterEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\BridgeEnterEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\BridgeEnterEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\BridgeEnterEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\BridgeEnterEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\BridgeEnterEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\BridgeEnterEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\BridgeEnterEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\BridgeEnterEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\BridgeEnterEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\BridgeEnterEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\BridgeEnterEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\BridgeEnterEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\BridgeEnterEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\BridgeEnterEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\BridgeEnterEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\BridgeEnterEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getSwapUniqueid + + string PAMI\Message\Event\BridgeEnterEvent::getSwapUniqueid() + +Returns key: 'SwapUniqueid'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-BridgeLeaveEvent.md b/doc/PAMI-Message-Event-BridgeLeaveEvent.md new file mode 100644 index 000000000..e50fe883e --- /dev/null +++ b/doc/PAMI-Message-Event-BridgeLeaveEvent.md @@ -0,0 +1,636 @@ +PAMI\Message\Event\BridgeLeaveEvent +=============== + +Event triggered when a channel leaves a bridge. + +PHP Version 5 + + +* Class name: BridgeLeaveEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\BridgeLeaveEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\BridgeLeaveEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\BridgeLeaveEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\BridgeLeaveEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\BridgeLeaveEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\BridgeLeaveEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\BridgeLeaveEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\BridgeLeaveEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\BridgeLeaveEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\BridgeLeaveEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\BridgeLeaveEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\BridgeLeaveEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\BridgeLeaveEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\BridgeLeaveEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\BridgeLeaveEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\BridgeLeaveEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\BridgeLeaveEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\BridgeLeaveEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\BridgeLeaveEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-BridgeListItemEvent.md b/doc/PAMI-Message-Event-BridgeListItemEvent.md new file mode 100644 index 000000000..e16bd0b20 --- /dev/null +++ b/doc/PAMI-Message-Event-BridgeListItemEvent.md @@ -0,0 +1,480 @@ +PAMI\Message\Event\BridgeListItemEvent +=============== + +Event triggered when an action BridgeList was issued. + +PHP Version 5 + + +* Class name: BridgeListItemEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getBridgeUniqueid + + string PAMI\Message\Event\BridgeListItemEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\BridgeListItemEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\BridgeListItemEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\BridgeListItemEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\BridgeListItemEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\BridgeListItemEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getBridgeVideoSourceMode + + string PAMI\Message\Event\BridgeListItemEvent::getBridgeVideoSourceMode() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-ConfbridgeEndEvent.md b/doc/PAMI-Message-Event-ConfbridgeEndEvent.md new file mode 100644 index 000000000..5ed430808 --- /dev/null +++ b/doc/PAMI-Message-Event-ConfbridgeEndEvent.md @@ -0,0 +1,493 @@ +PAMI\Message\Event\ConfbridgeEndEvent +=============== + +Event triggered when a confbridge is destroyed. + +PHP Version 5 + + +* Class name: ConfbridgeEndEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\ConfbridgeEndEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getConference + + string PAMI\Message\Event\ConfbridgeEndEvent::getConference() + +Returns key: 'Conference'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\ConfbridgeEndEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\ConfbridgeEndEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\ConfbridgeEndEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\ConfbridgeEndEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\ConfbridgeEndEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\ConfbridgeEndEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-ConfbridgeJoinEvent.md b/doc/PAMI-Message-Event-ConfbridgeJoinEvent.md new file mode 100644 index 000000000..1f7f9c586 --- /dev/null +++ b/doc/PAMI-Message-Event-ConfbridgeJoinEvent.md @@ -0,0 +1,675 @@ +PAMI\Message\Event\ConfbridgeJoinEvent +=============== + +Event triggered when a channel enters a confbridge. + +PHP Version 5 + + +* Class name: ConfbridgeJoinEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\ConfbridgeJoinEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getConference + + string PAMI\Message\Event\ConfbridgeJoinEvent::getConference() + +Returns key: 'Conference'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\ConfbridgeJoinEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\ConfbridgeJoinEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\ConfbridgeJoinEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\ConfbridgeJoinEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\ConfbridgeJoinEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\ConfbridgeJoinEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\ConfbridgeJoinEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\ConfbridgeJoinEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\ConfbridgeJoinEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\ConfbridgeJoinEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\ConfbridgeJoinEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\ConfbridgeJoinEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\ConfbridgeJoinEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\ConfbridgeJoinEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\ConfbridgeJoinEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\ConfbridgeJoinEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\ConfbridgeJoinEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\ConfbridgeJoinEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getLinkedid + + string PAMI\Message\Event\ConfbridgeJoinEvent::getLinkedid() + +Returns key: 'Linkedid'. + + + +* Visibility: **public** + + + + +### getAdmin + + string PAMI\Message\Event\ConfbridgeJoinEvent::getAdmin() + +Returns key: 'Admin'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-ConfbridgeLeaveEvent.md b/doc/PAMI-Message-Event-ConfbridgeLeaveEvent.md new file mode 100644 index 000000000..5964c2e83 --- /dev/null +++ b/doc/PAMI-Message-Event-ConfbridgeLeaveEvent.md @@ -0,0 +1,675 @@ +PAMI\Message\Event\ConfbridgeLeaveEvent +=============== + +Event triggered when a channel leaves a confbridge. + +PHP Version 5 + + +* Class name: ConfbridgeLeaveEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getConference + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getConference() + +Returns key: 'Conference'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getLinkedid + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getLinkedid() + +Returns key: 'Linkedid'. + + + +* Visibility: **public** + + + + +### getAdmin + + string PAMI\Message\Event\ConfbridgeLeaveEvent::getAdmin() + +Returns key: 'Admin'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-ConfbridgeMuteEvent.md b/doc/PAMI-Message-Event-ConfbridgeMuteEvent.md new file mode 100644 index 000000000..c14e5e964 --- /dev/null +++ b/doc/PAMI-Message-Event-ConfbridgeMuteEvent.md @@ -0,0 +1,675 @@ +PAMI\Message\Event\ConfbridgeMuteEvent +=============== + +Event triggered when a channel is muted in a confbridge. + +PHP Version 5 + + +* Class name: ConfbridgeMuteEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\ConfbridgeMuteEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getConference + + string PAMI\Message\Event\ConfbridgeMuteEvent::getConference() + +Returns key: 'Conference'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\ConfbridgeMuteEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\ConfbridgeMuteEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\ConfbridgeMuteEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\ConfbridgeMuteEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\ConfbridgeMuteEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\ConfbridgeMuteEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\ConfbridgeMuteEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\ConfbridgeMuteEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\ConfbridgeMuteEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\ConfbridgeMuteEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\ConfbridgeMuteEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\ConfbridgeMuteEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\ConfbridgeMuteEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\ConfbridgeMuteEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\ConfbridgeMuteEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\ConfbridgeMuteEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\ConfbridgeMuteEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\ConfbridgeMuteEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getLinkedid + + string PAMI\Message\Event\ConfbridgeMuteEvent::getLinkedid() + +Returns key: 'Linkedid'. + + + +* Visibility: **public** + + + + +### getAdmin + + string PAMI\Message\Event\ConfbridgeMuteEvent::getAdmin() + +Returns key: 'Admin'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-ConfbridgeStartEvent.md b/doc/PAMI-Message-Event-ConfbridgeStartEvent.md new file mode 100644 index 000000000..59255ee07 --- /dev/null +++ b/doc/PAMI-Message-Event-ConfbridgeStartEvent.md @@ -0,0 +1,493 @@ +PAMI\Message\Event\ConfbridgeStartEvent +=============== + +Event triggered when a confbridge is created. + +PHP Version 5 + + +* Class name: ConfbridgeStartEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\ConfbridgeStartEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getConference + + string PAMI\Message\Event\ConfbridgeStartEvent::getConference() + +Returns key: 'Conference'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\ConfbridgeStartEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\ConfbridgeStartEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\ConfbridgeStartEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\ConfbridgeStartEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\ConfbridgeStartEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\ConfbridgeStartEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-ConfbridgeTalkingEvent.md b/doc/PAMI-Message-Event-ConfbridgeTalkingEvent.md new file mode 100644 index 000000000..9edbc0623 --- /dev/null +++ b/doc/PAMI-Message-Event-ConfbridgeTalkingEvent.md @@ -0,0 +1,688 @@ +PAMI\Message\Event\ConfbridgeTalkingEvent +=============== + +Event triggered when a channel in a Confbridge begins or ends talking + +PHP Version 5 + + +* Class name: ConfbridgeTalkingEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getConference + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getConference() + +Returns key: 'Conference'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getLinkedid + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getLinkedid() + +Returns key: 'Linkedid'. + + + +* Visibility: **public** + + + + +### getTalkingStatus + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getTalkingStatus() + +Returns key: 'TalkingStatus'. + + + +* Visibility: **public** + + + + +### getAdmin + + string PAMI\Message\Event\ConfbridgeTalkingEvent::getAdmin() + +Returns key: 'Admin'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-ConfbridgeUnmuteEvent.md b/doc/PAMI-Message-Event-ConfbridgeUnmuteEvent.md new file mode 100644 index 000000000..e9c5542cc --- /dev/null +++ b/doc/PAMI-Message-Event-ConfbridgeUnmuteEvent.md @@ -0,0 +1,675 @@ +PAMI\Message\Event\ConfbridgeUnmuteEvent +=============== + +Event triggered when a channel is unmuted in a confbridge. + +PHP Version 5 + + +* Class name: ConfbridgeUnmuteEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getConference + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getConference() + +Returns key: 'Conference'. + + + +* Visibility: **public** + + + + +### getBridgeUniqueid + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getBridgeUniqueid() + +Returns key: 'BridgeUniqueid'. + + + +* Visibility: **public** + + + + +### getBridgeType + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getBridgeType() + +Returns key: 'BridgeType'. + + + +* Visibility: **public** + + + + +### getBridgeTechnology + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getBridgeTechnology() + +Returns key: 'BridgeTechnology'. + + + +* Visibility: **public** + + + + +### getBridgeCreator + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getBridgeCreator() + +Returns key: 'BridgeCreator'. + + + +* Visibility: **public** + + + + +### getBridgeName + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getBridgeName() + +Returns key: 'BridgeName'. + + + +* Visibility: **public** + + + + +### getBridgeNumChannels + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getBridgeNumChannels() + +Returns key: 'BridgeNumChannels'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getLinkedid + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getLinkedid() + +Returns key: 'Linkedid'. + + + +* Visibility: **public** + + + + +### getAdmin + + string PAMI\Message\Event\ConfbridgeUnmuteEvent::getAdmin() + +Returns key: 'Admin'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-DNDStateEvent.md b/doc/PAMI-Message-Event-DNDStateEvent.md new file mode 100644 index 000000000..028b1b38f --- /dev/null +++ b/doc/PAMI-Message-Event-DNDStateEvent.md @@ -0,0 +1,441 @@ +PAMI\Message\Event\DNDStateEvent +=============== + +Event triggered when the Do Not Disturb state is changed on a DAHDI channel. + +PHP Version 5 + + +* Class name: DNDStateEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\DNDStateEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\DNDStateEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getDAHDIChannel + + string PAMI\Message\Event\DNDStateEvent::getDAHDIChannel() + +Returns key: 'DAHDIChannel'. + + + +* Visibility: **public** + + + + +### getStatus + + string PAMI\Message\Event\DNDStateEvent::getStatus() + +Returns key: 'Status'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-DTMFBeginEvent.md b/doc/PAMI-Message-Event-DTMFBeginEvent.md new file mode 100644 index 000000000..289c1f288 --- /dev/null +++ b/doc/PAMI-Message-Event-DTMFBeginEvent.md @@ -0,0 +1,585 @@ +PAMI\Message\Event\DTMFBeginEvent +=============== + +Event triggered when a DTMF digit has started on a channel. + +PHP Version 5 + + +* Class name: DTMFBeginEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\DTMFBeginEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\DTMFBeginEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\DTMFBeginEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\DTMFBeginEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\DTMFBeginEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\DTMFBeginEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\DTMFBeginEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\DTMFBeginEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\DTMFBeginEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\DTMFBeginEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\DTMFBeginEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\DTMFBeginEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\DTMFBeginEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getDigit + + string PAMI\Message\Event\DTMFBeginEvent::getDigit() + +Returns key: 'Digit'. + + + +* Visibility: **public** + + + + +### getDirection + + string PAMI\Message\Event\DTMFBeginEvent::getDirection() + +Returns key: 'Direction'. + +Received +Sent + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-DTMFEndEvent.md b/doc/PAMI-Message-Event-DTMFEndEvent.md new file mode 100644 index 000000000..5c4aac2a5 --- /dev/null +++ b/doc/PAMI-Message-Event-DTMFEndEvent.md @@ -0,0 +1,598 @@ +PAMI\Message\Event\DTMFEndEvent +=============== + +Event triggered when a DTMF digit has ended on a channel. + +PHP Version 5 + + +* Class name: DTMFEndEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\DTMFEndEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\DTMFEndEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\DTMFEndEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\DTMFEndEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\DTMFEndEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\DTMFEndEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\DTMFEndEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\DTMFEndEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\DTMFEndEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\DTMFEndEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\DTMFEndEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\DTMFEndEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\DTMFEndEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getDigit + + string PAMI\Message\Event\DTMFEndEvent::getDigit() + +Returns key: 'Digit'. + + + +* Visibility: **public** + + + + +### getDurationMs + + string PAMI\Message\Event\DTMFEndEvent::getDurationMs() + +Returns key: 'DurationMs'. + + + +* Visibility: **public** + + + + +### getDirection + + string PAMI\Message\Event\DTMFEndEvent::getDirection() + +Returns key: 'Direction'. + +Received +Sent + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-DialBeginEvent.md b/doc/PAMI-Message-Event-DialBeginEvent.md new file mode 100644 index 000000000..0cdc43d39 --- /dev/null +++ b/doc/PAMI-Message-Event-DialBeginEvent.md @@ -0,0 +1,740 @@ +PAMI\Message\Event\DialBeginEvent +=============== + +Event triggered when a dial action has started. + +PHP Version 5 + + +* Class name: DialBeginEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\DialBeginEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\DialBeginEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\DialBeginEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\DialBeginEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\DialBeginEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\DialBeginEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\DialBeginEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\DialBeginEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\DialBeginEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\DialBeginEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\DialBeginEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\DialBeginEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\DialBeginEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getDestChannel + + string PAMI\Message\Event\DialBeginEvent::getDestChannel() + +Returns key: 'DestChannel'. + + + +* Visibility: **public** + + + + +### getDestChannelState + + string PAMI\Message\Event\DialBeginEvent::getDestChannelState() + +Returns key: 'DestChannelState'. + + + +* Visibility: **public** + + + + +### getDestChannelStateDesc + + string PAMI\Message\Event\DialBeginEvent::getDestChannelStateDesc() + +Returns key: 'DestChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getDestCallerIDNum + + string PAMI\Message\Event\DialBeginEvent::getDestCallerIDNum() + +Returns key: 'DestCallerIDNum'. + + + +* Visibility: **public** + + + + +### getDestCallerIDName + + string PAMI\Message\Event\DialBeginEvent::getDestCallerIDName() + +Returns key: 'DestCallerIDName'. + + + +* Visibility: **public** + + + + +### getDestConnectedLineNum + + string PAMI\Message\Event\DialBeginEvent::getDestConnectedLineNum() + +Returns key: 'DestConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getDestConnectedLineName + + string PAMI\Message\Event\DialBeginEvent::getDestConnectedLineName() + +Returns key: 'DestConnectedLineName'. + + + +* Visibility: **public** + + + + +### getDestAccountCode + + string PAMI\Message\Event\DialBeginEvent::getDestAccountCode() + +Returns key: 'DestAccountCode'. + + + +* Visibility: **public** + + + + +### getDestContext + + string PAMI\Message\Event\DialBeginEvent::getDestContext() + +Returns key: 'DestContext'. + + + +* Visibility: **public** + + + + +### getDestExten + + string PAMI\Message\Event\DialBeginEvent::getDestExten() + +Returns key: 'DestExten'. + + + +* Visibility: **public** + + + + +### getDestPriority + + string PAMI\Message\Event\DialBeginEvent::getDestPriority() + +Returns key: 'DestPriority'. + + + +* Visibility: **public** + + + + +### getDestUniqueid + + string PAMI\Message\Event\DialBeginEvent::getDestUniqueid() + +Returns key: 'DestUniqueid'. + + + +* Visibility: **public** + + + + +### getDialStatus + + string PAMI\Message\Event\DialBeginEvent::getDialStatus() + +Returns key: 'DialStatus'. + + + +* Visibility: **public** + + + + +### getDialString + + string PAMI\Message\Event\DialBeginEvent::getDialString() + +Returns key: 'DialString'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-DialEndEvent.md b/doc/PAMI-Message-Event-DialEndEvent.md new file mode 100644 index 000000000..0aba9a14c --- /dev/null +++ b/doc/PAMI-Message-Event-DialEndEvent.md @@ -0,0 +1,727 @@ +PAMI\Message\Event\DialEndEvent +=============== + +Event triggered when a dial action has completed. + +PHP Version 5 + + +* Class name: DialEndEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\DialEndEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\DialEndEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\DialEndEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\DialEndEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\DialEndEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\DialEndEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\DialEndEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\DialEndEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\DialEndEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\DialEndEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\DialEndEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\DialEndEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\DialEndEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getDestChannel + + string PAMI\Message\Event\DialEndEvent::getDestChannel() + +Returns key: 'DestChannel'. + + + +* Visibility: **public** + + + + +### getDestChannelState + + string PAMI\Message\Event\DialEndEvent::getDestChannelState() + +Returns key: 'DestChannelState'. + + + +* Visibility: **public** + + + + +### getDestChannelStateDesc + + string PAMI\Message\Event\DialEndEvent::getDestChannelStateDesc() + +Returns key: 'DestChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getDestCallerIDNum + + string PAMI\Message\Event\DialEndEvent::getDestCallerIDNum() + +Returns key: 'DestCallerIDNum'. + + + +* Visibility: **public** + + + + +### getDestCallerIDName + + string PAMI\Message\Event\DialEndEvent::getDestCallerIDName() + +Returns key: 'DestCallerIDName'. + + + +* Visibility: **public** + + + + +### getDestConnectedLineNum + + string PAMI\Message\Event\DialEndEvent::getDestConnectedLineNum() + +Returns key: 'DestConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getDestConnectedLineName + + string PAMI\Message\Event\DialEndEvent::getDestConnectedLineName() + +Returns key: 'DestConnectedLineName'. + + + +* Visibility: **public** + + + + +### getDestAccountCode + + string PAMI\Message\Event\DialEndEvent::getDestAccountCode() + +Returns key: 'DestAccountCode'. + + + +* Visibility: **public** + + + + +### getDestContext + + string PAMI\Message\Event\DialEndEvent::getDestContext() + +Returns key: 'DestContext'. + + + +* Visibility: **public** + + + + +### getDestExten + + string PAMI\Message\Event\DialEndEvent::getDestExten() + +Returns key: 'DestExten'. + + + +* Visibility: **public** + + + + +### getDestPriority + + string PAMI\Message\Event\DialEndEvent::getDestPriority() + +Returns key: 'DestPriority'. + + + +* Visibility: **public** + + + + +### getDestUniqueid + + string PAMI\Message\Event\DialEndEvent::getDestUniqueid() + +Returns key: 'DestUniqueid'. + + + +* Visibility: **public** + + + + +### getDialStatus + + string PAMI\Message\Event\DialEndEvent::getDialStatus() + +Returns key: 'DialStatus'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-MusicOnHoldStartEvent.md b/doc/PAMI-Message-Event-MusicOnHoldStartEvent.md new file mode 100644 index 000000000..91bcd971b --- /dev/null +++ b/doc/PAMI-Message-Event-MusicOnHoldStartEvent.md @@ -0,0 +1,571 @@ +PAMI\Message\Event\MusicOnHoldStartEvent +=============== + +Event triggered when music on hold has started on a channel. + +PHP Version 5 + + +* Class name: MusicOnHoldStartEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\MusicOnHoldStartEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\MusicOnHoldStartEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\MusicOnHoldStartEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\MusicOnHoldStartEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\MusicOnHoldStartEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\MusicOnHoldStartEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\MusicOnHoldStartEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\MusicOnHoldStartEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\MusicOnHoldStartEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\MusicOnHoldStartEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\MusicOnHoldStartEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\MusicOnHoldStartEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\MusicOnHoldStartEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getClass + + string PAMI\Message\Event\MusicOnHoldStartEvent::getClass() + +Returns key: 'Class'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-MusicOnHoldStopEvent.md b/doc/PAMI-Message-Event-MusicOnHoldStopEvent.md new file mode 100644 index 000000000..dbace4ab2 --- /dev/null +++ b/doc/PAMI-Message-Event-MusicOnHoldStopEvent.md @@ -0,0 +1,558 @@ +PAMI\Message\Event\MusicOnHoldStopEvent +=============== + +Event triggered when music on hold has stopped on a channel. + +PHP Version 5 + + +* Class name: MusicOnHoldStopEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\MusicOnHoldStopEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\MusicOnHoldStopEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\MusicOnHoldStopEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\MusicOnHoldStopEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\MusicOnHoldStopEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\MusicOnHoldStopEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\MusicOnHoldStopEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\MusicOnHoldStopEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\MusicOnHoldStopEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\MusicOnHoldStopEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\MusicOnHoldStopEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\MusicOnHoldStopEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueid + + string PAMI\Message\Event\MusicOnHoldStopEvent::getUniqueid() + +Returns key: 'Uniqueid'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-NewextenEvent.md b/doc/PAMI-Message-Event-NewextenEvent.md index 8f7b127a1..77a5d3df9 100644 --- a/doc/PAMI-Message-Event-NewextenEvent.md +++ b/doc/PAMI-Message-Event-NewextenEvent.md @@ -137,6 +137,19 @@ Returns key: 'Channel'. string PAMI\Message\Event\NewextenEvent::getExtension() +Returns key: 'Extension'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\NewextenEvent::getExten() + Returns key: 'Exten'. diff --git a/doc/PAMI-Message-Event-ParkedCallEvent.md b/doc/PAMI-Message-Event-ParkedCallEvent.md index 0b9171f2d..2f7d1ee31 100644 --- a/doc/PAMI-Message-Event-ParkedCallEvent.md +++ b/doc/PAMI-Message-Event-ParkedCallEvent.md @@ -250,6 +250,214 @@ Returns key: 'Exten'. +### getParkeeChannel + + string PAMI\Message\Event\ParkedCallEvent::getParkeeChannel() + +Returns key: 'ParkeeChannel'. + + + +* Visibility: **public** + + + + +### getParkeeChannelState + + string PAMI\Message\Event\ParkedCallEvent::getParkeeChannelState() + +Returns key: 'ParkeeChannelState'. + + + +* Visibility: **public** + + + + +### getParkeeChannelStateDesc + + string PAMI\Message\Event\ParkedCallEvent::getParkeeChannelStateDesc() + +Returns key: 'ParkeeChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getParkeeCallerIDNum + + string PAMI\Message\Event\ParkedCallEvent::getParkeeCallerIDNum() + +Returns key: 'ParkeeCallerIDNum'. + + + +* Visibility: **public** + + + + +### getParkeeCallerIDName + + string PAMI\Message\Event\ParkedCallEvent::getParkeeCallerIDName() + +Returns key: 'ParkeeCallerIDName'. + + + +* Visibility: **public** + + + + +### getParkeeConnectedLineNum + + string PAMI\Message\Event\ParkedCallEvent::getParkeeConnectedLineNum() + +Returns key: 'ParkeeConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getParkeeConnectedLineName + + string PAMI\Message\Event\ParkedCallEvent::getParkeeConnectedLineName() + +Returns key: 'ParkeeConnectedLineName'. + + + +* Visibility: **public** + + + + +### getParkeeAccountCode + + string PAMI\Message\Event\ParkedCallEvent::getParkeeAccountCode() + +Returns key: 'ParkeeAccountCode'. + + + +* Visibility: **public** + + + + +### getParkeeContext + + string PAMI\Message\Event\ParkedCallEvent::getParkeeContext() + +Returns key: 'ParkeeContext'. + + + +* Visibility: **public** + + + + +### getParkeeExten + + string PAMI\Message\Event\ParkedCallEvent::getParkeeExten() + +Returns key: 'ParkeeExten'. + + + +* Visibility: **public** + + + + +### getParkeePriority + + string PAMI\Message\Event\ParkedCallEvent::getParkeePriority() + +Returns key: 'ParkeePriority'. + + + +* Visibility: **public** + + + + +### getParkeeUniqueid + + string PAMI\Message\Event\ParkedCallEvent::getParkeeUniqueid() + +Returns key: 'ParkeeUniqueid'. + + + +* Visibility: **public** + + + + +### getParkerDialString + + string PAMI\Message\Event\ParkedCallEvent::getParkerDialString() + +Returns key: 'ParkerDialString'. + + + +* Visibility: **public** + + + + +### getParkingSpace + + string PAMI\Message\Event\ParkedCallEvent::getParkingSpace() + +Returns key: 'ParkingSpace'. + + + +* Visibility: **public** + + + + +### getParkingTimeout + + string PAMI\Message\Event\ParkedCallEvent::getParkingTimeout() + +Returns key: 'ParkingTimeout'. + + + +* Visibility: **public** + + + + +### getParkingDuration + + string PAMI\Message\Event\ParkedCallEvent::getParkingDuration() + +Returns key: 'ParkingDuration'. + + + +* Visibility: **public** + + + + ### getName string PAMI\Message\Event\EventMessage::getName() diff --git a/doc/PAMI-Message-Event-ParkedCallGiveUpEvent.md b/doc/PAMI-Message-Event-ParkedCallGiveUpEvent.md new file mode 100644 index 000000000..0e1cf2837 --- /dev/null +++ b/doc/PAMI-Message-Event-ParkedCallGiveUpEvent.md @@ -0,0 +1,779 @@ +PAMI\Message\Event\ParkedCallGiveUpEvent +=============== + +Event triggered when a channel leaves a parking lot because it hung up without being answered. + +PHP Version 5 + + +* Class name: ParkedCallGiveUpEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getParkeeChannel + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeChannel() + +Returns key: 'ParkeeChannel'. + + + +* Visibility: **public** + + + + +### getParkeeChannelState + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeChannelState() + +Returns key: 'ParkeeChannelState'. + + + +* Visibility: **public** + + + + +### getParkeeChannelStateDesc + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeChannelStateDesc() + +Returns key: 'ParkeeChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getParkeeCallerIDNum + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeCallerIDNum() + +Returns key: 'ParkeeCallerIDNum'. + + + +* Visibility: **public** + + + + +### getParkeeCallerIDName + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeCallerIDName() + +Returns key: 'ParkeeCallerIDName'. + + + +* Visibility: **public** + + + + +### getParkeeConnectedLineNum + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeConnectedLineNum() + +Returns key: 'ParkeeConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getParkeeConnectedLineName + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeConnectedLineName() + +Returns key: 'ParkeeConnectedLineName'. + + + +* Visibility: **public** + + + + +### getParkeeAccountCode + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeAccountCode() + +Returns key: 'ParkeeAccountCode'. + + + +* Visibility: **public** + + + + +### getParkeeContext + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeContext() + +Returns key: 'ParkeeContext'. + + + +* Visibility: **public** + + + + +### getParkeeExten + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeExten() + +Returns key: 'ParkeeExten'. + + + +* Visibility: **public** + + + + +### getParkeePriority + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeePriority() + +Returns key: 'ParkeePriority'. + + + +* Visibility: **public** + + + + +### getParkeeUniqueid + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkeeUniqueid() + +Returns key: 'ParkeeUniqueid'. + + + +* Visibility: **public** + + + + +### getParkerChannel + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerChannel() + +Returns key: 'ParkerChannel'. + + + +* Visibility: **public** + + + + +### getParkerChannelState + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerChannelState() + +Returns key: 'ParkerChannelState'. + + + +* Visibility: **public** + + + + +### getParkerChannelStateDesc + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerChannelStateDesc() + +Returns key: 'ParkerChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getParkerCallerIDNum + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerCallerIDNum() + +Returns key: 'ParkerCallerIDNum'. + + + +* Visibility: **public** + + + + +### getParkerCallerIDName + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerCallerIDName() + +Returns key: 'ParkerCallerIDName'. + + + +* Visibility: **public** + + + + +### getParkerConnectedLineNum + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerConnectedLineNum() + +Returns key: 'ParkerConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getParkerConnectedLineName + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerConnectedLineName() + +Returns key: 'ParkerConnectedLineName'. + + + +* Visibility: **public** + + + + +### getParkerAccountCode + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerAccountCode() + +Returns key: 'ParkerAccountCode'. + + + +* Visibility: **public** + + + + +### getParkerContext + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerContext() + +Returns key: 'ParkerContext'. + + + +* Visibility: **public** + + + + +### getParkerExten + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerExten() + +Returns key: 'ParkerExten'. + + + +* Visibility: **public** + + + + +### getParkerPriority + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerPriority() + +Returns key: 'ParkerPriority'. + + + +* Visibility: **public** + + + + +### getParkerUniqueid + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerUniqueid() + +Returns key: 'ParkerUniqueid'. + + + +* Visibility: **public** + + + + +### getParkerDialString + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkerDialString() + +Returns key: 'ParkerDialString'. + + + +* Visibility: **public** + + + + +### getParkinglot + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkinglot() + +Returns key: 'Parkinglot'. + + + +* Visibility: **public** + + + + +### getParkingSpace + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkingSpace() + +Returns key: 'ParkingSpace'. + + + +* Visibility: **public** + + + + +### getParkingTimeout + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkingTimeout() + +Returns key: 'ParkingTimeout'. + + + +* Visibility: **public** + + + + +### getParkingDuration + + string PAMI\Message\Event\ParkedCallGiveUpEvent::getParkingDuration() + +Returns key: 'ParkingDuration'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-ParkedCallTimeOutEvent.md b/doc/PAMI-Message-Event-ParkedCallTimeOutEvent.md new file mode 100644 index 000000000..3c851c1a2 --- /dev/null +++ b/doc/PAMI-Message-Event-ParkedCallTimeOutEvent.md @@ -0,0 +1,779 @@ +PAMI\Message\Event\ParkedCallTimeOutEvent +=============== + +Event triggered when a channel leaves a parking lot due to reaching the time limit of being parked. + +PHP Version 5 + + +* Class name: ParkedCallTimeOutEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getParkeeChannel + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeChannel() + +Returns key: 'ParkeeChannel'. + + + +* Visibility: **public** + + + + +### getParkeeChannelState + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeChannelState() + +Returns key: 'ParkeeChannelState'. + + + +* Visibility: **public** + + + + +### getParkeeChannelStateDesc + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeChannelStateDesc() + +Returns key: 'ParkeeChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getParkeeCallerIDNum + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeCallerIDNum() + +Returns key: 'ParkeeCallerIDNum'. + + + +* Visibility: **public** + + + + +### getParkeeCallerIDName + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeCallerIDName() + +Returns key: 'ParkeeCallerIDName'. + + + +* Visibility: **public** + + + + +### getParkeeConnectedLineNum + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeConnectedLineNum() + +Returns key: 'ParkeeConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getParkeeConnectedLineName + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeConnectedLineName() + +Returns key: 'ParkeeConnectedLineName'. + + + +* Visibility: **public** + + + + +### getParkeeAccountCode + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeAccountCode() + +Returns key: 'ParkeeAccountCode'. + + + +* Visibility: **public** + + + + +### getParkeeContext + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeContext() + +Returns key: 'ParkeeContext'. + + + +* Visibility: **public** + + + + +### getParkeeExten + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeExten() + +Returns key: 'ParkeeExten'. + + + +* Visibility: **public** + + + + +### getParkeePriority + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeePriority() + +Returns key: 'ParkeePriority'. + + + +* Visibility: **public** + + + + +### getParkeeUniqueid + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkeeUniqueid() + +Returns key: 'ParkeeUniqueid'. + + + +* Visibility: **public** + + + + +### getParkerChannel + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerChannel() + +Returns key: 'ParkerChannel'. + + + +* Visibility: **public** + + + + +### getParkerChannelState + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerChannelState() + +Returns key: 'ParkerChannelState'. + + + +* Visibility: **public** + + + + +### getParkerChannelStateDesc + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerChannelStateDesc() + +Returns key: 'ParkerChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getParkerCallerIDNum + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerCallerIDNum() + +Returns key: 'ParkerCallerIDNum'. + + + +* Visibility: **public** + + + + +### getParkerCallerIDName + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerCallerIDName() + +Returns key: 'ParkerCallerIDName'. + + + +* Visibility: **public** + + + + +### getParkerConnectedLineNum + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerConnectedLineNum() + +Returns key: 'ParkerConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getParkerConnectedLineName + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerConnectedLineName() + +Returns key: 'ParkerConnectedLineName'. + + + +* Visibility: **public** + + + + +### getParkerAccountCode + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerAccountCode() + +Returns key: 'ParkerAccountCode'. + + + +* Visibility: **public** + + + + +### getParkerContext + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerContext() + +Returns key: 'ParkerContext'. + + + +* Visibility: **public** + + + + +### getParkerExten + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerExten() + +Returns key: 'ParkerExten'. + + + +* Visibility: **public** + + + + +### getParkerPriority + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerPriority() + +Returns key: 'ParkerPriority'. + + + +* Visibility: **public** + + + + +### getParkerUniqueid + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerUniqueid() + +Returns key: 'ParkerUniqueid'. + + + +* Visibility: **public** + + + + +### getParkerDialString + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkerDialString() + +Returns key: 'ParkerDialString'. + + + +* Visibility: **public** + + + + +### getParkinglot + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkinglot() + +Returns key: 'Parkinglot'. + + + +* Visibility: **public** + + + + +### getParkingSpace + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkingSpace() + +Returns key: 'ParkingSpace'. + + + +* Visibility: **public** + + + + +### getParkingTimeout + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkingTimeout() + +Returns key: 'ParkingTimeout'. + + + +* Visibility: **public** + + + + +### getParkingDuration + + string PAMI\Message\Event\ParkedCallTimeOutEvent::getParkingDuration() + +Returns key: 'ParkingDuration'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-QueueCallerAbandonEvent.md b/doc/PAMI-Message-Event-QueueCallerAbandonEvent.md new file mode 100644 index 000000000..2fc94174b --- /dev/null +++ b/doc/PAMI-Message-Event-QueueCallerAbandonEvent.md @@ -0,0 +1,610 @@ +PAMI\Message\Event\QueueCallerAbandonEvent +=============== + +Event triggered when a caller abandons the queue. + +PHP Version 5 + + +* Class name: QueueCallerAbandonEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\QueueCallerAbandonEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\QueueCallerAbandonEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\QueueCallerAbandonEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\QueueCallerAbandonEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCallerIDNum + + string PAMI\Message\Event\QueueCallerAbandonEvent::getCallerIDNum() + +Returns key: 'CallerIDNum'. + + + +* Visibility: **public** + + + + +### getCallerIDName + + string PAMI\Message\Event\QueueCallerAbandonEvent::getCallerIDName() + +Returns key: 'CallerIDName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\QueueCallerAbandonEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\QueueCallerAbandonEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\QueueCallerAbandonEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\QueueCallerAbandonEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\QueueCallerAbandonEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\QueueCallerAbandonEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getUniqueID + + string PAMI\Message\Event\QueueCallerAbandonEvent::getUniqueID() + +Returns key: 'UniqueID'. + + + +* Visibility: **public** + + + + +### getQueue + + string PAMI\Message\Event\QueueCallerAbandonEvent::getQueue() + +Returns key: 'Queue'. + + + +* Visibility: **public** + + + + +### getPosition + + string PAMI\Message\Event\QueueCallerAbandonEvent::getPosition() + +Returns key: 'Position'. + + + +* Visibility: **public** + + + + +### getOriginalPosition + + string PAMI\Message\Event\QueueCallerAbandonEvent::getOriginalPosition() + +Returns key: 'OriginalPosition'. + + + +* Visibility: **public** + + + + +### getHoldTime + + string PAMI\Message\Event\QueueCallerAbandonEvent::getHoldTime() + +Returns key: 'HoldTime'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-QueueCallerJoinEvent.md b/doc/PAMI-Message-Event-QueueCallerJoinEvent.md new file mode 100644 index 000000000..09f10b841 --- /dev/null +++ b/doc/PAMI-Message-Event-QueueCallerJoinEvent.md @@ -0,0 +1,597 @@ +PAMI\Message\Event\QueueCallerJoinEvent +=============== + +Event triggered when a caller joins a Queue. + +PHP Version 5 + + +* Class name: QueueCallerJoinEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\QueueCallerJoinEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\QueueCallerJoinEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\QueueCallerJoinEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\QueueCallerJoinEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCount + + string PAMI\Message\Event\QueueCallerJoinEvent::getCount() + +Returns key: 'Count'. + + + +* Visibility: **public** + + + + +### getQueue + + string PAMI\Message\Event\QueueCallerJoinEvent::getQueue() + +Returns key: 'Queue'. + + + +* Visibility: **public** + + + + +### getPosition + + string PAMI\Message\Event\QueueCallerJoinEvent::getPosition() + +Returns key: 'Position'. + + + +* Visibility: **public** + + + + +### getUniqueID + + string PAMI\Message\Event\QueueCallerJoinEvent::getUniqueID() + +Returns key: 'UniqueID'. + + + +* Visibility: **public** + + + + +### getCallerIdNum + + string PAMI\Message\Event\QueueCallerJoinEvent::getCallerIdNum() + +Returns key: 'CallerIdNum'. + + + +* Visibility: **public** + + + + +### getCallerIdName + + string PAMI\Message\Event\QueueCallerJoinEvent::getCallerIdName() + +Returns key: 'CallerIdName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\QueueCallerJoinEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\QueueCallerJoinEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\QueueCallerJoinEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\QueueCallerJoinEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\QueueCallerJoinEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\QueueCallerJoinEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-QueueCallerLeaveEvent.md b/doc/PAMI-Message-Event-QueueCallerLeaveEvent.md new file mode 100644 index 000000000..48ae20d57 --- /dev/null +++ b/doc/PAMI-Message-Event-QueueCallerLeaveEvent.md @@ -0,0 +1,597 @@ +PAMI\Message\Event\QueueCallerLeaveEvent +=============== + +Event triggered when a caller leaves a Queue. + +PHP Version 5 + + +* Class name: QueueCallerLeaveEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getPrivilege + + string PAMI\Message\Event\QueueCallerLeaveEvent::getPrivilege() + +Returns key: 'Privilege'. + + + +* Visibility: **public** + + + + +### getChannel + + string PAMI\Message\Event\QueueCallerLeaveEvent::getChannel() + +Returns key: 'Channel'. + + + +* Visibility: **public** + + + + +### getChannelState + + string PAMI\Message\Event\QueueCallerLeaveEvent::getChannelState() + +Returns key: 'ChannelState'. + + + +* Visibility: **public** + + + + +### getChannelStateDesc + + string PAMI\Message\Event\QueueCallerLeaveEvent::getChannelStateDesc() + +Returns key: 'ChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getCount + + string PAMI\Message\Event\QueueCallerLeaveEvent::getCount() + +Returns key: 'Count'. + + + +* Visibility: **public** + + + + +### getQueue + + string PAMI\Message\Event\QueueCallerLeaveEvent::getQueue() + +Returns key: 'Queue'. + + + +* Visibility: **public** + + + + +### getPosition + + string PAMI\Message\Event\QueueCallerLeaveEvent::getPosition() + +Returns key: 'Position'. + + + +* Visibility: **public** + + + + +### getUniqueID + + string PAMI\Message\Event\QueueCallerLeaveEvent::getUniqueID() + +Returns key: 'UniqueID'. + + + +* Visibility: **public** + + + + +### getCallerIdNum + + string PAMI\Message\Event\QueueCallerLeaveEvent::getCallerIdNum() + +Returns key: 'CallerIdNum'. + + + +* Visibility: **public** + + + + +### getCallerIdName + + string PAMI\Message\Event\QueueCallerLeaveEvent::getCallerIdName() + +Returns key: 'CallerIdName'. + + + +* Visibility: **public** + + + + +### getConnectedLineNum + + string PAMI\Message\Event\QueueCallerLeaveEvent::getConnectedLineNum() + +Returns key: 'ConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getConnectedLineName + + string PAMI\Message\Event\QueueCallerLeaveEvent::getConnectedLineName() + +Returns key: 'ConnectedLineName'. + + + +* Visibility: **public** + + + + +### getExten + + string PAMI\Message\Event\QueueCallerLeaveEvent::getExten() + +Returns key: 'Exten'. + + + +* Visibility: **public** + + + + +### getContext + + string PAMI\Message\Event\QueueCallerLeaveEvent::getContext() + +Returns key: 'Context'. + + + +* Visibility: **public** + + + + +### getAccountCode + + string PAMI\Message\Event\QueueCallerLeaveEvent::getAccountCode() + +Returns key: 'AccountCode'. + + + +* Visibility: **public** + + + + +### getPriority + + string PAMI\Message\Event\QueueCallerLeaveEvent::getPriority() + +Returns key: 'Priority'. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-UnParkedCallEvent.md b/doc/PAMI-Message-Event-UnParkedCallEvent.md index 834c1b07d..3a10c3c6e 100644 --- a/doc/PAMI-Message-Event-UnParkedCallEvent.md +++ b/doc/PAMI-Message-Event-UnParkedCallEvent.md @@ -146,6 +146,19 @@ Returns key: 'From'. +### getTimeout + + string PAMI\Message\Event\UnParkedCallEvent::getTimeout() + +Returns key: 'Timeout'. + + + +* Visibility: **public** + + + + ### getConnectedLineNum string PAMI\Message\Event\UnParkedCallEvent::getConnectedLineNum() @@ -237,6 +250,526 @@ Returns key: 'Exten'. +### getParkeeChannel + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeChannel() + +Returns key: 'ParkeeChannel'. + + + +* Visibility: **public** + + + + +### getParkeeChannelState + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeChannelState() + +Returns key: 'ParkeeChannelState'. + + + +* Visibility: **public** + + + + +### getParkeeChannelStateDesc + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeChannelStateDesc() + +Returns key: 'ParkeeChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getParkeeCallerIDNum + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeCallerIDNum() + +Returns key: 'ParkeeCallerIDNum'. + + + +* Visibility: **public** + + + + +### getParkeeCallerIDName + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeCallerIDName() + +Returns key: 'ParkeeCallerIDName'. + + + +* Visibility: **public** + + + + +### getParkeeConnectedLineNum + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeConnectedLineNum() + +Returns key: 'ParkeeConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getParkeeConnectedLineName + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeConnectedLineName() + +Returns key: 'ParkeeConnectedLineName'. + + + +* Visibility: **public** + + + + +### getParkeeAccountCode + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeAccountCode() + +Returns key: 'ParkeeAccountCode'. + + + +* Visibility: **public** + + + + +### getParkeeContext + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeContext() + +Returns key: 'ParkeeContext'. + + + +* Visibility: **public** + + + + +### getParkeeExten + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeExten() + +Returns key: 'ParkeeExten'. + + + +* Visibility: **public** + + + + +### getParkeePriority + + string PAMI\Message\Event\UnParkedCallEvent::getParkeePriority() + +Returns key: 'ParkeePriority'. + + + +* Visibility: **public** + + + + +### getParkeeUniqueid + + string PAMI\Message\Event\UnParkedCallEvent::getParkeeUniqueid() + +Returns key: 'ParkeeUniqueid'. + + + +* Visibility: **public** + + + + +### getParkerDialString + + string PAMI\Message\Event\UnParkedCallEvent::getParkerDialString() + +Returns key: 'ParkerDialString'. + + + +* Visibility: **public** + + + + +### getParkingSpace + + string PAMI\Message\Event\UnParkedCallEvent::getParkingSpace() + +Returns key: 'ParkingSpace'. + + + +* Visibility: **public** + + + + +### getParkingTimeout + + string PAMI\Message\Event\UnParkedCallEvent::getParkingTimeout() + +Returns key: 'ParkingTimeout'. + + + +* Visibility: **public** + + + + +### getParkingDuration + + string PAMI\Message\Event\UnParkedCallEvent::getParkingDuration() + +Returns key: 'ParkingDuration'. + + + +* Visibility: **public** + + + + +### getParkerChannel + + string PAMI\Message\Event\UnParkedCallEvent::getParkerChannel() + +Returns key: 'ParkerChannel'. + + + +* Visibility: **public** + + + + +### getParkerChannelState + + string PAMI\Message\Event\UnParkedCallEvent::getParkerChannelState() + +Returns key: 'ParkerChannelState'. + + + +* Visibility: **public** + + + + +### getParkerChannelStateDesc + + string PAMI\Message\Event\UnParkedCallEvent::getParkerChannelStateDesc() + +Returns key: 'ParkerChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getParkerCallerIDNum + + string PAMI\Message\Event\UnParkedCallEvent::getParkerCallerIDNum() + +Returns key: 'ParkerCallerIDNum'. + + + +* Visibility: **public** + + + + +### getParkerCallerIDName + + string PAMI\Message\Event\UnParkedCallEvent::getParkerCallerIDName() + +Returns key: 'ParkerCallerIDName'. + + + +* Visibility: **public** + + + + +### getParkerConnectedLineNum + + string PAMI\Message\Event\UnParkedCallEvent::getParkerConnectedLineNum() + +Returns key: 'ParkerConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getParkerConnectedLineName + + string PAMI\Message\Event\UnParkedCallEvent::getParkerConnectedLineName() + +Returns key: 'ParkerConnectedLineName'. + + + +* Visibility: **public** + + + + +### getParkerAccountCode + + string PAMI\Message\Event\UnParkedCallEvent::getParkerAccountCode() + +Returns key: 'ParkerAccountCode'. + + + +* Visibility: **public** + + + + +### getParkerContext + + string PAMI\Message\Event\UnParkedCallEvent::getParkerContext() + +Returns key: 'ParkerContext'. + + + +* Visibility: **public** + + + + +### getParkerExten + + string PAMI\Message\Event\UnParkedCallEvent::getParkerExten() + +Returns key: 'ParkerExten'. + + + +* Visibility: **public** + + + + +### getParkerPriority + + string PAMI\Message\Event\UnParkedCallEvent::getParkerPriority() + +Returns key: 'ParkerPriority'. + + + +* Visibility: **public** + + + + +### getParkerUniqueid + + string PAMI\Message\Event\UnParkedCallEvent::getParkerUniqueid() + +Returns key: 'ParkerUniqueid'. + + + +* Visibility: **public** + + + + +### getRetrieverChannel + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverChannel() + +Returns key: 'RetrieverChannel'. + + + +* Visibility: **public** + + + + +### getRetrieverChannelState + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverChannelState() + +Returns key: 'RetrieverChannelState'. + + + +* Visibility: **public** + + + + +### getRetrieverChannelStateDesc + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverChannelStateDesc() + +Returns key: 'RetrieverChannelStateDesc'. + + + +* Visibility: **public** + + + + +### getRetrieverCallerIDNum + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverCallerIDNum() + +Returns key: 'RetrieverCallerIDNum'. + + + +* Visibility: **public** + + + + +### getRetrieverCallerIDName + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverCallerIDName() + +Returns key: 'RetrieverCallerIDName'. + + + +* Visibility: **public** + + + + +### getRetrieverConnectedLineNum + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverConnectedLineNum() + +Returns key: 'RetrieverConnectedLineNum'. + + + +* Visibility: **public** + + + + +### getRetrieverConnectedLineName + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverConnectedLineName() + +Returns key: 'RetrieverConnectedLineName'. + + + +* Visibility: **public** + + + + +### getRetrieverAccountCode + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverAccountCode() + +Returns key: 'RetrieverAccountCode'. + + + +* Visibility: **public** + + + + +### getRetrieverContext + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverContext() + +Returns key: 'RetrieverContext'. + + + +* Visibility: **public** + + + + +### getRetrieverExten + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverExten() + +Returns key: 'RetrieverExten'. + + + +* Visibility: **public** + + + + +### getRetrieverPriority + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverPriority() + +Returns key: 'RetrieverPriority'. + + + +* Visibility: **public** + + + + +### getRetrieverUniqueid + + string PAMI\Message\Event\UnParkedCallEvent::getRetrieverUniqueid() + +Returns key: 'RetrieverUniqueid'. + + + +* Visibility: **public** + + + + ### getName string PAMI\Message\Event\EventMessage::getName() From 4fc5bb3c37e60fc46e9c7d4b60d33d3696ac93b5 Mon Sep 17 00:00:00 2001 From: wizzle Date: Fri, 19 Jan 2018 15:49:44 +0300 Subject: [PATCH 09/11] phpmd and CodeSniffer are happy now --- doc/PAMI-AsyncAgi-AsyncClientImpl.md | 2 +- doc/PAMI-Message-Action-UpdateConfigAction.md | 16 +++++------ doc/PAMI-Message-Action-VGSMSMSTxAction.md | 8 +++--- src/PAMI/AsyncAgi/AsyncClientImpl.php | 5 ++++ src/PAMI/Client/Impl/ClientImpl.php | 3 ++- src/PAMI/Message/Action/AGIAction.php | 8 +++--- src/PAMI/Message/Action/BridgeAction.php | 2 +- src/PAMI/Message/Action/BridgeListAction.php | 27 ++++++++++++++++++- .../Message/Action/DAHDIDialOffHookAction.php | 3 ++- src/PAMI/Message/Action/PlayDTMFAction.php | 6 ++--- src/PAMI/Message/Action/QueuePauseAction.php | 10 ++++--- .../Message/Action/QueuePenaltyAction.php | 9 +++---- src/PAMI/Message/Action/QueueStatusAction.php | 8 +++--- .../Message/Action/QueueUnpauseAction.php | 4 ++- .../Message/Action/UpdateConfigAction.php | 23 ++++++++-------- src/PAMI/Message/Action/VGSMSMSTxAction.php | 13 +++++---- src/PAMI/Message/Message.php | 1 + 17 files changed, 94 insertions(+), 54 deletions(-) diff --git a/doc/PAMI-AsyncAgi-AsyncClientImpl.md b/doc/PAMI-AsyncAgi-AsyncClientImpl.md index d7bc8b623..3761f7284 100644 --- a/doc/PAMI-AsyncAgi-AsyncClientImpl.md +++ b/doc/PAMI-AsyncAgi-AsyncClientImpl.md @@ -108,7 +108,7 @@ Event handler. ### send - mixed PAMI\AsyncAgi\AsyncClientImpl::send($text) + \PAGI\Client\Result\Result PAMI\AsyncAgi\AsyncClientImpl::send($text) (non-PHPdoc) diff --git a/doc/PAMI-Message-Action-UpdateConfigAction.md b/doc/PAMI-Message-Action-UpdateConfigAction.md index 8b1139619..445f75df3 100644 --- a/doc/PAMI-Message-Action-UpdateConfigAction.md +++ b/doc/PAMI-Message-Action-UpdateConfigAction.md @@ -113,9 +113,9 @@ Constructor. ### setSrcFilename - void PAMI\Message\Action\UpdateConfigAction::setSrcFilename($filename) + void PAMI\Message\Action\UpdateConfigAction::setSrcFilename($fileName) -Sets Src filename key. +Sets source filename key. @@ -123,15 +123,15 @@ Sets Src filename key. #### Arguments -* $filename **mixed** +* $fileName **mixed** ### setDstFilename - void PAMI\Message\Action\UpdateConfigAction::setDstFilename($filename) + void PAMI\Message\Action\UpdateConfigAction::setDstFilename($fileName) -Sets Dst Filename key. +Sets destination Filename key. @@ -139,7 +139,7 @@ Sets Dst Filename key. #### Arguments -* $filename **mixed** +* $fileName **mixed** @@ -177,7 +177,7 @@ Sets Action-XXXXXX key. ### setCat - void PAMI\Message\Action\UpdateConfigAction::setCat($input) + void PAMI\Message\Action\UpdateConfigAction::setCat($cat) Sets Cat-XXXXXX key. @@ -187,7 +187,7 @@ Sets Cat-XXXXXX key. #### Arguments -* $input **mixed** +* $cat **mixed** diff --git a/doc/PAMI-Message-Action-VGSMSMSTxAction.md b/doc/PAMI-Message-Action-VGSMSMSTxAction.md index 901d997ba..054641d8a 100644 --- a/doc/PAMI-Message-Action-VGSMSMSTxAction.md +++ b/doc/PAMI-Message-Action-VGSMSMSTxAction.md @@ -168,7 +168,7 @@ Sets $content - Message to send. Mandatory ### setSmsClass - void PAMI\Message\Action\VGSMSMSTxAction::setSmsClass($class) + void PAMI\Message\Action\VGSMSMSTxAction::setSmsClass(string $smsClass) Sets X-SMS-Class key. Optional @@ -178,7 +178,7 @@ Sets X-SMS-Class key. Optional #### Arguments -* $class **mixed** +* $smsClass **string** - <p>Class of SMS to send. Values are 0, 1. 0 is Flash message.</p> @@ -201,7 +201,7 @@ setConcatSeqNum and setConcatSeqNum ### setConcatSeqNum - void PAMI\Message\Action\VGSMSMSTxAction::setConcatSeqNum($seqnum) + void PAMI\Message\Action\VGSMSMSTxAction::setConcatSeqNum($seqNum) Sets X-SMS-Concatenate-Sequence-Number. Optional. Should be set with setConcatSeqNum: setConcatTotalMsg @@ -212,7 +212,7 @@ setConcatSeqNum: setConcatTotalMsg #### Arguments -* $seqnum **mixed** +* $seqNum **mixed** diff --git a/src/PAMI/AsyncAgi/AsyncClientImpl.php b/src/PAMI/AsyncAgi/AsyncClientImpl.php index fdf8ac5e1..6f5599a2f 100644 --- a/src/PAMI/AsyncAgi/AsyncClientImpl.php +++ b/src/PAMI/AsyncAgi/AsyncClientImpl.php @@ -101,6 +101,11 @@ public function handle(EventMessage $event) /** * (non-PHPdoc) * @see ClientImpl::send() + * @param $text + * @return Result + * @throws \PAGI\Exception\ChannelDownException + * @throws \PAGI\Exception\InvalidCommandException + * @throws \PAMI\Client\Exception\ClientException */ protected function send($text) { diff --git a/src/PAMI/Client/Impl/ClientImpl.php b/src/PAMI/Client/Impl/ClientImpl.php index 853e4b746..98e7a528a 100644 --- a/src/PAMI/Client/Impl/ClientImpl.php +++ b/src/PAMI/Client/Impl/ClientImpl.php @@ -1,5 +1,4 @@ setKey('Channel', $channel); $this->setKey('Command', $command); - if ($commandId !== false) { + if ($commandId !== null) { $this->setKey('CommandId', $commandId); } } diff --git a/src/PAMI/Message/Action/BridgeAction.php b/src/PAMI/Message/Action/BridgeAction.php index 43cd3b79a..8ef4d95a4 100644 --- a/src/PAMI/Message/Action/BridgeAction.php +++ b/src/PAMI/Message/Action/BridgeAction.php @@ -47,7 +47,7 @@ class BridgeAction extends ActionMessage * Constructor. * * @param string $channel1 Channel1 - * @param string $channel1 Channel1 + * @param string $channel2 Channel2 * @param boolean $tone Play courtesy tone to Channel2 * * @return void diff --git a/src/PAMI/Message/Action/BridgeListAction.php b/src/PAMI/Message/Action/BridgeListAction.php index d02bf79b9..e9920e58e 100644 --- a/src/PAMI/Message/Action/BridgeListAction.php +++ b/src/PAMI/Message/Action/BridgeListAction.php @@ -1,5 +1,30 @@ + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ namespace PAMI\Message\Action; /** diff --git a/src/PAMI/Message/Action/DAHDIDialOffHookAction.php b/src/PAMI/Message/Action/DAHDIDialOffHookAction.php index c952ff1a3..bbb623a3d 100644 --- a/src/PAMI/Message/Action/DAHDIDialOffHookAction.php +++ b/src/PAMI/Message/Action/DAHDIDialOffHookAction.php @@ -46,7 +46,8 @@ class DAHDIDialOffHookAction extends ActionMessage /** * Constructor. * - * @return void + * @param $channel + * @param $number */ public function __construct($channel, $number) { diff --git a/src/PAMI/Message/Action/PlayDTMFAction.php b/src/PAMI/Message/Action/PlayDTMFAction.php index 62891651a..11548425b 100644 --- a/src/PAMI/Message/Action/PlayDTMFAction.php +++ b/src/PAMI/Message/Action/PlayDTMFAction.php @@ -46,10 +46,8 @@ class PlayDTMFAction extends ActionMessage /** * Constructor. * - * @param string $user AMI username. - * @param string $password AMI password. - * - * @return void + * @param $channel + * @param $digit */ public function __construct($channel, $digit) { diff --git a/src/PAMI/Message/Action/QueuePauseAction.php b/src/PAMI/Message/Action/QueuePauseAction.php index 48524569d..eae83c174 100644 --- a/src/PAMI/Message/Action/QueuePauseAction.php +++ b/src/PAMI/Message/Action/QueuePauseAction.php @@ -46,15 +46,17 @@ class QueuePauseAction extends ActionMessage /** * Constructor. * - * @return void + * @param $interface + * @param string $queue + * @param string $reason */ - public function __construct($interface, $queue = false, $reason = false) + public function __construct($interface, $queue = null, $reason = null) { parent::__construct('QueuePause'); - if ($queue !== false) { + if ($queue !== null) { $this->setKey('Queue', $queue); } - if ($reason !== false) { + if ($reason !== null) { $this->setKey('Reason', $reason); } $this->setKey('Interface', $interface); diff --git a/src/PAMI/Message/Action/QueuePenaltyAction.php b/src/PAMI/Message/Action/QueuePenaltyAction.php index 6dae34e49..1533545c4 100644 --- a/src/PAMI/Message/Action/QueuePenaltyAction.php +++ b/src/PAMI/Message/Action/QueuePenaltyAction.php @@ -46,17 +46,16 @@ class QueuePenaltyAction extends ActionMessage /** * Constructor. * + * @param $interface + * @param $penalty * @param string $queue Queue name. - * @param string $event Event. - * - * @return void */ - public function __construct($interface, $penalty, $queue = false) + public function __construct($interface, $penalty, $queue = null) { parent::__construct('QueuePenalty'); $this->setKey('Interface', $interface); $this->setKey('Penalty', $penalty); - if ($queue !== false) { + if ($queue !== null) { $this->setKey('Queue', $queue); } } diff --git a/src/PAMI/Message/Action/QueueStatusAction.php b/src/PAMI/Message/Action/QueueStatusAction.php index 72865643c..03e9bbfe8 100644 --- a/src/PAMI/Message/Action/QueueStatusAction.php +++ b/src/PAMI/Message/Action/QueueStatusAction.php @@ -48,15 +48,15 @@ class QueueStatusAction extends ActionMessage * * @param string $queue The queue (optional). * - * @return void + * @param string $member */ - public function __construct($queue = false, $member = false) + public function __construct($queue = null, $member = null) { parent::__construct('QueueStatus'); - if ($queue != false) { + if ($queue != null) { $this->setKey('Queue', $queue); } - if ($member != false) { + if ($member != null) { $this->setKey('Member', $member); } } diff --git a/src/PAMI/Message/Action/QueueUnpauseAction.php b/src/PAMI/Message/Action/QueueUnpauseAction.php index c91329715..ed0c0d788 100644 --- a/src/PAMI/Message/Action/QueueUnpauseAction.php +++ b/src/PAMI/Message/Action/QueueUnpauseAction.php @@ -46,7 +46,9 @@ class QueueUnpauseAction extends ActionMessage /** * Constructor. * - * @return void + * @param $interface + * @param bool $queue + * @param bool $reason */ public function __construct($interface, $queue = false, $reason = false) { diff --git a/src/PAMI/Message/Action/UpdateConfigAction.php b/src/PAMI/Message/Action/UpdateConfigAction.php index 221a85a35..d207340be 100644 --- a/src/PAMI/Message/Action/UpdateConfigAction.php +++ b/src/PAMI/Message/Action/UpdateConfigAction.php @@ -43,6 +43,7 @@ */ class UpdateConfigAction extends ActionMessage { + /** @var int */ protected static $counter = -1; /** @@ -57,33 +58,33 @@ public function __construct() } /** - * Sets Src filename key. + * Sets source filename key. * - * @param string $filename. + * @param string $fileName. * * @return void */ - public function setSrcFilename($filename) + public function setSrcFilename($fileName) { - $this->setKey('SrcFilename', $filename); + $this->setKey('SrcFilename', $fileName); } /** - * Sets Dst Filename key. + * Sets destination Filename key. * - * @param string $filename. + * @param string $fileName. * * @return void */ - public function setDstFilename($filename) + public function setDstFilename($fileName) { - $this->setKey('DstFilename', $filename); + $this->setKey('DstFilename', $fileName); } /** * Sets Reload key. * - * @param string $input. + * @param string $reload. * * @return void */ @@ -113,9 +114,9 @@ public function setAction($input) * * @return void */ - public function setCat($input) + public function setCat($cat) { - $this->setKey('Cat-'.$this->getPaddedCounter(), $input); + $this->setKey('Cat-'.$this->getPaddedCounter(), $cat); } /** diff --git a/src/PAMI/Message/Action/VGSMSMSTxAction.php b/src/PAMI/Message/Action/VGSMSMSTxAction.php index 2a9d208d6..cc6cc59ee 100644 --- a/src/PAMI/Message/Action/VGSMSMSTxAction.php +++ b/src/PAMI/Message/Action/VGSMSMSTxAction.php @@ -109,13 +109,13 @@ public function setContent($content) /** * Sets X-SMS-Class key. Optional * - * @param string $sms_class Class of SMS to send. Values are 0, 1. 0 is Flash message. + * @param string $smsClass Class of SMS to send. Values are 0, 1. 0 is Flash message. * * @return void */ - public function setSmsClass($class) + public function setSmsClass($smsClass) { - $this->setKey('X-SMS-Class', $class); + $this->setKey('X-SMS-Class', $smsClass); } @@ -123,6 +123,7 @@ public function setSmsClass($class) * Sets X-SMS-Concatenate-RefID . Optional. Should be set with * setConcatSeqNum and setConcatSeqNum * + * @param $refid * @return void */ public function setConcatRefId($refid) @@ -134,17 +135,19 @@ public function setConcatRefId($refid) * Sets X-SMS-Concatenate-Sequence-Number. Optional. Should be set with * setConcatSeqNum: setConcatTotalMsg * + * @param $seqNum * @return void */ - public function setConcatSeqNum($seqnum) + public function setConcatSeqNum($seqNum) { - $this->setKey('X-SMS-Concatenate-Sequence-Number', $seqnum); + $this->setKey('X-SMS-Concatenate-Sequence-Number', $seqNum); } /** * Sets X-SMS-Concatenate-Total-Messages. Optional. Should be set with * setConcatRefId and setConcatSeqNum * + * @param $totalmsg * @return void */ public function setConcatTotalMsg($totalmsg) diff --git a/src/PAMI/Message/Message.php b/src/PAMI/Message/Message.php index bc8ed5317..dfdd0a1e9 100644 --- a/src/PAMI/Message/Message.php +++ b/src/PAMI/Message/Message.php @@ -179,6 +179,7 @@ public function getVariables() /** * Returns the end of message token appended to the end of a given message. * + * @param $message * @return string */ protected function finishMessage($message) From 6fcd3abc7a1fa3eac842127f0823e3323b31630c Mon Sep 17 00:00:00 2001 From: wizzle Date: Fri, 19 Jan 2018 17:39:07 +0300 Subject: [PATCH 10/11] increased coverage --- doc/PAMI-Message-Action-UpdateConfigAction.md | 2 +- test/events/Test_Events.php | 118 +++++++++++++++++- 2 files changed, 118 insertions(+), 2 deletions(-) diff --git a/doc/PAMI-Message-Action-UpdateConfigAction.md b/doc/PAMI-Message-Action-UpdateConfigAction.md index 445f75df3..859a92d7a 100644 --- a/doc/PAMI-Message-Action-UpdateConfigAction.md +++ b/doc/PAMI-Message-Action-UpdateConfigAction.md @@ -38,7 +38,7 @@ Properties ### $counter - protected mixed $counter = -1 + protected integer $counter = -1 diff --git a/test/events/Test_Events.php b/test/events/Test_Events.php index 00b11ca34..5c401b6e6 100644 --- a/test/events/Test_Events.php +++ b/test/events/Test_Events.php @@ -72,7 +72,7 @@ public function can_report_events() 'DongleSMSStatus', 'FullyBooted', 'DongleShowDevicesComplete', 'DongleDeviceEntry', 'DongleNewUSSDBase64', 'DongleNewUSSD', 'DongleUSSDStatus', 'DongleNewCUSD', 'DongleStatus', 'CEL', 'JabberEvent', 'Registry', 'UserEvent', - 'ParkedCall', 'UnParkedCall', 'Link', + 'ParkedCallGiveUp', 'ParkedCallTimeOut', 'ParkedCall', 'UnParkedCall', 'Link', 'AGIExecStart', 'AGIExecEnd', 'AsyncAGIStart', @@ -84,6 +84,7 @@ public function can_report_events() 'BlindTransfer', 'DialBegin', 'DialEnd', + 'DNDState', 'DTMFBegin', 'DTMFEnd', 'BridgeCreate', @@ -104,6 +105,7 @@ public function can_report_events() 'ConfbridgeListComplete', 'BridgeInfoChannel', 'BridgeInfoComplete', + 'QueueCallerAbandon', ); $eventTranslatedValues = array( 'QueueMemberStatus' => array( @@ -802,6 +804,70 @@ public function can_report_events() 'ParkingTimeout' => 'ParkingTimeout', 'ParkingDuration' => 'ParkingDuration', ), + 'ParkedCallGiveUp' => array( + 'Privilege' => 'Privilege', + 'ParkeeChannel' => 'ParkeeChannel', + 'ParkeeChannelState' => 'ParkeeChannelState', + 'ParkeeChannelStateDesc' => 'ParkeeChannelStateDesc', + 'ParkeeCallerIDNum' => 'ParkeeCallerIDNum', + 'ParkeeCallerIDName' => 'ParkeeCallerIDName', + 'ParkeeConnectedLineNum' => 'ParkeeConnectedLineNum', + 'ParkeeConnectedLineName' => 'ParkeeConnectedLineName', + 'ParkeeAccountCode' => 'ParkeeAccountCode', + 'ParkeeContext' => 'ParkeeContext', + 'ParkeeExten' => 'ParkeeExten', + 'ParkeePriority' => 'ParkeePriority', + 'ParkeeUniqueid' => 'ParkeeUniqueid', + 'ParkerChannel' => 'ParkerChannel', + 'ParkerChannelState' => 'ParkerChannelState', + 'ParkerChannelStateDesc' => 'ParkerChannelStateDesc', + 'ParkerCallerIDNum' => 'ParkerCallerIDNum', + 'ParkerCallerIDName' => 'ParkerCallerIDName', + 'ParkerConnectedLineNum' => 'ParkerConnectedLineNum', + 'ParkerConnectedLineName' => 'ParkerConnectedLineName', + 'ParkerAccountCode' => 'ParkerAccountCode', + 'ParkerContext' => 'ParkerContext', + 'ParkerExten' => 'ParkerExten', + 'ParkerPriority' => 'ParkerPriority', + 'ParkerUniqueid' => 'ParkerUniqueid', + 'ParkerDialString' => 'ParkerDialString', + 'Parkinglot' => 'Parkinglot', + 'ParkingSpace' => 'ParkingSpace', + 'ParkingTimeout' => 'ParkingTimeout', + 'ParkingDuration' => 'ParkingDuration', + ), + 'ParkedCallTimeOut' => array( + 'Privilege' => 'Privilege', + 'ParkeeChannel' => 'ParkeeChannel', + 'ParkeeChannelState' => 'ParkeeChannelState', + 'ParkeeChannelStateDesc' => 'ParkeeChannelStateDesc', + 'ParkeeCallerIDNum' => 'ParkeeCallerIDNum', + 'ParkeeCallerIDName' => 'ParkeeCallerIDName', + 'ParkeeConnectedLineNum' => 'ParkeeConnectedLineNum', + 'ParkeeConnectedLineName' => 'ParkeeConnectedLineName', + 'ParkeeAccountCode' => 'ParkeeAccountCode', + 'ParkeeContext' => 'ParkeeContext', + 'ParkeeExten' => 'ParkeeExten', + 'ParkeePriority' => 'ParkeePriority', + 'ParkeeUniqueid' => 'ParkeeUniqueid', + 'ParkerChannel' => 'ParkerChannel', + 'ParkerChannelState' => 'ParkerChannelState', + 'ParkerChannelStateDesc' => 'ParkerChannelStateDesc', + 'ParkerCallerIDNum' => 'ParkerCallerIDNum', + 'ParkerCallerIDName' => 'ParkerCallerIDName', + 'ParkerConnectedLineNum' => 'ParkerConnectedLineNum', + 'ParkerConnectedLineName' => 'ParkerConnectedLineName', + 'ParkerAccountCode' => 'ParkerAccountCode', + 'ParkerContext' => 'ParkerContext', + 'ParkerExten' => 'ParkerExten', + 'ParkerPriority' => 'ParkerPriority', + 'ParkerUniqueid' => 'ParkerUniqueid', + 'ParkerDialString' => 'ParkerDialString', + 'Parkinglot' => 'Parkinglot', + 'ParkingSpace' => 'ParkingSpace', + 'ParkingTimeout' => 'ParkingTimeout', + 'ParkingDuration' => 'ParkingDuration', + ), 'UnParkedCall' => array( 'Privilege' => 'Privilege', 'Parkinglot' => 'Parkinglot', @@ -864,6 +930,7 @@ public function can_report_events() 'Channel2' => 'Channel2' ), 'AGIExecStart' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -880,6 +947,7 @@ public function can_report_events() 'CommandId' => 'CommandId', ), 'AGIExecEnd' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -898,6 +966,7 @@ public function can_report_events() 'Result' => 'Result', ), 'AsyncAGIStart' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -913,6 +982,7 @@ public function can_report_events() 'Env' => 'Env', ), 'AsyncAGIExec' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -929,6 +999,7 @@ public function can_report_events() 'Result' => 'Result', ), 'AsyncAGIEnd' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -943,6 +1014,7 @@ public function can_report_events() 'Uniqueid' => 'Uniqueid', ), 'QueueCallerJoin' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -960,6 +1032,7 @@ public function can_report_events() 'Count' => 'Count', ), 'QueueCallerLeave' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -976,6 +1049,25 @@ public function can_report_events() 'Count' => 'Count', 'Position' => 'Position', ), + 'QueueCallerAbandon' => array( + 'Privilege' => 'Privilege', + 'Channel' => 'Channel', + 'ChannelState' => 'ChannelState', + 'ChannelStateDesc' => 'ChannelStateDesc', + 'CallerIDNum' => 'CallerIDNum', + 'CallerIDName' => 'CallerIDName', + 'ConnectedLineNum' => 'ConnectedLineNum', + 'ConnectedLineName' => 'ConnectedLineName', + 'AccountCode' => 'AccountCode', + 'Context' => 'Context', + 'Exten' => 'Exten', + 'Priority' => 'Priority', + 'UniqueID' => 'UniqueID', + 'Queue' => 'Queue', + 'Position' => 'Position', + 'OriginalPosition' => 'OriginalPosition', + 'HoldTime' => 'HoldTime', + ), 'AttendedTransfer' => array( 'Result' => 'Result', 'OrigTransfererChannel' => 'OrigTransfererChannel', @@ -1056,6 +1148,7 @@ public function can_report_events() 'TransfereeUniqueid' => 'TransfereeUniqueid', ), 'BlindTransfer' => array( + 'Privilege' => 'Privilege', 'Result' => 'Result', 'TransfererChannel' => 'TransfererChannel', 'TransfererChannelState' => 'TransfererChannelState', @@ -1092,6 +1185,7 @@ public function can_report_events() 'Extension' => 'Extension', ), 'DialBegin' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -1116,9 +1210,11 @@ public function can_report_events() 'DestExten' => 'DestExten', 'DestPriority' => 'DestPriority', 'DestUniqueid' => 'DestUniqueid', + 'DialStatus' => 'DialStatus', 'DialString' => 'DialString', ), 'DialEnd' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -1145,7 +1241,13 @@ public function can_report_events() 'DestUniqueid' => 'DestUniqueid', 'DialStatus' => 'DialStatus', ), + 'DNDState' => array( + 'Privilege' => 'Privilege', + 'DAHDIChannel' => 'DAHDIChannel', + 'Status' => 'Status', + ), 'DTMFBegin' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -1162,6 +1264,7 @@ public function can_report_events() 'Direction' => 'Direction', ), 'DTMFEnd' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -1179,6 +1282,7 @@ public function can_report_events() 'Direction' => 'Direction', ), 'BridgeCreate' => array( + 'Privilege' => 'Privilege', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', 'BridgeTechnology' => 'BridgeTechnology', @@ -1187,6 +1291,7 @@ public function can_report_events() 'BridgeNumChannels' => 'BridgeNumChannels', ), 'BridgeDestroy' => array( + 'Privilege' => 'Privilege', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', 'BridgeTechnology' => 'BridgeTechnology', @@ -1195,6 +1300,7 @@ public function can_report_events() 'BridgeNumChannels' => 'BridgeNumChannels', ), 'BridgeEnter' => array( + 'Privilege' => 'Privilege', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', 'BridgeTechnology' => 'BridgeTechnology', @@ -1216,6 +1322,7 @@ public function can_report_events() 'SwapUniqueid' => 'SwapUniqueid', ), 'BridgeLeave' => array( + 'Privilege' => 'Privilege', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', 'BridgeTechnology' => 'BridgeTechnology', @@ -1245,6 +1352,7 @@ public function can_report_events() 'BridgeVideoSourceMode' => 'BridgeVideoSourceMode', ), 'MusicOnHoldStart' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -1260,6 +1368,7 @@ public function can_report_events() 'Class' => 'Class', ), 'MusicOnHoldStop' => array( + 'Privilege' => 'Privilege', 'Channel' => 'Channel', 'ChannelState' => 'ChannelState', 'ChannelStateDesc' => 'ChannelStateDesc', @@ -1274,6 +1383,7 @@ public function can_report_events() 'Uniqueid' => 'Uniqueid', ), 'ConfbridgeStart' => array( + 'Privilege' => 'Privilege', 'Conference' => 'Conference', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', @@ -1283,6 +1393,7 @@ public function can_report_events() 'BridgeNumChannels' => 'BridgeNumChannels', ), 'ConfbridgeEnd' => array( + 'Privilege' => 'Privilege', 'Conference' => 'Conference', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', @@ -1292,6 +1403,7 @@ public function can_report_events() 'BridgeNumChannels' => 'BridgeNumChannels', ), 'ConfbridgeJoin' => array( + 'Privilege' => 'Privilege', 'Conference' => 'Conference', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', @@ -1315,6 +1427,7 @@ public function can_report_events() 'Admin' => 'Admin', ), 'ConfbridgeLeave' => array( + 'Privilege' => 'Privilege', 'Conference' => 'Conference', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', @@ -1338,6 +1451,7 @@ public function can_report_events() 'Admin' => 'Admin', ), 'ConfbridgeMute' => array( + 'Privilege' => 'Privilege', 'Conference' => 'Conference', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', @@ -1361,6 +1475,7 @@ public function can_report_events() 'Admin' => 'Admin', ), 'ConfbridgeUnmute' => array( + 'Privilege' => 'Privilege', 'Conference' => 'Conference', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', @@ -1384,6 +1499,7 @@ public function can_report_events() 'Admin' => 'Admin', ), 'ConfbridgeTalking' => array( + 'Privilege' => 'Privilege', 'Conference' => 'Conference', 'BridgeUniqueid' => 'BridgeUniqueid', 'BridgeType' => 'BridgeType', From 84709b1cc68faf7d736a637bb4843ebd3a9db282 Mon Sep 17 00:00:00 2001 From: wizzle Date: Mon, 22 Jan 2018 11:58:41 +0300 Subject: [PATCH 11/11] Added new action PJSIPShowEndpoints, events which generated by this action and tests for it. --- doc/ApiIndex.md | 3 + ...Message-Action-PJSIPShowEndpointsAction.md | 314 +++++++++++ ...Message-Event-EndpointListCompleteEvent.md | 402 ++++++++++++++ doc/PAMI-Message-Event-EndpointListEvent.md | 493 ++++++++++++++++++ .../Action/PJSIPShowEndpointsAction.php | 59 +++ .../Event/EndpointListCompleteEvent.php | 55 ++ src/PAMI/Message/Event/EndpointListEvent.php | 137 +++++ test/actions/Test_Actions.php | 14 + test/events/Test_Events.php | 13 + 9 files changed, 1490 insertions(+) create mode 100644 doc/PAMI-Message-Action-PJSIPShowEndpointsAction.md create mode 100644 doc/PAMI-Message-Event-EndpointListCompleteEvent.md create mode 100644 doc/PAMI-Message-Event-EndpointListEvent.md create mode 100644 src/PAMI/Message/Action/PJSIPShowEndpointsAction.php create mode 100644 src/PAMI/Message/Event/EndpointListCompleteEvent.php create mode 100644 src/PAMI/Message/Event/EndpointListEvent.php diff --git a/doc/ApiIndex.md b/doc/ApiIndex.md index 845f9fade..103d884e7 100644 --- a/doc/ApiIndex.md +++ b/doc/ApiIndex.md @@ -60,6 +60,7 @@ API Index * [DongleResetAction](PAMI-Message-Action-DongleResetAction.md) * [GetConfigAction](PAMI-Message-Action-GetConfigAction.md) * [DAHDIShowChannelsAction](PAMI-Message-Action-DAHDIShowChannelsAction.md) + * [PJSIPShowEndpointsAction](PAMI-Message-Action-PJSIPShowEndpointsAction.md) * [ReloadAction](PAMI-Message-Action-ReloadAction.md) * [RedirectAction](PAMI-Message-Action-RedirectAction.md) * [DongleReloadAction](PAMI-Message-Action-DongleReloadAction.md) @@ -176,6 +177,7 @@ API Index * [VoicemailUserEntryCompleteEvent](PAMI-Message-Event-VoicemailUserEntryCompleteEvent.md) * [QueueMemberStatusEvent](PAMI-Message-Event-QueueMemberStatusEvent.md) * [DTMFEvent](PAMI-Message-Event-DTMFEvent.md) + * [EndpointListEvent](PAMI-Message-Event-EndpointListEvent.md) * [UnlinkEvent](PAMI-Message-Event-UnlinkEvent.md) * [StatusCompleteEvent](PAMI-Message-Event-StatusCompleteEvent.md) * [ConfbridgeStartEvent](PAMI-Message-Event-ConfbridgeStartEvent.md) @@ -215,6 +217,7 @@ API Index * [MusicOnHoldEvent](PAMI-Message-Event-MusicOnHoldEvent.md) * [BridgeLeaveEvent](PAMI-Message-Event-BridgeLeaveEvent.md) * [ConfbridgeTalkingEvent](PAMI-Message-Event-ConfbridgeTalkingEvent.md) + * [EndpointListCompleteEvent](PAMI-Message-Event-EndpointListCompleteEvent.md) * [QueueMemberEvent](PAMI-Message-Event-QueueMemberEvent.md) * [QueueSummaryEvent](PAMI-Message-Event-QueueSummaryEvent.md) * [BridgeListItemEvent](PAMI-Message-Event-BridgeListItemEvent.md) diff --git a/doc/PAMI-Message-Action-PJSIPShowEndpointsAction.md b/doc/PAMI-Message-Action-PJSIPShowEndpointsAction.md new file mode 100644 index 000000000..a92d47333 --- /dev/null +++ b/doc/PAMI-Message-Action-PJSIPShowEndpointsAction.md @@ -0,0 +1,314 @@ +PAMI\Message\Action\PJSIPShowEndpointsAction +=============== + +Lists PJSIP endpoints. + +Provides a listing of all endpoints. For each endpoint an 'EndpointList' +event is raised that contains relevant attributes and status information. +Once all endpoints have been listed an 'EndpointListComplete' event is issued. + +PHP Version 5 + + +* Class name: PJSIPShowEndpointsAction +* Namespace: PAMI\Message\Action +* Parent class: [PAMI\Message\Action\ActionMessage](PAMI-Message-Action-ActionMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $lines + + protected array $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> + + + +### __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> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-EndpointListCompleteEvent.md b/doc/PAMI-Message-Event-EndpointListCompleteEvent.md new file mode 100644 index 000000000..9f7d7328b --- /dev/null +++ b/doc/PAMI-Message-Event-EndpointListCompleteEvent.md @@ -0,0 +1,402 @@ +PAMI\Message\Event\EndpointListCompleteEvent +=============== + +Provide final information about an endpoint list. + +PHP Version 5 + + +* Class name: EndpointListCompleteEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getListItems + + string PAMI\Message\Event\EndpointListCompleteEvent::getListItems() + +Shows count of returned items. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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-Event-EndpointListEvent.md b/doc/PAMI-Message-Event-EndpointListEvent.md new file mode 100644 index 000000000..47e73d7f4 --- /dev/null +++ b/doc/PAMI-Message-Event-EndpointListEvent.md @@ -0,0 +1,493 @@ +PAMI\Message\Event\EndpointListEvent +=============== + +Provide details about a contact's status. + +PHP Version 5 + + +* Class name: EndpointListEvent +* Namespace: PAMI\Message\Event +* Parent class: [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + +Constants +---------- + + +### EOL + + const EOL = "\r\n" + + + + + +### EOM + + const EOM = "\r\n\r\n" + + + + + +Properties +---------- + + +### $rawContent + + protected string $rawContent + +Holds original message. + + + +* Visibility: **protected** + + +### $channelVariables + + protected array $channelVariables + +Metadata. Specific channel variables. + + + +* Visibility: **protected** + + +### $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 +------- + + +### getObjectType + + string PAMI\Message\Event\EndpointListEvent::getObjectType() + +The object's type. This will always be 'endpoint'. + + + +* Visibility: **public** + + + + +### getObjectName + + string PAMI\Message\Event\EndpointListEvent::getObjectName() + +The name of this object. + + + +* Visibility: **public** + + + + +### getTransport + + string PAMI\Message\Event\EndpointListEvent::getTransport() + +The transport configurations associated with this endpoint. + + + +* Visibility: **public** + + + + +### getAor + + string PAMI\Message\Event\EndpointListEvent::getAor() + +The aor configurations associated with this endpoint. + + + +* Visibility: **public** + + + + +### getAuths + + string PAMI\Message\Event\EndpointListEvent::getAuths() + +The inbound authentication configurations associated with this endpoint. + + + +* Visibility: **public** + + + + +### getOutboundAuths + + string PAMI\Message\Event\EndpointListEvent::getOutboundAuths() + +The outbound authentication configurations associated with this endpoint. + + + +* Visibility: **public** + + + + +### getDeviceState + + string PAMI\Message\Event\EndpointListEvent::getDeviceState() + +The aggregate device state for this endpoint. + + + +* Visibility: **public** + + + + +### getActiveChannels + + string PAMI\Message\Event\EndpointListEvent::getActiveChannels() + +The number of active channels associated with this endpoint. + + + +* Visibility: **public** + + + + +### getName + + string PAMI\Message\Event\EventMessage::getName() + +Returns key 'Event'. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Event\EventMessage](PAMI-Message-Event-EventMessage.md) + + + + +### __sleep + + array PAMI\Message\Message::__sleep() + +Serialize function. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getEventList + + string PAMI\Message\IncomingMessage::getEventList() + +Returns key 'EventList'. In respones, this will surely be a "start". In +events, should be a "complete". + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getRawContent + + string PAMI\Message\IncomingMessage::getRawContent() + +Returns the original message content without parsing. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getAllChannelVariables + + array PAMI\Message\IncomingMessage::getAllChannelVariables() + +Returns the channel variables for all reported channels. + +https://github.com/marcelog/PAMI/issues/85 + +The channel names will be lowercased. + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + + + +### getChannelVariables + + array PAMI\Message\IncomingMessage::getChannelVariables(string $channel) + +Returns the channel variables for the given channel. + +https://github.com/marcelog/PAMI/issues/85 + +* Visibility: **public** +* This method is defined by [PAMI\Message\IncomingMessage](PAMI-Message-IncomingMessage.md) + + +#### Arguments +* $channel **string** - <p>Channel name. If not given, will return variables +for the "current" channel.</p> + + + +### __construct + + void PAMI\Message\Message::__construct() + +Constructor. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### getCreatedDate + + integer PAMI\Message\Message::getCreatedDate() + +Returns created date. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + + + +### setVariable + + void PAMI\Message\Message::setVariable(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> +* $value **string** - <p>Variable value.</p> + + + +### getVariable + + string PAMI\Message\Message::getVariable(string $key) + +Returns a variable by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Variable name.</p> + + + +### setKey + + void PAMI\Message\Message::setKey(string $key, string $value) + +Adds a variable to this message. + + + +* Visibility: **protected** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> +* $value **string** - <p>Key value.</p> + + + +### getKey + + string PAMI\Message\Message::getKey(string $key) + +Returns a key by name. + + + +* Visibility: **public** +* This method is defined by [PAMI\Message\Message](PAMI-Message-Message.md) + + +#### Arguments +* $key **string** - <p>Key name (i.e: Action).</p> + + + +### getKeys + + array 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/src/PAMI/Message/Action/PJSIPShowEndpointsAction.php b/src/PAMI/Message/Action/PJSIPShowEndpointsAction.php new file mode 100644 index 000000000..da57e70f6 --- /dev/null +++ b/src/PAMI/Message/Action/PJSIPShowEndpointsAction.php @@ -0,0 +1,59 @@ + + * @license http://marcelog.github.com/PAMI/ Apache License 2.0 + * @version SVN: $Id$ + * @link http://marcelog.github.com/PAMI/ + * + * Copyright 2011 Marcelo Gornstein + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +namespace PAMI\Message\Action; + +/** + * Lists PJSIP endpoints. + * + * Provides a listing of all endpoints. For each endpoint an 'EndpointList' + * event is raised that contains relevant attributes and status information. + * Once all endpoints have been listed an 'EndpointListComplete' event is issued. + * + * PHP Version 5 + * + * @category Pami + * @package Message + * @subpackage Action + * @author Maxim Dorofeev + * @license http://marcelog.github.com/PAMI/ Apache License 2.0 + * @link http://marcelog.github.com/PAMI/ + */ +class PJSIPShowEndpointsAction extends ActionMessage +{ + /** + * Constructor. + * + * @return void + */ + public function __construct() + { + parent::__construct('PJSIPShowEndpoints'); + } +} diff --git a/src/PAMI/Message/Event/EndpointListCompleteEvent.php b/src/PAMI/Message/Event/EndpointListCompleteEvent.php new file mode 100644 index 000000000..73890a844 --- /dev/null +++ b/src/PAMI/Message/Event/EndpointListCompleteEvent.php @@ -0,0 +1,55 @@ + + * @license http://marcelog.github.com/PAMI/ Apache License 2.0 + * @version SVN: $Id$ + * @link http://marcelog.github.com/PAMI/ + * + * Copyright 2011 Marcelo Gornstein + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +namespace PAMI\Message\Event; + +/** + * Provide final information about an endpoint list. + * + * PHP Version 5 + * + * @category Pami + * @package Message + * @subpackage Event + * @author Marcelo Gornstein + * @license http://marcelog.github.com/PAMI/ Apache License 2.0 + * @link http://marcelog.github.com/PAMI/ + */ +class EndpointListCompleteEvent extends EventMessage +{ + /** + * Shows count of returned items. + * + * @return string key: 'ListItems'. + */ + public function getListItems() + { + return $this->getKey('ListItems'); + } +} diff --git a/src/PAMI/Message/Event/EndpointListEvent.php b/src/PAMI/Message/Event/EndpointListEvent.php new file mode 100644 index 000000000..5dd7fe0ee --- /dev/null +++ b/src/PAMI/Message/Event/EndpointListEvent.php @@ -0,0 +1,137 @@ + + * @license http://marcelog.github.com/PAMI/ Apache License 2.0 + * @version SVN: $Id$ + * @link http://marcelog.github.com/PAMI/ + * + * Copyright 2011 Marcelo Gornstein + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +namespace PAMI\Message\Event; + +/** + * Provide details about a contact's status. + * + * PHP Version 5 + * + * @category Pami + * @package Message + * @subpackage Event + * @author Maxim Dorofeev + * @license http://marcelog.github.com/PAMI/ Apache License 2.0 + * @link http://marcelog.github.com/PAMI/ + */ +class EndpointListEvent extends EventMessage +{ + /** + * ObjectType: + ObjectName: + Transport: + Aor: + Auths: + OutboundAuths: + DeviceState: + ActiveChannels: + */ + + + /** + * The object's type. This will always be 'endpoint'. + * + * @return string key: 'ObjectType' + */ + public function getObjectType() + { + return $this->getKey('ObjectType'); + } + + /** + * The name of this object. + * + * @return string key: 'ObjectName'. + */ + public function getObjectName() + { + return $this->getKey('ObjectName'); + } + + /** + * The transport configurations associated with this endpoint. + * + * @return string key: 'Transport'. + */ + public function getTransport() + { + return $this->getKey('Transport'); + } + + /** + * The aor configurations associated with this endpoint. + * + * @return string key: 'Aor'. + */ + public function getAor() + { + return $this->getKey('Aor'); + } + + /** + * The inbound authentication configurations associated with this endpoint. + * + * @return string key: 'Auths'. + */ + public function getAuths() + { + return $this->getKey('Auths'); + } + + /** + * The outbound authentication configurations associated with this endpoint. + * + * @return string key: 'OutboundAuths'. + */ + public function getOutboundAuths() + { + return $this->getKey('OutboundAuths'); + } + + /** + * The aggregate device state for this endpoint. + * + * @return string key: 'DeviceState'. + */ + public function getDeviceState() + { + return $this->getKey('DeviceState'); + } + + /** + * The number of active channels associated with this endpoint. + * + * @return string key: 'ActiveChannels'. + */ + public function getActiveChannels() + { + return $this->getKey('ActiveChannels'); + } +} diff --git a/test/actions/Test_Actions.php b/test/actions/Test_Actions.php index 4194358ab..12dca979a 100644 --- a/test/actions/Test_Actions.php +++ b/test/actions/Test_Actions.php @@ -1727,5 +1727,19 @@ public function can_update_config() $client = $this->_start($writeDelete, $actionDelete); } + + /** + * @test + */ + public function can_pjsip_show_endpoints() + { + $write = array(implode("\r\n", array( + 'action: PJSIPShowEndpoints', + 'actionid: 1432.123', + '' + ))); + $action = new \PAMI\Message\Action\PJSIPShowEndpointsAction(); + $client = $this->_start($write, $action); + } } } diff --git a/test/events/Test_Events.php b/test/events/Test_Events.php index 5c401b6e6..60e9140e2 100644 --- a/test/events/Test_Events.php +++ b/test/events/Test_Events.php @@ -106,6 +106,8 @@ public function can_report_events() 'BridgeInfoChannel', 'BridgeInfoComplete', 'QueueCallerAbandon', + 'EndpointList', + 'EndpointListComplete', ); $eventTranslatedValues = array( 'QueueMemberStatus' => array( @@ -1562,6 +1564,17 @@ public function can_report_events() 'BridgeVideoSourceMode' => 'BridgeVideoSourceMode', 'BridgeVideoSource' => 'BridgeVideoSource', ), + 'EndpointList' => array( + 'ObjectType' => 'ObjectType', + 'ObjectName' => 'ObjectName', + 'Transport' => 'Transport', + 'Aor' => 'Aor', + 'Auths' => 'Auths', + 'OutboundAuths' => 'OutboundAuths', + 'DeviceState' => 'DeviceState', + 'ActiveChannels' => 'ActiveChannels', + ), + 'EndpointListComplete' => array('ListItems' => 'ListItems'), ); $eventGetters = array( 'UserEvent' => array(