Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 921 Bytes

WebPluginRequest.md

File metadata and controls

19 lines (14 loc) · 921 Bytes

DocspaceApiSdk::WebPluginRequest

Properties

Name Type Description Notes
enabled Boolean Whether the plugin runs in this portal. Switching it on adds the domains its manifest declares to the portal Content Security Policy and switching it off takes them away again; connected clients are told of the new state without a reload. [optional]
settings String The configuration the plugin reads at run time, as a JSON document serialised into a string. Its shape is defined by the plugin and not by the portal, which stores it encrypted for this portal alone. It replaces whatever was stored rather than merging into it, so send {} when there is nothing to keep.

Example

require 'docspace-api-sdk'

instance = DocspaceApiSdk::WebPluginRequest.new(
  enabled: true,
  settings: {"theme":"dark","autoSave":true}
)