Auto generated intent documentation draft

intents.md

Drafts App Intents Documentation

Actions

Get Action

Retrieves an action.

Run Action on Draft

Run action on specified draft.

Run Action with Text

Run action using provided text.

Run Background Action on Draft

Run action in background on specified draft. Action must not require user interaction.

• Action
• Draft

Run Background Action with Text

Run action in background using provided text. Action must not require user interaction.

Capture

Capture Text

Capture text as new draft.

• Content: The content of the draft.

Quick Capture

Show quick capture.

Commands

Toggle Action List

Change visibility of the action list.

• Visibility: Visibility of action list.

Toggle Draft List

Change visibility of the draft list.

• Visibility: Visibility of draft list.

Toggle Link Mode

Change status of Link Mode in the editor.

• Status

Toggle Pin Mode

Change status of Pin Mode in the editor.

• Status

Toggle Tag Filters

Change visibility of the tag filters.

• Visibility: Visibility of tag filters.

Drafts

Append to Draft

Append content to a draft.

• Draft: A draft to update.
• Content: The text

Change Draft Syntax

Change syntax assigned to a draft.

• Draft
• Syntax: Syntax definition to assign.

Create Draft

Create new draft with options.

• Content: The content of the draft.
• Tags: Tags to assign.
• Folder: Folder location.
• Flagged: Flagged status.
• Syntax: Syntax highlighting definition to assign.

Create Draft with Dictation

Open directly to dictation of a new draft.

• Locale: Initial locale for dictation.

Drafts Pro Required

This action requires Drafts Pro.

Duplicate Draft

Create a duplicate of an existing draft.

• Draft

Edit Draft

Edit draft properties.

• Draft: Draft to update.
• Property
• Content
• Folder
• Is Flagged
• Tags
• Syntax

Flag Draft

Flag a draft.

• Draft
• Flag Status

Get Current Draft

Retrieve active draft from editor.

Get Draft

Retrieves a draft.

Get Draft Versions

Retrieves version history of a draft.

Get Draft by UUID

Retrieves a draft using its unique identifier.

• UUID: Unique identifier of the draft.

Move Draft

Update draft folder and other properties without updating content.

• Draft: Draft to move.
• Folder: Folder to assign.
• Is Flagged: Flagged status.
• Tags: Tags to apply.
• Draft: Draft to move.
• Draft: Draft to move.
• Draft: Draft to move.

Open Draft

Open a draft with options.

• Draft
• Draft List: Visibility of draft list.
• Action List: Visibility of action list.
• Load Workspace: Workspace to apply to draft list.
• Load Action Group: Load an action group in the action list.
• Load Action Bar Group: Load an action group in the action bar.

Prepend to Draft

Prepend content to a draft.

• Draft: A draft to update.
• Content: The text

Save Draft Version

Save version to the version history.

Show Draft

View content of a draft.

Update Draft

Update content and other properties of a draft.

• Draft: A draft to update.
• Content: The text
• Update Type: The type of update to apply.
• Tags: Tags to assign.
• Folder: Move the draft to a folder.
• Flagged: Update flagged status.
• Syntax: Assign a syntax definition.

Search

Search Drafts

Run a search and return matching drafts.

• Search: Query string.
• Folder: Limit search to a specific folder.
• Tag filter: Comma-separated list of tags to include. Supports using “!” to omit a tag.
• Flag status: Limit results by flagged status.
• Sort order
• Sort descending
• Sort flagged to top
• Limit: Maximum number of results to return.

Show Command Palette

Open to Command Palette.

Show Quick Search

Open to Quick Search.

Utility

Apply Template

Pass text through the Drafts template engine.

• Template: The input template to process.
• Draft: The draft in context when evaluting template.

HTML to Markdown

Convert HTML text to Markdown.

Markdown to HTML

Convert Markdown text to HTML.

Set Theme

Change current theme and theme mode.

• Theme Mode: Active theme mode
• Light: Theme to use in light mode
• Dark: Theme to use in dark mode

Workspaces

Get Drafts from Workspace

Retrieve drafts matching the filters of a workspace.

• Workspace
• Folder: Limit results to only drafts in a specific folder.

Get Workspace

Retrieves an workspace.

Open Workspace

Apply workspace to draft list.