Asterisk | @types/ari-client

Hierarchy

Asterisk

Index

Methods

addLog

addLog(params: { configuration: string; logChannelName: string }, callback: (err: Error) => void): void
addLog(params: { configuration: string; logChannelName: string }): Promise<void>

- Defined in index.d.ts:2120
Adds a log channel.

Parameters
- params: { configuration: string; logChannelName: string }
  - configuration: string
    
    levels of the log channel.
  - logChannelName: string
    
    The log channel to add.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2128
Adds a log channel.

Parameters
- params: { configuration: string; logChannelName: string }
  - configuration: string
    
    levels of the log channel.
  - logChannelName: string
    
    The log channel to add.
Returns Promise<void>

deleteLog

deleteLog(params: { logChannelName: string }, callback: (err: Error) => void): void
deleteLog(params: { logChannelName: string }): Promise<void>

- Defined in index.d.ts:2135
Deletes a log channel.

Parameters
- params: { logChannelName: string }
  - logChannelName: string
    
    Log channels name.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2142
Deletes a log channel.

Parameters
- params: { logChannelName: string }
  - logChannelName: string
    
    Log channels name.
Returns Promise<void>

deleteObject

deleteObject(params: { configClass: string; id: string; objectType: string }, callback: (err: Error) => void): void
deleteObject(params: { configClass: string; id: string; objectType: string }): Promise<void>

- Defined in index.d.ts:1998
Delete a dynamic configuration object.

Parameters
- params: { configClass: string; id: string; objectType: string }
  - configClass: string
    
    The configuration class containing dynamic configuration objects.
  - id: string
    
    The unique identifier of the object to delete.
  - objectType: string
    
    The type of configuration object to delete.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2007
Delete a dynamic configuration object.

Parameters
- params: { configClass: string; id: string; objectType: string }
  - configClass: string
    
    The configuration class containing dynamic configuration objects.
  - id: string
    
    The unique identifier of the object to delete.
  - objectType: string
    
    The type of configuration object to delete.
Returns Promise<void>

getGlobalVar

getGlobalVar(params: { variable: string }, callback: (err: Error, variable: Variable) => void): void
getGlobalVar(params: { variable: string }): Promise<Variable>

- Defined in index.d.ts:2163
Get the value of a global variable.

Parameters
- params: { variable: string }
  - variable: string
    
    The variable to get.
- callback: (err: Error, variable: Variable) => void
  - - (err: Error, variable: Variable): void
    - Parameters
      - err: Error
      - variable: Variable
      Returns void
Returns void
- Defined in index.d.ts:2170
Get the value of a global variable.

Parameters
- params: { variable: string }
  - variable: string
    
    The variable to get.
Returns Promise<Variable>

getInfo

getInfo(params: { only?: string | string[] }, callback: (err: Error, asteriskinfo: AsteriskInfo) => void): void
getInfo(callback: (err: Error, asteriskinfo: AsteriskInfo) => void): void
getInfo(params?: { only?: string | string[] }): Promise<AsteriskInfo>

- Defined in index.d.ts:2014
Gets Asterisk system information.

Parameters
- params: { only?: string | string[] }
  - Optional only?: string | string[]
- callback: (err: Error, asteriskinfo: AsteriskInfo) => void
  - - (err: Error, asteriskinfo: AsteriskInfo): void
    - Parameters
      - err: Error
      - asteriskinfo: AsteriskInfo
      Returns void
Returns void
- Defined in index.d.ts:2019
Gets Asterisk system information.

Parameters
- callback: (err: Error, asteriskinfo: AsteriskInfo) => void
  - - (err: Error, asteriskinfo: AsteriskInfo): void
    - Parameters
      - err: Error
      - asteriskinfo: AsteriskInfo
      Returns void
Returns void
- Defined in index.d.ts:2026
Gets Asterisk system information.

Parameters
- Optional params: { only?: string | string[] }
  - Optional only?: string | string[]
Returns Promise<AsteriskInfo>

getModule

getModule(params: { moduleName: string }, callback: (err: Error, module: Module) => void): void
getModule(params: { moduleName: string }): Promise<Module>

- Defined in index.d.ts:2053
Get Asterisk module information.

Parameters
- params: { moduleName: string }
  - moduleName: string
    
    Modules name.
- callback: (err: Error, module: Module) => void
  - - (err: Error, module: Module): void
    - Parameters
      - err: Error
      - module: Module
      Returns void
Returns void
- Defined in index.d.ts:2060
Get Asterisk module information.

Parameters
- params: { moduleName: string }
  - moduleName: string
    
    Modules name.
Returns Promise<Module>

getObject

getObject(params: { configClass: string; id: string; objectType: string }, callback: (err: Error, configtuples: ConfigTuple[]) => void): void
getObject(params: { configClass: string; id: string; objectType: string }): Promise<ConfigTuple[]>

- Defined in index.d.ts:1949
Retrieve a dynamic configuration object.

Parameters
- params: { configClass: string; id: string; objectType: string }
  - configClass: string
    
    The configuration class containing dynamic configuration objects.
  - id: string
    
    The unique identifier of the object to retrieve.
  - objectType: string
    
    The type of configuration object to retrieve.
- callback: (err: Error, configtuples: ConfigTuple[]) => void
  - - (err: Error, configtuples: ConfigTuple[]): void
    - Parameters
      - err: Error
      - configtuples: ConfigTuple[]
      Returns void
Returns void
- Defined in index.d.ts:1961
Retrieve a dynamic configuration object.

Parameters
- params: { configClass: string; id: string; objectType: string }
  - configClass: string
    
    The configuration class containing dynamic configuration objects.
  - id: string
    
    The unique identifier of the object to retrieve.
  - objectType: string
    
    The type of configuration object to retrieve.
Returns Promise<ConfigTuple[]>

listLogChannels

listLogChannels(callback: (err: Error, logchannels: LogChannel[]) => void): void
listLogChannels(): Promise<LogChannel[]>

- Defined in index.d.ts:2107
Gets Asterisk log channel information.

Parameters
- callback: (err: Error, logchannels: LogChannel[]) => void
  - - (err: Error, logchannels: LogChannel[]): void
    - Parameters
      - err: Error
      - logchannels: LogChannel[]
      Returns void
Returns void
- Defined in index.d.ts:2112
Gets Asterisk log channel information.

Returns Promise<LogChannel[]>

listModules

listModules(callback: (err: Error, modules: Module[]) => void): void
listModules(): Promise<Module[]>

- Defined in index.d.ts:2041
List Asterisk modules.

Parameters
- callback: (err: Error, modules: Module[]) => void
  - - (err: Error, modules: Module[]): void
    - Parameters
      - err: Error
      - modules: Module[]
      Returns void
Returns void
- Defined in index.d.ts:2046
List Asterisk modules.

Returns Promise<Module[]>

loadModule

loadModule(params: { moduleName: string }, callback: (err: Error) => void): void
loadModule(params: { moduleName: string }): Promise<void>

- Defined in index.d.ts:2067
Load an Asterisk module.

Parameters
- params: { moduleName: string }
  - moduleName: string
    
    Modules name.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2074
Load an Asterisk module.

Parameters
- params: { moduleName: string }
  - moduleName: string
    
    Modules name.
Returns Promise<void>

ping

ping(callback: (err: Error, asteriskping: AsteriskPing) => void): void
ping(): Promise<AsteriskPing>

- Defined in index.d.ts:2031
Response pong message.

Parameters
- callback: (err: Error, asteriskping: AsteriskPing) => void
  - - (err: Error, asteriskping: AsteriskPing): void
    - Parameters
      - err: Error
      - asteriskping: AsteriskPing
      Returns void
Returns void
- Defined in index.d.ts:2036
Response pong message.

Returns Promise<AsteriskPing>

reloadModule

reloadModule(params: { moduleName: string }, callback: (err: Error) => void): void
reloadModule(params: { moduleName: string }): Promise<void>

- Defined in index.d.ts:2095
Reload an Asterisk module.

Parameters
- params: { moduleName: string }
  - moduleName: string
    
    Modules name.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2102
Reload an Asterisk module.

Parameters
- params: { moduleName: string }
  - moduleName: string
    
    Modules name.
Returns Promise<void>

rotateLog

rotateLog(params: { logChannelName: string }, callback: (err: Error) => void): void
rotateLog(params: { logChannelName: string }): Promise<void>

- Defined in index.d.ts:2149
Rotates a log channel.

Parameters
- params: { logChannelName: string }
  - logChannelName: string
    
    Log channels name.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2156
Rotates a log channel.

Parameters
- params: { logChannelName: string }
  - logChannelName: string
    
    Log channels name.
Returns Promise<void>

setGlobalVar

setGlobalVar(params: { value?: string; variable: string }, callback: (err: Error) => void): void
setGlobalVar(params: { value?: string; variable: string }): Promise<void>

- Defined in index.d.ts:2178
Set the value of a global variable.

Parameters
- params: { value?: string; variable: string }
  - Optional value?: string
  - variable: string
    
    The variable to set.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2186
Set the value of a global variable.

Parameters
- params: { value?: string; variable: string }
  - Optional value?: string
  - variable: string
    
    The variable to set.
Returns Promise<void>

unloadModule

unloadModule(params: { moduleName: string }, callback: (err: Error) => void): void
unloadModule(params: { moduleName: string }): Promise<void>

- Defined in index.d.ts:2081
Unload an Asterisk module.

Parameters
- params: { moduleName: string }
  - moduleName: string
    
    Modules name.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2088
Unload an Asterisk module.

Parameters
- params: { moduleName: string }
  - moduleName: string
    
    Modules name.
Returns Promise<void>

updateObject

updateObject(params: { configClass: string; fields?: Containers; id: string; objectType: string }, callback: (err: Error, configtuples: ConfigTuple[]) => void): void
updateObject(params: { configClass: string; fields?: Containers; id: string; objectType: string }): Promise<ConfigTuple[]>

- Defined in index.d.ts:1971
Create or update a dynamic configuration object.

Parameters
- params: { configClass: string; fields?: Containers; id: string; objectType: string }
  - configClass: string
    
    The configuration class containing dynamic configuration objects.
  - Optional fields?: Containers
  - id: string
    
    The unique identifier of the object to create or update.
  - objectType: string
    
    The type of configuration object to create or update.
- callback: (err: Error, configtuples: ConfigTuple[]) => void
  - - (err: Error, configtuples: ConfigTuple[]): void
    - Parameters
      - err: Error
      - configtuples: ConfigTuple[]
      Returns void
Returns void
- Defined in index.d.ts:1984
Create or update a dynamic configuration object.

Parameters
- params: { configClass: string; fields?: Containers; id: string; objectType: string }
  - configClass: string
    
    The configuration class containing dynamic configuration objects.
  - Optional fields?: Containers
  - id: string
    
    The unique identifier of the object to create or update.
  - objectType: string
    
    The type of configuration object to create or update.
Returns Promise<ConfigTuple[]>

Hierarchy

Index

Methods

Methods

addLog

Parameters

params: { configuration: string; logChannelName: string }

configuration: string

logChannelName: string

callback: (err: Error) => void

Parameters

err: Error

Returns void

Returns void

Parameters

params: { configuration: string; logChannelName: string }

configuration: string

logChannelName: string

Returns Promise<void>

deleteLog

Parameters

params: { logChannelName: string }

logChannelName: string

callback: (err: Error) => void

Parameters

err: Error

Returns void

Returns void

Parameters

params: { logChannelName: string }

logChannelName: string

Returns Promise<void>

deleteObject

Parameters

params: { configClass: string; id: string; objectType: string }

configClass: string

id: string

objectType: string

callback: (err: Error) => void

Parameters

err: Error

Returns void

Returns void

Parameters

params: { configClass: string; id: string; objectType: string }

configClass: string

id: string

objectType: string

Returns Promise<void>

getGlobalVar

Parameters

params: { variable: string }

variable: string

callback: (err: Error, variable: Variable) => void

Parameters

err: Error

variable: Variable

Returns void

Returns void

Parameters

params: { variable: string }

variable: string

Returns Promise<Variable>

getInfo

Parameters

params: { only?: string | string[] }

Optional only?: string | string[]

callback: (err: Error, asteriskinfo: AsteriskInfo) => void

Parameters

err: Error

asteriskinfo: AsteriskInfo

Returns void

Returns void

Parameters

callback: (err: Error, asteriskinfo: AsteriskInfo) => void

Parameters

err: Error

asteriskinfo: AsteriskInfo

Returns void

Returns void