| Class info |
| public static final class File.Capabilities extends GenericJson |
| Class of the current user's permissions for the current file. Each permission corresponds to an action that can be taken by the user. |
| Constructor name |
| File.Capabilities() Constructor for the File.Capabilities class. |
| Return type | Method name |
| File.Capabilities | clone() Clones a File.Capabilities object. |
| Boolean | getAddChildNodePermission() Checks whether the current user can add children to the folder. |
| Boolean | getWriterHasCopyPermission() Checks whether the current user can change the value of writerHasCopyPermission for the file. |
| Boolean | getCommentPermission() Checks whether the current user can comment on the file. |
| Boolean | getCopyPermission() Checks whether the current user can copy the file. |
| Boolean | getDeletePermission() Checks whether the current user can delete the file. |
| Boolean | getDeleteChildNodePermission() Checks whether the current user can delete children from the folder. |
| Boolean | getDownloadPermission() Checks whether the current user can download the file. |
| Boolean | getEditPermission() Checks whether the current user can edit the file. |
| Boolean | getListChildNodePermission() Checks whether the current user can query children of the folder. |
| Boolean | getReadHistoryVersionPermission() Checks whether the current user can read revision records of the file. |
| Boolean | getRemoveChildNodePermission() Checks whether the current user can remove children from the folder. |
| Boolean | getRenameFilePermission() Checks whether the current user can rename the file. |
| Boolean | getShareFilePermission() Checks whether the current user can modify the sharing settings for the file. |
| Boolean | getRecyclePermission() Checks whether the current user can move the file to the recycle bin. |
| Boolean | getRecyleChildNodePermission() Checks whether the current user can move children of the folder to the recycle bin. |
| Boolean | getUnrecyclePermission() Checks whether the current user can restore the file from recycle bin. |
| File.Capabilities | set (String fieldName, Object value) Sets the given field value for the given field name. |
| File.Capabilities | setAddChildNodePermission (Boolean addChildNodePermission) Sets whether the current user can add children to the folder. |
| File.Capabilities | setWriterHasCopyPermission (Boolean writerHasCopyPermission) Sets whether the current user can change the value of writerHasCopyPermission for the file. |
| File.Capabilities | setCommentPermission(Boolean commentPermission) Sets whether the current user can comment on the file. |
| File.Capabilities | setCopyPermission (Boolean copyPermission) Sets whether the current user can copy the file. |
| File.Capabilities | setDeletePermission (Boolean deletePermission) Sets whether the current user can delete the file. |
| File.Capabilities | setDeleteChildNodePermission (Boolean deleteChildNodePermission) Sets whether the current user can delete children from the folder. |
| File.Capabilities | setDownloadPermission (Boolean downloadPermission) Sets whether the current user can download the file. |
| File.Capabilities | setEditPermission (Boolean editPermission) Sets whether the current user can edit the file. |
| File.Capabilities | setRenameFilePermission (Boolean renameFilePermission) Sets whether the current user can rename the file. |
| File.Capabilities | setShareFilePermission (Boolean shareFilePermission) Sets whether the current user can modify the sharing settings for the file. |
| File.Capabilities | setRecyclePermission (Boolean recyclePermission) Sets whether the current user can move the file to the recycle bin. |
| File.Capabilities | setRecycleChildNodePermission (Boolean recycleChildNodePermission) Sets whether the current user can move children of the folder to the recycle bin. |
| File.Capabilities | setUnrecyclePermission (Boolean unrecyclePermission) Sets whether the current user can restore the file from recycle bin. |
| Boolean | getEditContentPermission() Checks whether the current user can modify the content of the file. |
| File.Capabilities | setEditContentPermission (Boolean editContentPermission) Sets whether the current user can modify the content of the file. |
| File.Capabilities | setListChildNodePermission(Boolean listChildNodePermission) Sets whether the current user can query children of the folder. |
| File.Capabilities | setRemoveChildNodePermission(Boolean removeChildNodePermission) Sets whether the current user can remove children from the folder. |
| File.Capabilities | setReadHistoryVersionPermission(Boolean readHistoryVersionPermission) Sets whether the current user can read revision records of the file. |
| constructor |
| File.Capabilities() |
| Constructs a File.Capabilities object. |
| Method |
| public File.Capabilities clone() |
| Clones a File.Capabilities object. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public Boolean getAddChildNodePermission() |
| Checks whether the current user can add children to the folder. |
Return
| type | desc |
| Boolean | Whether the current user can add children to the folder. |
| Method |
| public Boolean getWriterHasCopyPermission() |
| Checks whether the current user can change the value of writerHasCopyPermission for the file. |
Return
| type | desc |
| Boolean | Whether the current user can change the value of writerHasCopyPermission for the file. The writerHasCopyPermission specifies whether readers and commenters of a file have the copy, print, and download permissions for the file. |
| Method |
| public Boolean getCommentPermission() |
| Checks whether the current user can comment on the file. |
Return
| type | desc |
| Boolean | Whether the current user can comment on the file. |
| Method |
| public Boolean getCopyPermission() |
| Checks whether the current user can copy the file. |
Return
| type | desc |
| Boolean | Whether the current user can copy the file. |
| Method |
| public Boolean getDeletePermission() |
| Checks whether the current user can delete the file. |
Return
| type | desc |
| Boolean | Whether the current user can delete the file. |
| Method |
| public Boolean getDeleteChildNodePermission() |
| Checks whether the current user can delete children from the folder. |
Return
| type | desc |
| Boolean | Whether the current user can delete children from the folder. |
| Method |
| public Boolean getDownloadPermission() |
| Checks whether the current user can download the file. |
Return
| type | desc |
| Boolean | Whether the current user can download the file. |
| Method |
| public Boolean getEditPermission() |
| Checks whether the current user can edit the file. |
Return
| type | desc |
| Boolean | Whether the current user can edit the file. |
| Method |
| public Boolean getListChildNodePermission() |
| Checks whether the current user can query children of the folder. |
Return
| type | desc |
| Boolean | Whether the current user can query children of the folder. |
| Method |
| public Boolean getReadHistoryVersionPermission() |
| Checks whether the current user can read revision records of the file. |
Return
| type | desc |
| Boolean | Whether the current user can read revision records of the file. |
| Method |
| public Boolean getRemoveChildNodePermission() |
| Checks whether the current user can remove children from the folder. |
Return
| type | desc |
| Boolean | Whether the current user can remove children from the folder. |
| Method |
| public Boolean getRenameFilePermission() |
| Checks whether the current user can rename the file. |
Return
| type | desc |
| Boolean | Whether the current user can rename the file. |
| Method |
| public Boolean getShareFilePermission() |
| Checks whether the current user can modify the sharing settings for the file. |
Return
| type | desc |
| Boolean | Whether the current user can modify the sharing settings for the file. |
| Method |
| public Boolean getRecyclePermission() |
| Checks whether the current user can move the file to the recycle bin. |
Return
| type | desc |
| Boolean | Whether the current user can move the file to the recycle bin. |
| Method |
| public Boolean getRecycleChildNodePermission() |
| Checks whether the current user can move children of the folder to the recycle bin. |
Return
| type | desc |
| Boolean | Whether the current user can move children of the folder to the recycle bin. |
| Method |
| public Boolean getUnrecyclePermission() |
| Checks whether the current user can restore the file from recycle bin. |
Return
| type | desc |
| Boolean | Whether the current user can restore the file from recycle bin. |
| Method |
| public File.Capabilities set(String fieldName, Object value) |
| Sets the given field value for the given field name. |
Parameters
| Parameter name | Parameter desc |
| fieldName | Field name. |
| value | Field value. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setAddChildNodePermission(Boolean addChildNodePermission) |
| Sets whether the current user can add children to the folder. |
Parameters
| Parameter name | Parameter desc |
| addChildNodePermission | Indicates whether the current user can add children to the folder. The value is of the Boolean type. true: The current user can add children to the folder. false: The current user cannot add children to the folder. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setWriterHasCopyPermission(Boolean writerHasCopyPermission) |
| Sets whether the current user can change the value of writerHasCopyPermission for the file. |
Parameters
| Parameter name | Parameter desc |
| writerHasCopyPermission | Indicates whether the current user can change the value of writerHasCopyPermission for the file. The value is of the Boolean type. The writerHasCopyPermission specifies whether readers and commenters of a file have the copy, print, and download permissions for the file. true: Readers and commenters of a file do not have the copy, print, and download permissions for the file. false: Readers and commenters of a file have the copy, print, and download permissions for the file. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setCommentPermission(Boolean commentPermission) |
| Sets whether the current user can comment on the file. |
Parameters
| Parameter name | Parameter desc |
| commentPermission | Indicates whether the current user can comment on the file. The value is of the Boolean type. true: The current user can comment on the file. false: The current user cannot comment on the file. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setCopyPermission(Boolean copyPermission) |
| Sets whether the current user can copy the file. |
Parameters
| Parameter name | Parameter desc |
| copyPermission | Indicates whether the current user can copy the file. The value is of the Boolean type. true: The current user can copy the file. false: The current user cannot copy the file. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setDeletePermission(Boolean deletePermission) |
| Sets whether the current user can delete the file. |
Parameters
| Parameter name | Parameter desc |
| deletePermission | Indicates whether the current user can delete the file. The value is of the Boolean type. true: The current user can delete the file. false: The current user cannot delete the file. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setDeleteChildNodePermission(Boolean deleteChildNodePermission) |
| Sets whether the current user can delete children from the folder. |
Parameters
| Parameter name | Parameter desc |
| deleteChildNodePermission | Indicates whether the current user can delete children from the folder. The value is of the Boolean type. true: The current user can delete children from the folder. false: The current user cannot delete children from the folder. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setDownloadPermission(Boolean downloadPermission) |
| Sets whether the current user can download the file. |
Parameters
| Parameter name | Parameter desc |
| downloadPermission | Indicates whether the current user can download the file. The value is of the Boolean type. true: The current user can download the file. false: The current user cannot download the file. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
public File.Capabilities setEditPermission(Boolean editPermission) |
| Sets whether the current user can edit the file. |
Parameters
| Parameter name | Parameter desc |
| editPermission | Indicates whether the current user can edit the file. The value is of the Boolean type. true: The current user can edit the file. false: The current user cannot edit the file. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setRenameFilePermission(Boolean renameFilePermission) |
| Sets whether the current user can rename the file. |
Parameters
| Parameter name | Parameter desc |
| renameFilePermission | Indicates whether the current user can rename the file. The value is of the Boolean type. true: The current user can rename the file. false: The current user cannot rename the file. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setShareFilePermission(Boolean shareFilePermission) |
| Sets whether the current user can modify the sharing settings for the file. |
Parameters
| Parameter name | Parameter desc |
| shareFilePermission | Indicates whether the current user can modify the sharing settings for the file. The value is of the Boolean type. true: The current user can modify the sharing settings for the file. false: The current user cannot modify the sharing settings for the file. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setRecyclePermission(Boolean recyclePermission) |
| Sets whether the current user can move the file to the recycle bin. |
Parameters
| Parameter name | Parameter desc |
| recyclePermission | Indicates whether the current user can move the file to the recycle bin. The value is of the Boolean type. true: The current user can move the file to the recycle bin. false: The current user cannot move the file to the recycle bin. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
public File.Capabilities setRecyleChildNodePermission(Boolean recycleChildNodePermission) |
| Sets whether the current user can move children of the folder to the recycle bin. |
Parameters
| Parameter name | Parameter desc |
| recycleChildNodePermission | Indicates whether the current user can move children of the folder to the recycle bin. The value is of the Boolean type. true: The current user can move children of the folder recycle bin. false: The current user cannot move children of the folder to the recycle bin. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setUnrecyclePermission(Boolean unrecyclePermission) |
| Sets whether the current user can restore the file from recycle bin. |
Parameters
| Parameter name | Parameter desc |
| unrecyclePermission | Indicates whether the current user can restore the file from recycle bin. The value is of the Boolean type. true: The current user can restore the file from recycle bin. false: The current user cannot restore the file from recycle bin. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public Boolean getEditContentPermission() |
| Checks whether the current user can modify the content of the file. |
Return
| type | desc |
| Boolean | Whether the current user can modify the content of the file. true: The current user can modify the content of the file. false: The current user cannot modify the content of the file. |
| Method |
| public File.Capabilities setEditContentPermission (Boolean editContentPermission) |
| Sets whether the current user can modify the content of the file. |
Parameters
| Parameter name | Parameter desc |
| editContentPermission | Indicates whether the current user can modify the content of the file. The value is of the Boolean type. true: The current user can modify the content of the file. false: The current user cannot modify the content of the file. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setListChildNodePermission(Boolean listChildNodePermission) |
| Sets whether the current user can query children of the folder. |
Parameters
| Parameter name | Parameter desc |
| listChildNodePermission | Indicates whether the current user can query children of the folder. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setRemoveChildNodePermission(Boolean removeChildNodePermission) |
| Sets whether the current user can remove children from the folder. |
Parameters
| Parameter name | Parameter desc |
| removeChildNodePermission | Indicates whether the current user can remove children from the folder. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |
| Method |
| public File.Capabilities setReadHistoryVersionPermission(Boolean readHistoryVersionPermission) |
| Sets whether the current user can read revision records of the file. |
Parameters
| Parameter name | Parameter desc |
| readHistoryVersionPermission | Indicates whether the current user can read revision records of the file. |
Return
| type | desc |
| File.Capabilities | A File.Capabilities object. |