Type alias Command

Command: ((deviceId, path, params?, multiline?) => Promise<DataObject>)

Type declaration

    • (deviceId, path, params?, multiline?): Promise<DataObject>
    • Invoke a command on a Cisco device. Commands are typically non-persistent actions that users do from the user interface, such as starting a call, changing the volume etc. Also advanced configurations such as saving macros and setting custom wallpaper can be commands.

      Some commands such as Phonebook search also returns results back to the user, this is provided as a promise result.

      Parameters

      • deviceId: string
      • path: XapiPath
      • Optional params: DataObject
      • Optional multiline: string

        For commands that accept large blobs of content, such as wallpaper image, macro content, booking XML etc. *

      Returns Promise<DataObject>

Generated using TypeDoc