Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

findInRepository

  • Find in current repository.

    Parameters

    Returns void

getAllRepos

  • getAllRepos(): Repo[]
  • Get all repositories

    Returns Repo[]

getAttachmentURL

  • getAttachmentURL(doc: Doc, opts?: { origin: boolean }): string
  • Get document attachment url

    Parameters

    • doc: Doc
    • opts: { origin: boolean } = ...
      • origin: boolean

    Returns string

getRepo

  • getRepo(name: string): undefined | Repo
  • get repo by name

    Parameters

    • name: string

    Returns undefined | Repo

getServerTimestamp

  • getServerTimestamp(): Promise<number>
  • Get Server Timestamp

    Returns Promise<number>

    timestamp in ms

inputPassword

  • inputPassword(title: string, hint: string, throwError?: boolean): Promise<string>
  • Input password.

    Parameters

    • title: string
    • hint: string
    • throwError: boolean = false

    Returns Promise<string>

openExternal

  • openExternal(uri: string): Promise<void>
  • open an external uri

    Parameters

    • uri: string

    Returns Promise<void>

openPath

  • openPath(path: string): Promise<void>
  • open a path

    Parameters

    • path: string

    Returns Promise<void>

readFromClipboard

  • readFromClipboard(): Promise<Record<string, any>>
  • readFromClipboard(callback: (type: string, getType: (type: string) => Promise<Blob>) => Promise<void>): Promise<void>
  • Read content from clipboard

    Returns Promise<Record<string, any>>

  • Parameters

    • callback: (type: string, getType: (type: string) => Promise<Blob>) => Promise<void>
        • (type: string, getType: (type: string) => Promise<Blob>): Promise<void>
        • Parameters

          • type: string
          • getType: (type: string) => Promise<Blob>
              • (type: string): Promise<Blob>
              • Parameters

                • type: string

                Returns Promise<Blob>

          Returns Promise<void>

    Returns Promise<void>

reloadMainWindow

  • reloadMainWindow(): Promise<void>
  • Reload main window main page

    Returns Promise<void>

showItemInFolder

  • showItemInFolder(path: string): Promise<void>
  • show item in folder

    Parameters

    • path: string

    Returns Promise<void>

trashItem

  • trashItem(path: string): Promise<void>
  • Trash item

    Parameters

    • path: string

    Returns Promise<void>

triggerDeepLinkOpen

  • triggerDeepLinkOpen(url: string): Promise<boolean>
  • Trigger deep link open

    Parameters

    • url: string

    Returns Promise<boolean>

upload

  • upload(file: File, belongDoc: Pick<Doc, "repo" | "path">, name?: string): Promise<string>
  • Upload a file.

    Parameters

    • file: File
    • belongDoc: Pick<Doc, "repo" | "path">

      belong document

    • Optional name: string

      filename

    Returns Promise<string>

writeToClipboard

  • writeToClipboard(type: string, value: any): Promise<any>
  • Write content to clipboard

    Parameters

    • type: string
    • value: any

    Returns Promise<any>

Generated using TypeDoc