Options
All
  • Public
  • Public/Protected
  • All
Menu

Joplin Plugin API Documentation

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

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: (message: any) => Promise<any>

Type declaration

    • (message: any): Promise<any>

    • Parameters

      • message: any

SyncStartHandler

SyncStartHandler: (event: SyncStartEvent) => void

Type declaration

ViewHandle

ViewHandle: string

Variables

Const logger

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

Const registerSettingAllowedPluginIds

registerSettingAllowedPluginIds: string[] = ['b53da1f6-868c-468d-b60c-2897a27166ac','com.andrejilderda.macOSTheme','com.export-to-ssg.aman-d-1-n-only','com.github.BeatLink.joplin-plugin-untagged','com.github.joplin.kanban','com.github.marc0l92.joplin-plugin-jira-issue','com.github.uphy.PlantUmlPlugin','com.gitlab.BeatLink.joplin-plugin-repeating-todos','com.joplin_plugin.nlr','com.lki.homenote','com.plugin.randomNotePlugin','com.shantanugoel.JoplinCMLineNumbersPlugin','com.whatever.inline-tags','com.whatever.quick-links','com.xUser5000.bibtex','cx.evermeet.tessus.menu-shortcut-toolbar','fd117a99-b165-4824-893c-5825439a842d','io.github.jackgruber.backup','io.github.jackgruber.combine-notes','io.github.jackgruber.copytags','io.github.jackgruber.hotfolder','io.github.jackgruber.note-overview','io.treymo.LinkGraph','joplin-insert-date','joplin-plugin-conflict-resolution','joplin.plugin.ambrt.backlinksToNote','joplin.plugin.ambrt.convertToNewNote','joplin.plugin.ambrt.copyNoteLink','joplin.plugin.ambrt.embedSearch','joplin.plugin.ambrt.fold-cm','joplin.plugin.ambrt.goToItem','joplin.plugin.anki-sync','joplin.plugin.benji.favorites','joplin.plugin.benji.persistentLayout','joplin.plugin.benji.quick-move','joplin.plugin.forcewake.tags-generator','joplin.plugin.note.tabs','joplin.plugin.quick.html.tags','joplin.plugin.spoiler.cards','joplin.plugin.templates','net.rmusin.joplin-table-formatter','net.rmusin.resource-search','org.joplinapp.plugins.AbcSheetMusic','org.joplinapp.plugins.admonition','org.joplinapp.plugins.ToggleSidebars','osw.joplin.markdowncalc','outline','plugin.azamahJunior.note-statistics','plugin.calebjohn.MathMode','plugin.calebjohn.rich-markdown',]

Functions

isContextMenuItemLocation