Class Window

Access Window properties and functions through the currentWindow property of the global app object.

Hierarchy

  • Window

Constructors

constructor

Properties - Interface

canCreateTab isActionListVisible isDraftListVisible

Properties - Other

selectedDrafts

Methods - Interface

hideActionList hideDraftList openInNewTab openInNewWindow showActionList showDraftInfo showDraftList showQuickSearch

Constructors

Private constructor

Properties - Interface

Readonly canCreateTab

canCreateTab: boolean

Returns true if tabbed windows are available (Mac only)

Readonly isActionListVisible

isActionListVisible: boolean

Is the action list side panel is visible.

Readonly isDraftListVisible

isDraftListVisible: boolean

Is the draft list side panel is visible.

Properties - Other

selectedDrafts

selectedDrafts: Draft[]

Array of the drafts currently selected by the user in the draft list. Can be iterated to create custom actions which operate on the selection.

Methods - Interface

hideActionList

  • Close action list side bar.

    Returns void

hideDraftList

  • Close draft list side bar.

    Returns void

openInNewTab

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

    Parameters

    Returns boolean

    true if successful. false if unable to open a new tab.

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.

    Parameters

    Returns boolean

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

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc