API Docs for: 2.6
Show:

server_com_history_rest Class

Provides the REST server.

Methods

config

(
  • path
)

Configurates the REST server properties by a configuration file. The file must use the JSON syntax.

The method can throw an Exception.

Parameters:

  • path String

    The path of the configuration file

configPrivacy

(
  • path
)

Customize the privacy used to hide phone numbers by a configuration file. The file must use the JSON syntax.

The method can throw an Exception.

Parameters:

  • path String

    The path of the configuration file

execute

() private

Executed by all REST request. It calls the appropriate REST plugin function.

setAllRestPluginsAuthorization

(
  • ca
)
private

Called by setCompAuthorization function for all REST plugins.

Parameters:

  • ca Object

    The architect authorization component

setAllRestPluginsLogger

(
  • log
)
private

Call setLogger function for all REST plugins.

Parameters:

  • log Object

    The logger object.

setAllRestPluginsPrivacy

(
  • str
)
private

Calls setPrivacy function for all REST plugins.

Parameters:

  • str String

    The string used to hide last digits of phone numbers

setCompAstProxy

(
  • comp
)
static

Set asterisk proxy architect component to be used by REST plugins.

Parameters:

  • comp Object

    The architect asterisk proxy component

setCompAuthorization

(
  • ca
)
static

Sets the authorization architect component for all REST plugins.

Parameters:

  • ca Object

    The architect authorization component

setCompCel

(
  • comp
)
static

Set the cel architect component to be used by REST plugins.

Parameters:

  • comp Object

    The architect cel component

setCompHistory

(
  • compHistory
)
static

Set the history architect component to be used by REST plugins.

Parameters:

  • compHistory Object

    The architect history component

setCompStaticHttp

(
  • comp
)
static

Set the static http architect component to be used by REST plugins.

Parameters:

  • comp Object

    The architect static http component

setCompUser

(
  • comp
)
static

Set the user architect component to be used by REST plugins.

Parameters:

  • comp Object

    The architect user component

setCompUtil

(
  • comp
)
static

Sets the utility architect component to be used by REST plugins.

Parameters:

  • comp Object

    The architect utility component

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 as console object.

start

() static

Start the REST server.

Properties

address

String private

Listening address of the REST server. It can be customized by the configuration file.

Default: "localhost"

IDLOG

String private final

The module identifier used by the logger.

Default: [server_com_history_rest]

logger

Object private

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

Default: console

port

String private

Listening port of the REST server.

server

Object private

The REST server.