com.onlyoffice.model.documenteditor.config.document

Class Permissions

java.lang.Object

com.onlyoffice.model.documenteditor.config.document.Permissions

public class Permissions
extends Object

Defines the permission for the document to be edited and downloaded or not.

Field Summary

Fields

Modifier and Type	Field and Description
private Boolean	chat Defines if the chat functionality is enabled in the document or not.
private Boolean	comment Defines if the document can be commented or not.
private CommentGroups	commentGroups Defines the groups whose comments the user can edit, remove and/or view.
private Boolean	copy Defines if the content can be copied to the clipboard or not.
private Boolean	deleteCommentAuthorOnly Defines if the user can delete only his/her comments.
private Boolean	download Defines if the document can be downloaded or only viewed or edited online.
private Boolean	edit Defines if the document can be edited or only viewed.
private Boolean	editCommentAuthorOnly Defines if the user can edit only his/her comments.
private Boolean	fillForms Defines if the forms can be filled.
private Boolean	modifyContentControl Defines if the content control settings can be changed.
private Boolean	modifyFilter Defines if the filter can applied globally ("true") affecting all the other users, or locally ("false"), i.e.
private Boolean	print Defines if the document can be printed or not.
private Boolean	protect Defines if the "Protection" tab on the toolbar and the "Protect" button in the left menu are displayed ("true") or hidden ("false").
private Boolean	rename Deprecated.
private Boolean	review Defines if the document can be reviewed or not.
private List<String>	reviewGroups Defines the groups whose changes the user can accept/reject.
private List<String>	userInfoGroups Defines the groups of users whose information is displayed in the editors: 1) the usernames are displayed in the list of the editing users in the editor header, 2) when typing text, the user cursors and tooltips with their names are displayed, 3) when locking objects in the strict co-editing mode, the usernames are displayed.

Constructor Summary

Constructors

Constructor and Description
Permissions()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

chat

private Boolean chat

Defines if the chat functionality is enabled in the document or not. In case the chat permission is set to "true", the "Chat" menu button will be displayed. The default value is "true".

comment

private Boolean comment

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.

commentGroups

private CommentGroups commentGroups

Defines the groups whose comments the user can edit, remove and/or view. The [""] value means that the user can edit/remove/view comments made by someone who belongs to none of these groups (for example, if the document is reviewed in third-party editors). If the value is [], the user cannot edit/remove/view comments made by any group. If the "edit", "remove" and "view" parameters are "" or not specified, then the user can view/edit/remove comments made by any user.

copy

private Boolean copy

Defines if the content can be copied to the clipboard or not. In case the parameter is set to "false", pasting the content will be available within the current document editor only. The default value is "true".

deleteCommentAuthorOnly

private Boolean deleteCommentAuthorOnly

Defines if the user can delete only his/her comments. The default value is "false".

download

private Boolean download

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".

edit

private Boolean edit

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".

editCommentAuthorOnly

private Boolean editCommentAuthorOnly

Defines if the user can edit only his/her comments. The default value is "false".

fillForms

private Boolean fillForms

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.

modifyContentControl

private Boolean modifyContentControl

Defines if the content control settings can be changed. Content control modification will only be available for the document editor if the mode parameter is set to "edit". The default value is "true".

modifyFilter

private Boolean modifyFilter

Defines if the filter can applied globally ("true") affecting all the other users, or locally ("false"), i.e. for the current user only. Filter modification will only be available for the spreadsheet editor if the mode parameter is set to "edit". The default value is "true".

print

private Boolean print

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".

protect

private Boolean protect

Defines if the "Protection" tab on the toolbar and the "Protect" button in the left menu are displayed ("true") or hidden ("false"). The default value is "true"

rename

@Deprecated
private Boolean rename

Deprecated.

Defines if the "Rename..." button is displayed when using the "onRequestRename" event. The default value is "false". Deprecated since version 6.0, please add the "onRequestRename" field instead.

See Also:

"onRequestRename" event in API ONLYOFFICE

review

private Boolean review

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.

reviewGroups

private List<String> reviewGroups

Defines the groups whose changes the user can accept/reject. The [""] value means that the user can review changes made by someone who belongs to none of these groups (for example, if the document is reviewed in third-party editors). If the value is [], the user cannot review changes made by any group. If the value is "" or not specified, then the user can review changes made by any user.

userInfoGroups

private List<String> userInfoGroups

Defines the groups of users whose information is displayed in the editors: 1) the usernames are displayed in the list of the editing users in the editor header, 2) when typing text, the user cursors and tooltips with their names are displayed, 3) when locking objects in the strict co-editing mode, the usernames are displayed. The ["Group1", ""] means that the information about users from Group1 and users who don't belong to any group is displayed. The [] means that no user information is displayed at all. The "undefined" or "" values mean that the information about all users is displayed.

Constructor Detail

Permissions

public Permissions()