Orca Note Plugin API Documentation
    Preparing search index...

    Type Alias APIMsg

    APIMsg:
        | "get-aliased-blocks"
        | "get-aliases"
        | "get-aliases-ids"
        | "get-block"
        | "get-block-by-alias"
        | "get-blockid-by-alias"
        | "get-blocks"
        | "get-blocks-with-tags"
        | "get-block-tree"
        | "get-children-tags"
        | "get-children-tag-blocks"
        | "get-journal-block"
        | "get-tags"
        | "query"
        | "search-aliases"
        | "search-blocks-by-text"
        | "set-app-config"
        | "set-config"
        | "shell-open"
        | "show-in-folder"
        | "upload-asset-binary"
        | "upload-assets"
        | "image-ocr"
        | string

    Supported backend API message types for communicating with the Orca backend. These message types are used with the invokeBackend method to perform various operations on blocks, tags, journals, and other repository data.

    Type declaration

    • "get-aliased-blocks"

      Retrieves all blocks with the specified alias.

    • "get-aliases"

      Retrieves all aliases in the repository.

    • "get-aliases-ids"

      Retrieves block IDs for a list of aliases.

    • "get-block"

      Retrieves a block by its ID.

    • "get-block-by-alias"

      Retrieves a block by its alias.

    • "get-blockid-by-alias"

      Retrieves the ID of a block by its alias.

    • "get-blocks"

      Retrieves multiple blocks by their IDs.

    • "get-blocks-with-tags"

      Retrieves blocks with specific tags.

    • "get-block-tree"

      Retrieves a block and all its nested child blocks (tree structure).

    • "get-children-tags"

      Retrieves child tags of a parent tag block.

    • "get-children-tag-blocks"

      Retrieves blocks associated with child tags of a parent tag.

    • "get-journal-block"

      Retrieves the journal block for a specific date.

    • "get-tags"

      Retrieves all tags in the repository.

    • "query"

      Executes a complex query to search and filter blocks.

    • "search-aliases"

      Searches for aliases containing specific text.

    • "search-blocks-by-text"

      Searches for blocks containing specific text.

    • "set-app-config"

      Sets an application-level configuration option.

    • "set-config"

      Sets a repository-level configuration option.

    • "shell-open"

      Opens a URL or file using the system's default application.

    • "show-in-folder"

      Displays a file in the system's file explorer (e.g., Finder on macOS, Explorer on Windows).

    • "upload-asset-binary"

      Uploads a binary asset (e.g., an image) to the repository.

    • "upload-assets"

      Upload multiple asset files to the repository.

    • "image-ocr"

      Perform OCR on an image.

    • string