Automa Docs

Appearance

Global Variables ​

Here are some global variables you can use when writing a custom script for the extension

$helper.getWorkflows ​

$helper.getWorkflows(workflowId?: string): Promise<Workflow | undefined>

Get a specific workflow or all the workflows of the extension.

Parameters:

  • workflowId: the id of the workflow

Examples

js
// Get all workflows
$helper.getWorkflows().then((workflows) => {
  console.log(workflows);
});

// Get a specific workflow
$helper.getWorkflows('workflow-id').then((workflow) => {
  console.log(workflow);
});
// Get all workflows
$helper.getWorkflows().then((workflows) => {
  console.log(workflows);
});

// Get a specific workflow
$helper.getWorkflows('workflow-id').then((workflow) => {
  console.log(workflow);
});

$helper.executeWorkflow ​

$helper.executeWorkflow(workflowData: Workflow | string, options?: Options): void

To execute a workflow.

Parameters:

  • workflowData: the workflow data or the id of the workflow to execute
  • options: the options for the workflow execution

Examples

js
(async () => {
  // Using workflow id
  $helper.executeWorkflow('workflow-id');

  // Using workflow object
  const workflow = await $helper.getWorkflow('workflow-id');
  $helper.executeWorkflow(workflow);

  // Passing variables and global data options for the workflow
  const globalData = [{ key: 'value', name: 'John Doe' }];
  const variables = { variableName: 'Variable value', number: 10 };
  $helper.executeWorkflow('workflow-id', {
    data: {
      variables,
      globalData,
    }
  });
})()
(async () => {
  // Using workflow id
  $helper.executeWorkflow('workflow-id');

  // Using workflow object
  const workflow = await $helper.getWorkflow('workflow-id');
  $helper.executeWorkflow(workflow);

  // Passing variables and global data options for the workflow
  const globalData = [{ key: 'value', name: 'John Doe' }];
  const variables = { variableName: 'Variable value', number: 10 };
  $helper.executeWorkflow('workflow-id', {
    data: {
      variables,
      globalData,
    }
  });
})()

$helper.storage.variables ​

Access or manipulate the variables stored in the storage.

Examples

js
(async () => {
  // Get all variables
  const variables = await $helper.storage.variables.get(null);
  console.log(variables) // { name: 'John Doe', email: 'johndoe@example.com', username: 'john_doe' }

  // Get a specific variable
  const variables = await $helper.storage.variables.get('name'); 
  console.log(variables) // { name: 'John Doe' }

  // Get multiple variables
  const variables = await $helper.storage.variables.get(['name', 'email']);
  console.log(variables) // { name: 'John Doe', email: 'johndoe@example.com' }

  // Add or update variables
  await $helper.storage.variables.set({
    country: 'US',
    name: 'Jonathan Doe',
    email: 'jonathan_doe@example.com',
  });

  // Delete a variable 
  await $helper.storage.variables.delete('name');

  // Delete multiple variables
  await $helper.storage.variables.delete(['name', 'email']);

  // Delete all variables
  $helper.storage.variables.clear();
})();
(async () => {
  // Get all variables
  const variables = await $helper.storage.variables.get(null);
  console.log(variables) // { name: 'John Doe', email: 'johndoe@example.com', username: 'john_doe' }

  // Get a specific variable
  const variables = await $helper.storage.variables.get('name'); 
  console.log(variables) // { name: 'John Doe' }

  // Get multiple variables
  const variables = await $helper.storage.variables.get(['name', 'email']);
  console.log(variables) // { name: 'John Doe', email: 'johndoe@example.com' }

  // Add or update variables
  await $helper.storage.variables.set({
    country: 'US',
    name: 'Jonathan Doe',
    email: 'jonathan_doe@example.com',
  });

  // Delete a variable 
  await $helper.storage.variables.delete('name');

  // Delete multiple variables
  await $helper.storage.variables.delete(['name', 'email']);

  // Delete all variables
  $helper.storage.variables.clear();
})();

chrome ​

To access the browser API. See all the available APIs on Chrome Developer documentation

Examples

js
(async () => {
  // Get all tabs
  const tabs = await chrome.tabs.query({});

  // Get the current active tab
  const tab = await chrome.tabs.query({ active: true, currentWindow: true });
})();
(async () => {
  // Get all tabs
  const tabs = await chrome.tabs.query({});

  // Get the current active tab
  const tab = await chrome.tabs.query({ active: true, currentWindow: true });
})();