Oxygen XML Web Author

Class: FileServersManager

sync.api. FileServersManager

new FileServersManager()

This manager can be used to register a file server for which browsing and create files features are provided:
  • inline file browsing functionality (in Dashboard)
  • create and upload files functionality (in Dashboard)
  • file chooser for server files management actions (in Editor)
  • file server logout actions (in Dashboard and Editor)
To get access to this manager use sync.api.Workspace#getFileServersManager: 
  var fileServersManager = workspace.getFileServersManager()

*********************************
EXPERIMENTAL - Subject to change
*********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Since:
  • 20.1.1

Methods

registerFileServerConnector(serverDescriptor)

Register a sync.api.FileServerDescriptor to integrate browsing and file creation functionality for specific file server type. For each file server connector registered using this method a Dashboard tab will be created, with inline file browsing functionality and "New" and "Upload" file actions included. Also, when a file from this server is opened to be edited, a "Logout" action will be automatically mounted in the editor's menu and a file browser dialog will be created to be used when invoking open and create file actions.
Parameters:
Name Type Description
serverDescriptor sync.api.FileServerDescriptor The file server descriptor, providing information like server name, icon or browsing functionality.