Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Miscellaneous

openUrl

Used to open a fully-qualified URL in the user's default browser.

Sent by: Plugin, Property inspector

{
	event: string = "openUrl",
	payload: {
		url: string // e.g. "https://example.com/"
	}
}

logMessage

Used to log a debug message to a log file. It is more strongly advised for plugin developers to handle logging on their own.

Sent by: Plugin

{
	event: string = "logMessage",
	payload: {
		message: string
	}
}

showAlert

Used to show a temporary alert indicator on the instance.

Sent by: Plugin

{
	event: string = "showAlert",
	context: string
}

showOk

Used to show a temporary checkmark indicator on the instance.

Sent by: Plugin

{
	event: string = "showOk",
	context: string
}