API Docs for:
Show:

listChannels Class

Module: plugins_command_13
Parent Module: astproxy

Command plugin to get the list of all channels.

Use it with astproxy module as follow:

ast_proxy.doCmd({ command: 'listChannels' }, function (res) {
    // some code
});

Item Index

Methods

Properties

Methods

data

(
  • data
)
static

It's called from astproxy component for each data received from asterisk and relative to this command.

Parameters:

  • data Object

    The asterisk data for the current command.

execute

(
  • am
  • args
  • cb
)
static

Execute asterisk action to get the list of all channels.

Parameters:

  • am Object

    Asterisk manager used to send the action

  • args Object

    The object containing optional parameters

  • cb Function

    The callback function

setLogger

(
  • log
)
static

Set the logger to be used.

Parameters:

  • log Object

    The logger object. It must have at least three methods: info, warn and error

Properties

IDLOG

String private final

The module identifier used by the logger.

Default: [listChannels]

list

Object private

List of all channels. The key is the channel identifier and the value is the Channel object.

logger

Object private

The logger. It must have at least three methods: info, warn and error.

Default: console

map

Object private

Map associations between ActionID and callback to execute at the end of the command.