Class App

Drafts defines a single global app object which provides access to application level functions.

Examples

 
// toggle dark-light mode
if (app.currentThemeMode == 'dark') {
  app.themeMode = 'light';
}
else {
  app.themeMode = 'dark';
}

Hierarchy

  • App

Constructors

constructor

Properties - Interface

currentWindow currentWorkspace isActionListVisible isDraftListVisible

Properties - Live Activities

areLiveActivitiesSupported

Properties - System

isIdleDisabled isPro version

Properties - Theme

currentThemeMode darkTheme lightTheme themeMode

Methods - Clipboard

getClipboard setClipboard

Methods - Deprecated

loadKeyboardActionGroup

Methods - Interface

applyWorkspace displaySuccessMessage hideActionList hideDraftList loadActionBarGroup loadActionGroup openInNewWindow selectDraft showActionList showDraftInfo showDraftList showQuickSearch

Methods - Live Activities

startLiveActivity stopLiveActivity

Methods - Messages

displayErrorMessage displayInfoMessage displayWarningMessage

Methods - Utility

htmlToClipboard openURL queueAction setIdleDisabled

Constructors

Private constructor

Interface Properties

currentWindow

currentWindow: Window

Returns a window object configured representing the active window.

currentWorkspace

currentWorkspace: Workspace

Returns a workspace object configured like the workspace currently loaded in the draft list of the active window. Useful when creating logic which reacts contextually to the workspace loaded.

Readonly isActionListVisible

isActionListVisible: boolean

Is the action list side panel is visible.

Readonly isDraftListVisible

isDraftListVisible: boolean

Is the draft list side panel is visible.

Live Activities Properties

Readonly areLiveActivitiesSupported

areLiveActivitiesSupported: boolean

Check if Live Activities are supported on the current device/platform.

System Properties

isIdleDisabled

isIdleDisabled: boolean

Is system sleep timer disabled preventing screen dimming/sleep.

Readonly isPro

isPro: boolean

Returns true if app has an active Drafts Pro subscription.

Readonly version

version: string

Version number of current installation of Drafts.

Theme Properties

Readonly currentThemeMode

currentThemeMode: "light" | "dark"

Returns the active theme mode, light or dark, taking into account automatic switching of themes if active. If writing scripts to branch logic based on the current mode, this is the best property to use.

darkTheme

darkTheme: Theme

The current dark mode theme.

lightTheme

lightTheme: Theme

The current light mode theme.

themeMode

themeMode: "light" | "dark" | "automatic"

Get or set themeMode.

Clipboard Methods

getClipboard

  • Get current contents of the system clipboard.

    Parameters

    • Optional clipboardType: clipboardType

      Optionally specify a data type to fetch from the clipboard. Default: "string"

    Returns string

setClipboard

  • Set the contents of the system clipboard.

    Parameters

    • contents: string | object

      the data to set in the clipboard. If a string is passed it is set in the clipboard. Optionally an object with clipboardType keys and string values can be passed to set multiple data types in the clipboard.

    Returns void

Deprecated Methods

loadKeyboardActionGroup

  • Deprecated

    replaced by loadActionBarGroup.

    Parameters

    Returns boolean

Interface Methods

applyWorkspace

  • Apply the Workspace as if it was selected in draft list. Calling this function with no arguments will clear filters and apply the default workspace.

    Parameters

    Returns boolean

displaySuccessMessage

  • Show success banner notification with the message passed.

    Parameters

    • message: string

    Returns void

hideActionList

  • Close action list side bar.

    Returns void

hideDraftList

  • Close draft list side bar.

    Returns void

loadActionBarGroup

  • Load the ActionGroup in the action bar below editor.

    Parameters

    Returns boolean

loadActionGroup

  • Load the ActionGroup in the action list side bar.

    Parameters

    Returns boolean

openInNewWindow

  • If able, open the requested draft in a new window. This method only functions on iPad and Mac. The ability to open new windows is not available on iPhone.

    Returns

    true if successful. false if unable to open a new window (as on iPhone).

    Parameters

    Returns boolean

selectDraft

  • Open draft selection interface and wait for user to select a draft. Returns the select draft object, or undefined if user cancelled.

    Parameters

    • Optional workspace: Workspace

      If provided, the workspace will define the default filtering, display, and sort options for the selection window.

    Returns Draft

showActionList

  • Open action list side bar.

    Returns void

showDraftInfo

  • Open the "Get Info" view for a draft. If no draft is passed, the current active draft in the editor will be used.

    Parameters

    Returns void

showDraftList

  • Open draft list side bar.

    Returns void

showQuickSearch

  • Open quick search window, optionally providing a initial query value.

    Parameters

    • Optional initialQuery: string

    Returns void

Live Activities Methods

startLiveActivity

  • Start a Live Activity for the selected Draft. Returns true if Live Activity started successfully. Returns false if Live Activity could not be started, or Live Activities are not supported on the device.

    Parameters

    • draft: Draft

      The draft to use in the Live Activity

    Returns boolean

stopLiveActivity

  • Stop a Live Activity for the selected Draft. Returns true if Live Activity stopped successfully.

    Parameters

    • draft: Draft

      The draft to use in the Live Activity

    Returns boolean

Messages Methods

displayErrorMessage

  • Show error banner notification with the message passed.

    Parameters

    • message: string

    Returns void

displayInfoMessage

  • Show info banner notification with the message passed.

    Parameters

    • message: string

    Returns void

displayWarningMessage

  • Show warning banner notification with the message passed.

    Parameters

    • message: string

    Returns void

Utility Methods

htmlToClipboard

  • Takes HTML string and converts it to rich-text and places it in the system clipboard. Returns true if successful, false if an error occurred in conversion.

    Parameters

    • html: string

      a possibly-valid html string

    Returns boolean

openURL

  • Request system opens the URL passed. Returns true if URL was opened, false if the URL was invalid or no available app can open the URL on the device.

    Parameters

    • url: string

      url to open

    • Optional useSafari: boolean

      whether to use the Safari View Controller (true) or default browser (false).

    Returns boolean

queueAction

  • Queues an action to run on a draft after the current action is complete.

    // lookup action and draft, and queue the action to run
    let a = Action.find("Copy");
    let d = Draft.find("UUID");
    app.queueAction(a, d);

    Parameters

    • action: Action

      Actions can be obtained using the Action.find(name) method.

    • draft: Draft

      A draft object.

    Returns boolean

setIdleDisabled

  • Enable and disable the iOS system sleep timer to prevent screen dimming/sleep.

    Parameters

    • isDisabled: boolean

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc