PluginregisterObsidianProtocolHandler

Plugin.registerObsidianProtocolHandler() method

Register a handler for obsidian:// URLs.

Signature:

registerObsidianProtocolHandler(action: string, handler: ObsidianProtocolHandler): void;

Parameters

ParameterTypeDescription
actionstringthe action string. For example, ‘open’ corresponds to obsidian://open.
handlerObsidianProtocolHandlerthe callback to trigger. A key-value pair that is decoded from the query will be passed in. For example, obsidian://open?key=value would generate {‘action’: ‘open’, ‘key’: ‘value’}.

Returns:

void