Docs For Class Shift8

Class Shift8

Description

Main class responsible for the entire communications between Asterisk Manager interfaces and a PHP application.

author: Paris Stamatopoulos
version: 0.1.1
uses: Shift8_Exception
uses: Shift8_Queue_Processor
uses: Shift8_Event_Listener
uses: Shift8_Queue_Item
uses: Shift8_Event_Filter
uses: Shift8_Debug_Listener
uses: Shift8_Event
uses: Shift8_Event_Filter_Dummy

Located in /Shift8.php (line 52)

Class Constant Summary

VERSION = '0.1.1'

Method Summary

static boolean compareVersion (string $version)

static string getVersion ()

Shift8 __construct ([string $ajam = false], [string $manager = false], [string $secret = false], [Shift8_Event_Listener $eventListener = false], [Shift8_Debug_Listener $debugListener = false])

integer addCommandToQueue (string $command, array $arguments)

boolean addDebugListener (string $name, Shift8_Debug_Listener $listener)

boolean addEventListener (string $name, Shift8_Event_Listener $listener, [Shift8_Event_Filter $filter = false])

boolean addQueueLog (string $queue, integer $unique_id, string $interface, string $event, string $message)

boolean AGI (string $channel, string $command, string $command_id)

boolean allowCommandToBeQueued (string $command)

boolean attendedTransfer (string $channel, string $exten, string $context, integer $priority)

boolean bridge (string $channelA, string $channelB, [string|boolean $tone = false])

Shift8_Event[] challenge ()

boolean changeMonitor (string $channel, string $file)

boolean changeQueuePaused ( $interface, integer $paused, string $inteface)

boolean createConfigurationFile (string $filename)

boolean DBDel (string $family, string $key)

boolean DBDelTree (string $family, [string|boolean $key = false])

Shift8_Event[] DBGet (string $family, string $key)

boolean DBPut (string $family, string $key, [string|boolean $value = false])

boolean disallowCommandToBeQueued (string $command)

boolean events (string $eventMask)

Shift8_Event[] executeCommand (string $command)

Shift8_Event[] getActiveChannels ()

Shift8_Event[] getAgents ()

Shift8_Event[] getChannelVariable (string $variable, [string $channel = false])

Shift8_Event[] getConfig (string $filename, [string $category = false])

Shift8_Event[] getConfigJson (string $filename)

string getCookie ()

Shift8_Event[] getCoreSettings ()

Shift8_Event[] getCoreStatusVariables ()

Shift8_Event[] getDialplan ()

Shift8_Event[] getExtensionState (string $exten, string $context)

Shift8_Event[] getIAXNetStats ()

Shift8_Event[] getIAXPeerList ()

Shift8_Event[] getIAXPeers ()

string getLastError ()

integer getMailboxCount (string $mailbox)

Shift8_Event[] getMailboxStatus (string $mailbox)

Shift8_Event[] getParkedCalls ()

Shift8_Event[] getQueuedCommandResponse (integer $queue_id)

Shift8_Queue_Processor getQueueProcessor ()

Shift8_Event[] getQueueRule (string $rule)

Shift8_Event[] getQueues ()

Shift8_Event[] getQueueStatus ([string $queue = false], [string $member = false])

Shift8_Event[] getQueueSummary ([string $queue = false])

Shift8_Event getSipPeer (string $peer)

Shift8_Event[] getSipPeers ()

Shift8_Event[] getSipRegistry ()

Shift8_Event[] getStatus ([string $channel = false], [string $variables = false])

Shift8_Event[] getVoicemailUsers ()

boolean hangup (string $channel)

boolean isModuleLoaded (string $module)

Shift8_Event[] listCategories (string $filename)

Shift8_Event[] listCommands ()

boolean loadModule ([boolean|string $module = false], [string $loadType = 'reload'])

boolean login ([string $ajam = false], [string $manager = false], [string $secret = false])

boolean logoff ()

boolean monitor (string $channel, [string $file = false], [string $format = false], [boolean $mix = false])

boolean notifyDebugListeners (mixed $message)

boolean notifyEventListeners (Shift8_Event $event)

boolean originate (string $channel, [string $exten = false], [string $context = false], [string $priority = false], [string $application = false], [string $data = false], [string $timeout = 30000], [string $callerID = false], [string $variable = false], [string $account = false], [string $async = true], [string $codecs = false])

boolean park (string $channelA, string $channelB, [integer|boolean $timeout = false])

boolean pauseMonitor (string $channel)

boolean pauseQueueInterface (string $interface)

boolean ping ()

boolean playDTMF (string $dtmf, string $channel)

boolean processCommandQueue ()

Shift8_Event[] processEvents (SimpleXMLElement $events)

SimpleXMLElement proxy (string $url, array $parameters)

boolean queueAddInterface (string $queue, string $interface, [string $member = false], [int $penalty = 0], [boolean $paused = false])

boolean queueRemoveInterface (string $queue, string $interface)

boolean redirect (string $channel, [string $extraChannel = false], string $exten, string $context, integer $priority)

boolean reload ()

boolean removeDebugListener (string $name)

boolean removeEventListener (string $name)

boolean sendMessageToJabberChannel (string $jabber, string $screenName, string $message)

boolean sendText (string $channel, string $message)

boolean sendUserEvent (string $userEvent)

boolean sentSIPNotify (string $channel)

boolean setAbsoluteTimeout (string $channel, integer $timeout)

Shift8_Event[] setChannelVariable (string $variable, string $value, [string $channel = false])

void setCookie (string $cookie)

void setLastError (SimpleXMLElement $message)

boolean setQueueMemberPenalty (string $member, string $queue, integer $penalty)

void setQueueProcessor (Shift8_Queue_Processor $processor)

boolean stopMonitor (string $channel)

void transfer ( $channel, [ $extraChannel = false], $exten, $context, $priority)

boolean unpauseMonitor (string $channel)

boolean unpauseQueueInterface (string $interface)

Shift8_Event[] waitEvent ()

Methods

static method compareVersion (line 2244)

Compare the specified Shift8 version string $version with the current version of Shift8. Function taken from Zend Framework

return: -1 if the $version is older, 0 if they are the same and +1 if $version is newer.
access: public

static boolean compareVersion (string $version)

string $version: A version string (e.g. "0.7.1").

static method getVersion (line 2232)

Returns the version of the Shift8 library

access: public

static string getVersion ()

Constructor __construct (line 81)

Class constructor.

All variables are optional and can be passed to the Login() call

see: Login
access: public

Shift8 __construct ([string $ajam = false], [string $manager = false], [string $secret = false], [Shift8_Event_Listener $eventListener = false], [Shift8_Debug_Listener $debugListener = false])

string $ajam: The remote ajam interface.
string $manager: The username of the manager to login
string $secret: The password of the manager
Shift8_Event_Listener $eventListener: Adds an event listener to this instance of the Shift8 with name 'default'
Shift8_Debug_Listener $debugListener: Adds a debug listener to this instance of the Shift8 with name 'default'

addCommandToQueue (line 227)

Adds a new command to the queue of commands to be executed on the remote asterisk server.

return: Returns the id in the queue
throws: Shift8_Exception if the command specified cannot be queued.
access: public

integer addCommandToQueue (string $command, array $arguments)

string $command
array $arguments

addDebugListener (line 178)

Adds a debug listener.

throws: Shift8_Exception if the listener specified is not of type Shift8_Debug_Listener
access: public

boolean addDebugListener (string $name, Shift8_Debug_Listener $listener)

string $name
Shift8_Debug_Listener $listener

addEventListener (line 110)

Adds a new event listener to the library. The listener is defined by the name specified. If the name passed already exists on the system, the listener will not be added.

throws: Shift8_Exception Throws exception if the listener/filter specified is invalid
access: public

boolean addEventListener (string $name, Shift8_Event_Listener $listener, [Shift8_Event_Filter $filter = false])

string $name
Shift8_Event_Listener $listener
Shift8_Event_Filter $filter

addQueueLog (line 601)

Allows you to write your own events into the queue log

access: public

boolean addQueueLog (string $queue, integer $unique_id, string $interface, string $event, string $message)

string $queue: The queue to write the event for
integer $unique_id: The unique id for the queue log
string $interface: The interface for the log
string $event: The actual event that needs to be recorded
string $message: The message to log in the queue log

AGI (line 1011)

Add a new command to execute by the Async AGI application

access: public

boolean AGI (string $channel, string $command, string $command_id)

string $channel: The channel to execute the command at
string $command: The command to execute
string $command_id: The command id

allowCommandToBeQueued (line 327)

Allow command to be queued.

access: public

boolean allowCommandToBeQueued (string $command)

string $command: The command to be allowed

attendedTransfer (line 1701)

Attended transfer

access: public

boolean attendedTransfer (string $channel, string $exten, string $context, integer $priority)

string $channel
string $exten
string $context
integer $priority

bridge (line 1153)

Bridge channels together

access: public

boolean bridge (string $channelA, string $channelB, [string|boolean $tone = false])

string $channelA: The first channel to bridge
string $channelB: The second channel to bridge
string|boolean $tone: Play a tone to the bridged channels. Not required

challenge (line 1975)

Generate Challenge for MD5 Auth

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] challenge ()

changeMonitor (line 897)

Change monitoring filename of a channel. Has no effect if the channel is not monitored

access: public

boolean changeMonitor (string $channel, string $file)

string $channel: Used to specify the channel to record
string $file: Is the new name of the file created in the monitor spool directory

changeQueuePaused (line 405)

Changes the paused status of an interface.

access: protected

boolean changeQueuePaused ( $interface, integer $paused, string $inteface)

string $inteface: The interface to change the status
integer $paused: The paused value. 1 for Paused, 0 for Unpaused
$interface

createConfigurationFile (line 1795)

A 'CreateConfig' action will create an empty file in the configuration directory.

This action is intended to be used before an UpdateConfig action.

access: public

boolean createConfigurationFile (string $filename)

string $filename: The filename to create

DBDel (line 1065)

Removes database key/value

access: public

boolean DBDel (string $family, string $key)

string $family
string $key

DBDelTree (line 1038)

Removes database keytree/values

access: public

boolean DBDelTree (string $family, [string|boolean $key = false])

string $family
string|boolean $key

DBGet (line 1093)

Gets a database value

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] DBGet (string $family, string $key)

string $family
string $key

DBPut (line 1123)

Adds / updates a database value

access: public

boolean DBPut (string $family, string $key, [string|boolean $value = false])

string $family
string $key
string|boolean $value

disallowCommandToBeQueued (line 313)

Disallow a command from being queued

access: public

boolean disallowCommandToBeQueued (string $command)

string $command: The command to disallow

events (line 1999)

Enable/Disable sending of events to this manager client.

access: public

boolean events (string $eventMask)

string $eventMask: The event mask to apply to this manager client

executeCommand (line 1583)

Run a CLI command

access: public

Shift8_Event[] executeCommand (string $command)

string $command: Asterisk CLI command to run

getActiveChannels (line 1305)

List currently defined channels and some information about them.

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getActiveChannels ()

getAgents (line 500)

Lists agents and their status

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getAgents ()

getChannelVariable (line 1901)

Get the value of a global or local channel variable

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getChannelVariable (string $variable, [string $channel = false])

string $variable: Variable name
string $channel: Channel to read variable from

getConfig (line 1874)

A 'GetConfig' action will dump the contents of a configuration file by category and contents or optionally by specified category only

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getConfig (string $filename, [string $category = false])

string $filename: Configuration filename (e.g. foo.conf)
string $category: Category in configuration file

getConfigJson (line 1849)

A 'GetConfigJSON' action will dump the contents of a configuration file by category and contents in JSON format.

This only makes sense to be used using rawman over the HTTP interface.

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getConfigJson (string $filename)

string $filename: Configuration filename (e.g. foo.conf)

getCookie (line 2212)

Retrieves the asterisk cookie.

This can be used to set the cookie value to a PHP session so as to establish a permanent connection between a web application and the Asterisk AJAM interface. Don't forget to close the session since php sessions are locking

access: public

string getCookie ()

getCoreSettings (line 1369)

Show PBX core settings information

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getCoreSettings ()

getCoreStatusVariables (line 1348)

Show PBX core status information

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getCoreStatusVariables ()

getDialplan (line 1228)

Show dialplan extensions

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getDialplan ()

getExtensionState (line 1558)

Report the extension state for given extension. If the extension has a hint, will use devicestate to check the status of the device connected to the extension.

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getExtensionState (string $exten, string $context)

string $exten: Extension to check state on
string $context: Context for extension

getIAXNetStats (line 825)

Retrieve the IAX Net stats

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getIAXNetStats ()

getIAXPeerList (line 804)

Retrieves the IAX Peers from the remote asterisk server

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getIAXPeerList ()

getIAXPeers (line 783)

Retrieves the IAX Peers from the remote asterisk server

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getIAXPeers ()

getLastError (line 2264)

Returns the last error that has occurred in the communication with the remote asterisk

access: public

string getLastError ()

getMailboxCount (line 1484)

Checks a voicemail account for new messages.

todo: - Fix this to return a number
access: public

integer getMailboxCount (string $mailbox)

string $mailbox: Full mailbox ID <mailbox>@<vm-context>

getMailboxStatus (line 1508)

Checks a voicemail account for status

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getMailboxStatus (string $mailbox)

string $mailbox: Full mailbox ID <mailbox>@<vm-context>

getParkedCalls (line 1207)

List parked calls

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getParkedCalls ()

getQueuedCommandResponse (line 274)

Retrieve the result from a queued command

return: or null in case nothing was found
access: public

Shift8_Event[] getQueuedCommandResponse (integer $queue_id)

integer $queue_id

getQueueProcessor (line 302)

Returns the active queue processor.

access: public

Shift8_Queue_Processor getQueueProcessor ()

getQueueRule (line 523)

Get a queue rule

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getQueueRule (string $rule)

string $rule: The queue rule to get

getQueues (line 574)

Get the queues from the remote asterisk server

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getQueues ()

getQueueStatus (line 453)

Retrieves the status from the Queues mechanism. It can retrieve either the status for all the Queues or the status for a specific queue/queue member

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getQueueStatus ([string $queue = false], [string $member = false])

string $queue: The queue to retrieve status for. (Optional)
string $member: The member to retrieve status for. (Optional)

getQueueSummary (line 479)

Retrieves the Queue summary for a specific queue if one has been defined, or for the entire system

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getQueueSummary ([string $queue = false])

string $queue: The queue to get the summary for. If not specified the summary for all the queues is returned

getSipPeer (line 630)

Get a SIP Peer from the remote asterisk as specified by $peer

return: or null if it was unable to retrieve any information
access: public

Shift8_Event getSipPeer (string $peer)

string $peer: The peer to get information for

getSipPeers (line 657)

Retrieve the SIP Peers from the remote asterisk server

access: public

Shift8_Event[] getSipPeers ()

getSipRegistry (line 741)

Retrieves the SIP Registry from the remote Asterisk server

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getSipRegistry ()

getStatus (line 1820)

Lists channel status along with requested channel vars

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getStatus ([string $channel = false], [string $variables = false])

string $channel: Name of the channel to query for status
string $variables: Comma ',' separated list of variables to include

getVoicemailUsers (line 762)

List All Voicemail User Information

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] getVoicemailUsers ()

hangup (line 1953)

Hangup a channel

access: public

boolean hangup (string $channel)

string $channel: The channel name to be hungup

isModuleLoaded (line 1251)

Checks if Asterisk module is loaded

access: public

boolean isModuleLoaded (string $module)

string $module: Asterisk module name (not including extension)

listCategories (line 1770)

A 'ListCategories' action will dump the categories in a given file.

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] listCategories (string $filename)

string $filename: The filename to dump the categories from

listCommands (line 1459)

Returns the action name and synopsis for every action that is available to the use

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] listCommands ()

loadModule (line 1277)

Loads, unloads or reloads an Asterisk module in a running system.

If no module is specified for a reload loadtype, all modules are reloaded

access: public

boolean loadModule ([boolean|string $module = false], [string $loadType = 'reload'])

boolean|string $module: Asterisk module name (not including extension) or subsystem identifier: cdr, enum, dnsmgr, extconfig, manager, rtp, http
string $loadType: load | unload | reload The operation to be done on module

Logins to the remote asterisk server All arguments are optional and can be defined per instance on the class instanciation

throws: Shift8_Exception is thrown when no credentials have not been specified on the class instanciation and no credentials where specified here.
access: public

boolean login ([string $ajam = false], [string $manager = false], [string $secret = false])

string $ajam: The remote ajam interface.
string $manager: The username of the manager to login
string $secret: The password of the manager

logoff (line 2061)

Logs off from the remote asterisk server

access: public

boolean logoff ()

monitor (line 949)

The 'Monitor' action may be used to record the audio on a specified channel.

access: public

boolean monitor (string $channel, [string $file = false], [string $format = false], [boolean $mix = false])

string $channel: Used to specify the channel to record
string $file: Is the name of the file created in the monitor spool directory. Defaults to the same name as the channel (with slashes replaced with dashes)
string $format: Is the audio recording format. Defaults to wav
boolean $mix: Boolean parameter as to whether to mix the input and output channels together after the recording is finished

notifyDebugListeners (line 212)

Send debug messages to all Debug Listeners

access: protected

boolean notifyDebugListeners (mixed $message)

mixed $message

notifyEventListeners (line 155)

Notify all event listeners when a event has occurred.

access: protected

boolean notifyEventListeners (Shift8_Event $event)

Shift8_Event $event: The event that has occurred

originate (line 1618)

Generates an outgoing call to a Extension/Context/Priority or Application/Data

access: public

string $channel: Channel name to call
string $exten: Extension to use (requires 'Context' and 'Priority')
string $context: Context to use (requires 'Exten' and 'Priority')
string $priority: Priority to use (requires 'Exten' and 'Context')
string $application: Application to use
string $data: Data to use (requires 'Application')
string $timeout: How long to wait for call to be answered (in ms. Default: 30000)
string $callerID: Caller ID to be set on the outgoing channel
string $variable: Channel variable to set, multiple Variable: headers are allowed
string $account: Account code
string $async: Set to 'true' for fast origination
string $codecs: The codecs to use

park (line 1182)

Park a channel

access: public

boolean park (string $channelA, string $channelB, [integer|boolean $timeout = false])

string $channelA
string $channelB
integer|boolean $timeout

pauseMonitor (line 872)

The 'PauseMonitor' action may be used to temporarily stop the recording of a channel

access: public

boolean pauseMonitor (string $channel)

string $channel: The channel to pause monitor

pauseQueueInterface (line 429)

Performs an agent pause on the interface

access: public

boolean pauseQueueInterface (string $interface)

string $interface: The interface to pause

ping (line 2081)

Pings the remote asterisk server. Keeps the remote connection alive

access: public

boolean ping ()

playDTMF (line 694)

Plays a dtmf digit on the specified channel

access: public

boolean playDTMF (string $dtmf, string $channel)

string $dtmf: The dtmf digit to play
string $channel: Channel name to send digit to

processCommandQueue (line 249)

Processes the commands actively in the Shift8 queue

access: public

boolean processCommandQueue ()

processEvents (line 2124)

Handles the processing of the return events by the asterisk server creating PHP objects for each one of them

access: public

Shift8_Event[] processEvents (SimpleXMLElement $events)

SimpleXMLElement $events

proxy (line 2149)

Handles all the proxying of requests to the remote asterisk server.

access: protected

SimpleXMLElement proxy (string $url, array $parameters)

string $url
array $parameters

queueAddInterface (line 346)

Adds a new interface in the Queue

access: public

boolean queueAddInterface (string $queue, string $interface, [string $member = false], [int $penalty = 0], [boolean $paused = false])

string $queue: The queue to add the interface to
string $interface: The interface to add to the queue
string $member: The member name for this interface
int $penalty: The penalty for this agent
boolean $paused: Whether the agent will be paused on login

queueRemoveInterface (line 380)

Remove an interface from the Queue

access: public

boolean queueRemoveInterface (string $queue, string $interface)

string $queue: The queue to remove the interface from
string $interface: The interface to remove from the queue

redirect (line 1741)

Redirect (transfer) a call

access: public

boolean redirect (string $channel, [string $extraChannel = false], string $exten, string $context, integer $priority)

string $channel: Channel to redirect
string $extraChannel: Second call leg to transfer (optional)
string $exten: Extension to transfer to
string $context: Context to transfer to
integer $priority: Priority to transfer to

reload (line 1327)

Send a reload event. Works the same as sending a ModuleLoad event (reload) without specifying any modules

access: public

boolean reload ()

removeDebugListener (line 197)

Removes a debug listener

access: public

boolean removeDebugListener (string $name)

string $name

removeEventListener (line 140)

Removes an event listener from the library.

access: public

boolean removeEventListener (string $name)

string $name

sendMessageToJabberChannel (line 983)

Send a message to a Jabber Channel

access: public

boolean sendMessageToJabberChannel (string $jabber, string $screenName, string $message)

string $jabber: Client or transport Asterisk uses to connect to JABBER
string $screenName: User Name to message.
string $message: Message to be sent to the buddy

sendText (line 1436)

Sends A Text Message while in a call

access: public

boolean sendText (string $channel, string $message)

string $channel: Channel to send message to
string $message: Message to send

sendUserEvent (line 1394)

Send an event to manager sessions

todo: This might need something more. Header1-N handling
access: public

boolean sendUserEvent (string $userEvent)

string $userEvent: Event string to send

sentSIPNotify (line 719)

Sends a SIP Notify message to a peer

access: public

boolean sentSIPNotify (string $channel)

string $channel: The channel to sent the notify

setAbsoluteTimeout (line 1533)

Hangup a channel after a certain time.

access: public

boolean setAbsoluteTimeout (string $channel, integer $timeout)

string $channel: Channel name to hangup
integer $timeout: Maximum duration of the call (sec)

setChannelVariable (line 1929)

Get the value of a global or local channel variable

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] setChannelVariable (string $variable, string $value, [string $channel = false])

string $variable: Variable name
string $value: Value
string $channel: Channel to read variable from

setCookie (line 2223)

Sets the cookie to be used for the connection with the remote asterisk server.

access: public

void setCookie (string $cookie)

string $cookie: The cookie from an already established connection to a remote asterisk server

setLastError (line 2255)

Sets the last error message

access: protected

void setLastError (SimpleXMLElement $message)

SimpleXMLElement $message: The last message occurred

setQueueMemberPenalty (line 549)

Sets the Queue Penalty for a member

access: public

boolean setQueueMemberPenalty (string $member, string $queue, integer $penalty)

string $member: The queue member to set the penalty
string $queue: The queue this member
integer $penalty: The penalty to set

setQueueProcessor (line 290)

Set the active queue processor.

The processor is responsible for inserting, retrieving and updating the Shift8 Command Queue.

throws: Shift8_Exception if the processor specified is not of type Shift8_Queue_Processor
access: public

void setQueueProcessor (Shift8_Queue_Processor $processor)

Shift8_Queue_Processor $processor

stopMonitor (line 922)

Stops monitoring a channel. Has no effect if the channel is not monitored

access: public

boolean stopMonitor (string $channel)

string $channel: The channel to stop monitoring

transfer (line 1726)

Synonymous for redirect().

see: Shift8::redirect()
access: public

void transfer ( $channel, [ $extraChannel = false], $exten, $context, $priority)

$channel
$extraChannel
$exten
$context
$priority

unpauseMonitor (line 848)

Unpauses monitoring of a channel on which monitoring had previously been paused with PauseMonitor.

access: public

boolean unpauseMonitor (string $channel)

string $channel: The channel to unpause monitor

unpauseQueueInterface (line 440)

Performs an agent un-pause on the interface

access: public

boolean unpauseQueueInterface (string $interface)

string $interface: The interface to unpause

waitEvent (line 2101)

Send a WaitEvent command to remote asterisk and wait for any incoming events

return: or null if it was unable to retrieve any information
access: public

Shift8_Event[] waitEvent ()

Class Constants

VERSION = '0.1.1' (line 67)

Documentation generated on Mon, 28 Dec 2009 17:42:50 +0200 by phpDocumentor 1.4.3