Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace requests

Index

Functions

Functions

requestReport

  • requestReport(pluginName: string, pluginType?: string, trackName?: string, nth?: number, extraMessages?: any[], client?: IpcClient, pauseMs?: number): Promise<any>
  • Parameters

    • pluginName: string

      The plugin name (see cybr.plugin.select)

    • Optional pluginType: string

      The plugin type (see cybr.plugin.select)

    • trackName: string = 'plugin-helper-track'

      The track name to create the plugin on

    • nth: number = 0

      Index (if there are multiple plugins of the same kind on the track - see cybr.plugin.select)

    • extraMessages: any[] = []

      cybr messages to configure plugin parameters

    • client: IpcClient = ...

      the cybr client use to retrieve plugin state

    • pauseMs: number = 120

      the duration to wait between setting the plugin parameters, and retrieving the state. Some plugins do not report their state immediately

    Returns Promise<any>