Options
All
  • Public
  • Public/Protected
  • All
Menu

Joplin Plugin API Documentation

Index

Type aliases

ButtonId

ButtonId: string

ChangeHandler

ChangeHandler: (event: ChangeEvent) => void

Type declaration

ItemChangeHandler

ItemChangeHandler: (event: ItemChangeEvent) => void

Type declaration

Path

Path: string[]

An array of at least one element and at most three elements.

  • [0]: Resource name (eg. "notes", "folders", "tags", etc.)
  • [1]: (Optional) Resource ID.
  • [2]: (Optional) Resource link.

PostMessageHandler

PostMessageHandler: (id: string, message: any) => Promise<any>

Type declaration

    • (id: string, message: any): Promise<any>
    • Parameters

      • id: string
      • message: any

SyncStartHandler

SyncStartHandler: (event: SyncStartEvent) => void

Type declaration

ViewHandle

ViewHandle: string

Variables

Const logger

logger: LoggerWrapper = Logger.create('joplin.plugins')

Functions

isContextMenuItemLocation