TRY NEW VERSION

Config

Description

The configuration parameters describe the behavior and display options of the DocSpace elements.

Parameters
Name Description Type Example
The selector button color. string "#5299E0"
Specifies whether to check for the presence of CSP headers before initialization. boolean true
The text that will be inserted into the div tag when the destroyFrame method is called. string ""
Specifies whether to disable the Actions button in the manager interface. boolean false
Specifies whether to switch the SDK to the mode of working with download links through the onDownload event. boolean false
The parameters to customize editors. The parameters from this section are used. object {}
Specifies whether the File Location button is displayed in the editor. boolean true
The editor mode display type ("embedded", "desktop"). string "desktop"
A list of DocSpace events that will be returned on certain actions within the SDK. object { "onSelectCallback": null, "onCloseCallback": null, "onAppReady": null, "onAppError": null, "onEditorCloseCallback": null, "onAuthSuccess": null, "onSignOut": null, "onDownload": null }
The filter parameters that facilitate searching files in the DocSpace manager:
  • count - a number of files to be displayed,
    type: integer,
    example: 100;
  • page - a page number,
    type: integer,
    example: 1;
  • search - a query to search for files,
    type: string,
    example: "";
  • sortorder - the sort order of files ("descending", "ascending"),
    type: string,
    example: "descending";
  • sortby - the parameter by which the files will be sorted ("DateAndTime", "AZ", "Type", "Size", "DateAndTimeCreation", "Author"),
    type: string,
    example: "DateAndTime";
  • withSubfolders - specifies whether to exclude subfolders when searching for files,
    type: boolean,
    example: false.
object { "count": 100, "page": 1, "search": "", "sortorder": "descending", "sortby": "DateAndTime", "withSubfolders": false }
The filter parameters that facilitate searching files in the selector mode. The possible values: "ALL", "DOCX", "IMG", "GZ", "DOCXF", "XLSX", "BackupOnly". string "ALL"
The frame SDK ID which is used to refer to the SDK instance. string "ds-frame"
The frame SDK height measured in percent. string "100%"
The element ID which will be used in the SDK initialization modes. string null
Specifies whether to display a button to show the info panel in the manager. boolean true
The language of the DocSpace user interface which is specified with the four letter language code. string null
The SDK initialization mode ("manager", "file-selector", 'room-selector", "editor", "viewer", "system") string "manager"
The name of the object inserted into the page. It is used for messaging at the SDK level. string "frameDocSpace"
The request token that is used to open public rooms and files in public rooms. string null
The path to the frame SDK. Opens a list of rooms by default. string "/rooms/shared/"
The selector type that defines filters for elements in the selector mode. The possible values: "roomsOnly", "userFolderOnly", "exceptPrivacyTrashArchiveFolders", "exceptSortedByTagsFolders". string "roomsOnly"
Specifies whether the interface filter is displayed in the DocSpace manager. boolean false
Specifies whether the interface header is displayed in the mobile view manager. boolean false
Specifies whether the interface menu is displayed in the DocSpace manager. boolean false
Specifies whether the Cancel button is displayed in the selector mode. boolean false
Specifies whether the interface header is displayed in the selector mode. boolean false
Specifies whether to display the Manage displayed columns button for configuring the table columns in the manager. boolean false
Specifies whether the Sign out button is displayed. boolean true
Specifies whether the interface title is displayed in the DocSpace manager. boolean true
The base URL to the DocSpace portal. It is used to generate links. string {PORTAL_SRC}
The DocSpace user interface theme ("Base", "Dark", "System"). string "Base"
The platform type which is used by the browser and affects the parameters of the inserted object ("desktop", "mobile"). string "desktop"
The way elements are arranged in the DocSpace manager ("row", "table", "tile"). string "row"
The column names that are displayed for the table in the manager. string "Name,Type,Tags"
The frame SDK width measured in percent. string "100%"
Specifies whether to display the breadcrumbs in the selector mode. boolean true
Specifies whether to display Search in the selector mode. boolean true
Specifies whether to display the filter parameters in the selector mode. boolean true
Example
{ 
    "buttonColor": "#5299E0", 
    "destroyText": "",
    "checkCSP" true,
    "disableActionButton": false,
    "downloadToEvent": false,
    "editorCustomization": {},
    "editorGoBack": true,
    "editorType": "desktop",
    "events": {
        "onSelectCallback": null,
        "onCloseCallback": null,
        "onAppReady": null,
        "onAppError": null,
        "onEditorCloseCallback": null,
        "onAuthSuccess": null,
        "onSignOut": null,
        "onDownload": null
    },
    "filter": {
          "count": 100,
          "page": 1,
          "search": "",
          "sortorder": "descending",
          "sortby": "DateAndTime",
          "withSubfolders": false
    },
    "filterParam": "ALL",
    "frameId": "ds-frame",
    "height":  "100%",
    "id": null,
    "infoPanelVisible": true,
    "locale": null,
    "mode": "manager",
    "name": "frameDocSpace",
    "requestToken": null,
    "rootPath": "/rooms/shared/",
    "selectorType": "exceptPrivacyTrashArchiveFolders",
    "showFilter": false,
    "showHeader": false,
    "showMenu": false,
    "showSelectorCancel": false,
    "showSelectorHeader": false,
    "showSettings": false,
    "showSignOut": true,
    "showTitle": true,
    "src": {PORTAL_SRC},
    "theme": "Base",
    "type": "desktop",
    "viewAs": "row",
    "viewTableColumns": "Name,Type,Tags",
    "width": "100%",
    "withBreadCrumbs": true,
    "withSearch": true,
    "withSubtitle": true
};