PPA API: Delayed Tasks

Summary

This module contains actions for creating delayed tasks in PPA & viewing delayed task history.

PPA Version

The actions in this module require PPA v2.8.x or newer.

Actions

ppa_api.delayed_tasks.

display

Display delayed tasks in a table.

The table will have the following columns:

• Task Name
• Description
• Created By
• Start Time
• Time Zone
• Pending

Minimum Plugin Version: 3.0.0

Input

• text: the title of the table

• delayed_tasks: any number of DelayedTasks to display in the table

Output

Nothing is outputted by this action.

Example

- ppa_api.delayed_tasks.get_all:
  save: delayed_tasks

- ppa_api.delayed_tasks.display:
    text: All Delayed Tasks
  load:
    tasks: delayed_tasks

ppa_api.delayed_tasks.

get_all

Get all delayed tasks visible to the current user.

Minimum Plugin Version: 2.0.0

Input

This action takes no inputs.

Output

A list of DelayedTask dictionaries.

Example

- ppa_api.delayed_tasks.get_all:
  save: all_delayed_tasks

ppa_api.delayed_tasks.

get_created_by_me

Get all delayed tasks created by the current user.

Minimum Plugin Version: 2.0.0

Input

This action takes no inputs.

Output

A list of DelayedTask dictionaries.

Example

- ppa_api.delayed_tasks.get_created_by_me:
  save: my_delayed_tasks

ppa_api.delayed_tasks.

get_pending

Get all pending delayed tasks visible to the current user.

Minimum Plugin Version: 2.0.0

Input

This action takes no inputs.

Output

A list of DelayedTask dictionaries.

Example

- ppa_api.delayed_tasks.get_pending:
  save: pending_delayed_tasks

ppa_api.delayed_tasks.

get_processed

Get all processed delayed tasks visible to the current user.

Minimum Plugin Version: 2.0.0

Input

This action takes no inputs.

Output

A list of DelayedTask dictionaries.

Example

- ppa_api.delayed_tasks.get_processed:
  save: processed_delayed_tasks