SettingsPlugin

The plugin that manages settings for the administrator or owner.

Interface: ISettingsPlugin.

Variables

adminPluginSettings

Stores the administrator or owner settings block that is embedded in the modal window with the plugin description.

Type: ISettings

Methods and their description

setAdminPluginSettings

Update the administrator or owner plugin settings.

Parameters:

setAdminPluginSettingsValue

Transfer the administrator or owner plugin settings to all the portal users. It functions on the DocSpace side.

Parameters:

getAdminPluginSettings

Get the administrator or owner plugin settings.

Example

import {type ISettings, type ISettingsPlugin} from "@onlyoffice/docspace-plugin-sdk"

class Plugin implements ISettingsPlugin {
  adminPluginSettings: ISettings | null = {} as ISettings

  getAdminPluginSettings = () => {
    return this.adminPluginSettings
  }

  setAdminPluginSettings = (settings: ISettings | null): void => {
    this.adminPluginSettings = settings
  }

  setAdminPluginSettingsValue = (settings: string | null): void => {}
}