Class AsteriskManagerInterface

Hierarchy

  • EventEmitter
    • AsteriskManagerInterface

Constructors

constructor

Accessors

authenticated

Methods

close login moduleCheck on once ping send

Constructors

constructor

Accessors

authenticated

  • get authenticated(): boolean

  • Returns if the connection is authenticated

    Returns boolean

Methods

close

  • close(): Promise<void>

  • Closes the connection to the server

    Returns Promise<void>

login

  • login(user?, password?): Promise<boolean>

  • Attempts to log into the server over the AMI connection

    Parameters

    • user: string = ...
    • password: string = ...

    Returns Promise<boolean>

moduleCheck

  • moduleCheck(module): Promise<boolean>

  • Checks if the specified module is loaded on the server

    Parameters

    • module: string

    Returns Promise<boolean>

on

  • on(event, listener): this

  • Parameters

    • event: "close"
    • listener: ((hadError?) => void)
        • (hadError?): void

        • Parameters

          • Optional hadError: boolean

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "error"
    • listener: ((error) => void)
        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns this

  • on(event, listener): this

  • Parameters

    • event: "connect"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • on<T>(event, listener): this

  • Type Parameters

    • T = any

    Parameters

    • event: "response"
    • listener: ((payload) => void)
        • (payload): void

        • Parameters

          • payload: T

          Returns void

    Returns this

once

  • once<T>(event, listener): this

  • Type Parameters

    • T = any

    Parameters

    • event: "response"
    • listener: ((payload) => void)
        • (payload): void

        • Parameters

          • payload: T

          Returns void

    Returns this

ping

  • ping(): Promise<boolean>

  • Pings the AMI connection (keepalive)

    Returns Promise<boolean>

send

Settings

Member Visibility

Theme

On This Page

constructorauthenticatedcloseloginmoduleCheckononcepingsend