How to view/query global settings?

manuerwin · 13 November 2021 23:44

My plugin does not need to set/update global settings, just to query them, very likely the value of the "sync.target" setting.

My ReplaceResources plugin needs to know whether "synchronisation" is enabled/configured in order to decide how to proceed.

That is, if sync is configured, await the joplin.workspace.onSyncComplete event before the next stage of processing.

Else, if sync is NOT configured, go straight to the next stage of processing.

I'm looking for suggestions on how to solve for this as per JoplinSettings.ts "Currently this API does not provide access to Joplin's built-in settings. This is by design as plugins that modify user settings could give unexpected results."

CalebJohn · 14 November 2021 00:16

It's possible to read these settings, just not write to them.

You can see an example of this here

github.com

CalebJohn/joplin-rich-markdown/blob/main/src/index.ts#L48

    
      
          			label: 'Perform action',
          			iconName: 'fas fa-link',
          			execute: async () => {
          				await joplin.commands.execute('editor.execCommand', {
          					name: 'clickUnderCursor',
          				});
          		  },
          		});
          		await joplin.views.menuItems.create('clickAtCursorContext', 'editor.richMarkdown.clickAtCursor', MenuItemLocation.EditorContextMenu, { accelerator: 'Ctrl+Enter' });
          
          
		const resourceDir = await joplin.settings.globalValue('resourceDir');
          		const apiToken = await joplin.settings.globalValue('api.token');
          		const clipperEnabled = await joplin.settings.globalValue('clipperServer.autoStart');
          		const apiPort = clipperEnabled ? await getApiPort() : -1;
          		await registerAllSettings();
          
          
		await joplin.contentScripts.register(
          			ContentScriptType.CodeMirrorPlugin,
          			contentScriptId,
          			'./richMarkdown.js'
          		);

And the documentation for this function is here
https://joplinapp.org/api/references/plugin_api/classes/joplinsettings.html#globalvalue

manuerwin · 14 November 2021 03:34

Thank you, thank you, thank you!!

Topic		Replies	Views
Plugins: allow read-only access to user settings Features	1	610	12 October 2020
Export/Import Settings Plugins	13	2967	21 March 2024
Synching Plugin installations between different machines Plugins	15	2876	11 February 2024
Hope to add api to return to joplin basic info(includes installation directory) Features	15	1060	5 November 2020
[Feature Request] Sync settings across clients Features	10	969	30 May 2022

How to view/query global settings?

Related topics