Document Permissions

Description

The document permission section allows to change the permission for the document to be edited and downloaded or not.

Parameters
Name Description Type Example
Defines if the document can be commented or not. In case the commenting permission is set to "true" the document side bar will contain the Comment menu option; the document commenting will only be available for the document editor if the mode parameter is set to edit. The default value coincides with the value of the edit parameter. boolean true
In case edit is set to "true" and comment is also set to "true", the user will be able to edit the document and comment. In case edit is set to "true" and comment is set to "false", the user will be able to edit only, the corresponding commenting functionality will be available for viewing only, the adding and editing of comments will be unavailable. In case edit is set to "false" and comment is set to "true", the document will be available for commenting only. In case edit is set to "false" and review is set to "false" and fillForms is set to "true" the comments value is not considered and the commenting is not available.
Defines if the document can be downloaded or only viewed or edited online. In case the downloading permission is set to "false" the Download as... menu option will be absent from the File menu. The default value is true. boolean true
Defines if the document can be edited or only viewed. In case the editing permission is set to "true" the File menu will contain the Edit Document menu option; please note that if the editing permission is set to "false" the document will be opened in viewer and you will not be able to switch it to the editor even if the mode parameter is set to edit. The default value is true. boolean true
Defines if the document can be printed or not. In case the printing permission is set to "false" the Print menu option will be absent from the File menu. The default value is true. boolean true
Defines if the forms can be filled. Filling in forms will only be available for the document editor if the mode parameter is set to edit. The default value coincides with the value of the edit or the review parameter. boolean true
In case edit is set to "true" or review is set to "true", the fillForms value is not considered and the form filling is possible. In case edit is set to "false" and review is set to "false" and fillForms is also set to "true", the user can only fill forms in the document. In case edit is set to "false" and review is set to "false" and fillForms is set to "true" the comments value is not considered and the commenting is not available. The form filling only mode is currently available for Document Editor only.
Defines if the document can be reviewed or not. In case the reviewing permission is set to "true" the document status bar will contain the Review menu option; the document review will only be available for the document editor if the mode parameter is set to edit. The default value coincides with the value of the edit parameter. boolean true
In case edit is set to "true" and review is also set to "true", the user will be able to edit the document, accept/reject the changes made and switch to the review mode him-/herself. In case edit is set to "true" and review is set to "false", the user will be able to edit only. In case edit is set to "false" and review is set to "true", the document will be available in review mode only.
Example
var docEditor = new DocsAPI.DocEditor("placeholder", {
    "document": {
        "permissions": {
            "comment": true,
            "download": true,
            "edit": true,
            "fillForms": true,
            "print": true,
            "review": true
        },
        ...
    },
    ...
});