Skip to content

Main NavigationGitHub

English

English

Appearance

Sidebar Navigation

Joplin VSCode Plugin

FAQ

Features

Recommended Extensions

Limitations

Joplin Search Integration

Privacy Policy

Joplin Publisher

Joplin Batch

Joplin Batch Web(Legacy)

API

joplin-api

Enumerations

NoteActionEnum

ResourceActionEnum

TypeEnum

Classes

Config

EventApi

FolderApi

FolderExtApi

JoplinApi

JoplinApiGenerator

NoteActionApi

NoteApi

NoteExtApi

PageUtil

ResourceActionApi

ResourceApi

SearchApi

TagApi

Interfaces

Api

BaseProperties

CommonType

EventProperties

FieldsParam

FolderListRecursionGetTree

FolderProperties

NoteProperties

PageParam

PageRes

ResourceProperties

Type Aliases

ApiConfig

EventGetRes

EventListRes

FolderCreateRes

FolderGetRes

FolderListAllRes

FolderListRes

FolderUpdateRes

NoteCreateRes

NoteGetRes

NoteTagRelated

NoteUpdateRes

ResourceGetRes

TagGetRes

TagProperties

Variables

actionApi

ajax

config

eventApi

folderApi

folderExtApi

joplinApi

noteActionApi

noteApi

noteExtApi

resourceActionApi

resourceApi

searchApi

tagApi

Functions

joplinDataApi

joplin-plugin-api

Enumerations

AppType

ContentScriptType

FileSystemItem

ImportModuleOutputFormat

MenuItemLocation

ModelType

SettingItemSubType

SettingItemType

SettingStorage

ToolbarButtonLocation

Interfaces

ButtonSpec

CodeMirrorContentScriptModule

CodeMirrorControl

Command

ContentScriptContext

ContentScriptModule

ContentScriptModuleLoadedEvent

CreateMenuItemOptions

DialogResult

Disposable

EditorCommand

ExportContext

ExportModule

ExportOptions

ImportContext

ImportModule

MarkdownItContentScriptModule

MenuItem

Rectangle

Script

SettingItem

SettingSection

Size

VersionInfo

Type Aliases

ButtonId

Path

PostMessageHandler

ViewHandle

Variables

default

Functions

isContextMenuItemLocation

jpl-vite

api

Enumerations

AppType

ContentScriptType

FileSystemItem

ImportModuleOutputFormat

MenuItemLocation

ModelType

SettingItemSubType

SettingItemType

SettingStorage

ToolbarButtonLocation

Interfaces

ButtonSpec

CodeMirrorContentScriptModule

CodeMirrorControl

Command

ContentScriptContext

ContentScriptModule

ContentScriptModuleLoadedEvent

CreateMenuItemOptions

DialogResult

Disposable

EditorCommand

ExportContext

ExportModule

ExportOptions

ImportContext

ImportModule

MarkdownItContentScriptModule

MenuItem

Rectangle

Script

SettingItem

SettingSection

Size

VersionInfo

Type Aliases

ButtonId

Path

PostMessageHandler

ViewHandle

Variables

joplin

Functions

isContextMenuItemLocation

index

Interfaces

PluginConfig

ResolvedPluginConfig

Functions

defineConfig

getEnv

messaging

Functions

defineExtensionMessaging

webview

Variables

webviewApi

On this page

Documentation / joplin-api / ApiConfig

Type Alias: ApiConfig

ApiConfig: object | object

Defined in

api/adapter.ts:129

Pager

Previous pageResourceProperties

Next pageEventGetRes

Released under the MIT License.

Copyright © 2021-present rxliuli