Class DataManagerClient

constructor

• new DataManagerClient(
      client: RobotClient,
      name: string,
      options?: Options,
  ): DataManagerClient

  Parameters

  • client: RobotClient
  • name: string
  • options: Options = {}

  Returns DataManagerClient

callOptions

Readonlyname

doCommand

• doCommand(command: Struct, callOptions?: CallOptions): Promise<JsonValue>

  Do a command on the data manager.

  Parameters

  • command: Struct

    The command to do.
  • callOptions: CallOptions = ...

    Call options for the command.

  Returns Promise<JsonValue>

  Example

  const dataManager = new VIAM.DataManagerClient(
    machine,
    'my_data_manager'
  );
  await dataManager.doCommand(new Struct({ cmd: 'test', data1: 500 }));
  Copy

  For more information, see Data Manager API.

sync

• sync(extra?: {}, callOptions?: CallOptions): Promise<void>

  Sync data stored on the machine to the cloud.

  Parameters

  • extra: {} = {}

    Extra arguments to pass to the sync request.
  • callOptions: CallOptions = ...

    Call options for the sync request.

  Returns Promise<void>

  Example

  const dataManager = new VIAM.DataManagerClient(
    machine,
    'my_data_manager'
  );
  await dataManager.sync();
  Copy

  For more information, see Data Manager API.