API Docs for:
Show:

hangup Class

Module: plugins_event_13
Parent Module: ast_proxy

The plugin that handles the hangup event.

Item Index

Methods

Methods

data

(
  • data
)
static

Provided by the plugins_command_11 module.

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

data

(
  • data
)
static

It is called from astproxy component for each hangup event received from the asterisk.

Parameters:

  • data Object

    The asterisk event data

execute

(
  • am
  • args
  • cb
)
static

Provided by the plugins_command_11 module.

Execute asterisk action to hangup a call.

Parameters:

  • am Object

    Asterisk manager to send the action

  • args Object

    The object contains optional parameters passed to doCmd method of the ast_proxy component

  • cb Function

    The callback function called at the end of the command

setLogger

(
  • log
)
static

Provided by the plugins_command_11 module.

Set the logger to be used.

Parameters:

  • log Object

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

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

visit

(
  • ap
)

Store the asterisk proxy to visit.

Parameters:

  • ap Object

    The asterisk proxy module.

Properties

astProxy

Object private

The asterisk proxy.

CAUSE

Object private

The hangup causes.

IDLOG

String private final

Provided by the plugins_command_11 module.

The module identifier used by the logger.

Default: [hangup]

IDLOG

String private final

The module identifier used by the logger.

Default: [hangup]

logger

Object private

Provided by the plugins_command_11 module.

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

Default: console

logger

Object private

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

Default: console

map

Object private

Provided by the plugins_command_11 module.

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