Class UserPermissions


  • public class UserPermissions
    extends java.lang.Object
    • Constructor Summary

      Constructors 
      Constructor Description
      UserPermissions()
      None
      UserPermissions​(boolean canEdit, boolean canRename, boolean canComment, boolean canDownload)
      Use newBuilder() to create instances of this class without specifying values for all optional fields.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      boolean getCanComment()
      true if the user can comment on this document
      boolean getCanDownload()
      true if the user can download the contents of this document.
      boolean getCanEdit()
      true if the user can edit the content of this document
      boolean getCanRename()
      true if the user can edit the title of this document
      int hashCode()  
      static UserPermissions.Builder newBuilder()
      Returns a new builder for creating an instance of this class.
      java.lang.String toString()  
      java.lang.String toStringMultiline()
      Returns a String representation of this object formatted for easier readability.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • canEdit

        protected final boolean canEdit
      • canRename

        protected final boolean canRename
      • canComment

        protected final boolean canComment
      • canDownload

        protected final boolean canDownload
    • Constructor Detail

      • UserPermissions

        public UserPermissions​(boolean canEdit,
                               boolean canRename,
                               boolean canComment,
                               boolean canDownload)
        Use newBuilder() to create instances of this class without specifying values for all optional fields.
        Parameters:
        canEdit - true if the user can edit the content of this document.
        canRename - true if the user can edit the title of this document.
        canComment - true if the user can comment on this document.
        canDownload - true if the user can download the contents of this document. currently always true if the user has view access to the document.
      • UserPermissions

        public UserPermissions()
        None

        The default values for unset fields will be used.

    • Method Detail

      • getCanEdit

        public boolean getCanEdit()
        true if the user can edit the content of this document
        Returns:
        value for this field, or null if not present. Defaults to false.
      • getCanRename

        public boolean getCanRename()
        true if the user can edit the title of this document
        Returns:
        value for this field, or null if not present. Defaults to false.
      • getCanComment

        public boolean getCanComment()
        true if the user can comment on this document
        Returns:
        value for this field, or null if not present. Defaults to false.
      • getCanDownload

        public boolean getCanDownload()
        true if the user can download the contents of this document. currently always true if the user has view access to the document.
        Returns:
        value for this field, or null if not present. Defaults to false.
      • newBuilder

        public static UserPermissions.Builder newBuilder()
        Returns a new builder for creating an instance of this class.
        Returns:
        builder for this class.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • toStringMultiline

        public java.lang.String toStringMultiline()
        Returns a String representation of this object formatted for easier readability.

        The returned String may contain newlines.

        Returns:
        Formatted, multiline String representation of this object