Class AddDocumentEntityJson

  • All Implemented Interfaces:
    Serializable

    public class AddDocumentEntityJson
    extends BaseJson
    Give user permissions to a particular workspace file only.
    See Also:
    Serialized Form
    • Constructor Detail

      • AddDocumentEntityJson

        public AddDocumentEntityJson()
    • Method Detail

      • getDocumentGuids

        public Set<String> getDocumentGuids()
        Set of file guids
        Returns:
        Set of file guids
      • setDocumentGuids

        public void setDocumentGuids​(Set<String> documentGuids)
        Set of file guids
        Parameters:
        documentGuids - Set of file guids
      • getGroupMembers

        public AddMembersToGroupJson getGroupMembers()
        In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.
        Returns:
        In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.
      • setGroupMembers

        public void setGroupMembers​(AddMembersToGroupJson groupMembers)
        In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.
        Parameters:
        groupMembers - In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.
      • setPermittedEntity

        public void setPermittedEntity​(PermittedEntityFromUserJson permittedEntity)
        Single Entity to add
        Parameters:
        permittedEntity - Single Entity to add
      • getIdentifier

        public String getIdentifier()
        Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations. Relevant only if permittedEntity is a roomGroup
        Returns:
        Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations. Relevant only if permittedEntity is a roomGroup
      • setIdentifier

        public void setIdentifier​(String identifier)
        Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations. Relevant only if permittedEntity is a roomGroup
        Parameters:
        identifier - Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations. Relevant only if permittedEntity is a roomGroup
      • getRoomGuid

        public String getRoomGuid()
        Guid of the workspace
        Returns:
        Guid of the workspace
      • setRoomGuid

        public void setRoomGuid​(String roomGuid)
        Guid of the workspace
        Parameters:
        roomGuid - Guid of the workspace
      • getPermissionsTemplate

        public PermissionsTemplateRequestJson getPermissionsTemplate()
        Permission template to apply to files
        Returns:
        Permission template to apply to files
      • setPermissionsTemplate

        public void setPermissionsTemplate​(PermissionsTemplateRequestJson permissionsTemplate)
        Permission template to apply to files
        Parameters:
        permissionsTemplate - Permission template to apply to files
      • getRole

        public String getRole()
        The new role in the workspace.
        Returns:
        The new role in the workspace.
      • setRole

        public void setRole​(String role)
        The new role in the workspace.
        Parameters:
        role - The new role in the workspace.
      • isIsSendMail

        public boolean isIsSendMail()
        Flag indicating that a notification email should be sent to recipients
        Returns:
        Flag indicating that a notification email should be sent to recipients
      • getIsSendMail

        @Deprecated
        public boolean getIsSendMail()
        Deprecated.
        Flag indicating that a notification email should be sent to recipients
        Returns:
        Flag indicating that a notification email should be sent to recipients
      • setIsSendMail

        public void setIsSendMail​(boolean isSendMail)
        Flag indicating that a notification email should be sent to recipients
        Parameters:
        isSendMail - Flag indicating that a notification email should be sent to recipients
      • getDescription

        public String getDescription()
        Set description (only for groups)
        Returns:
        Set description (only for groups)
      • setDescription

        public void setDescription​(String description)
        Set description (only for groups)
        Parameters:
        description - Set description (only for groups)
      • getEmailSubject

        public String getEmailSubject()
        Subject line for notification email
        Returns:
        Subject line for notification email
      • setEmailSubject

        public void setEmailSubject​(String emailSubject)
        Subject line for notification email
        Parameters:
        emailSubject - Subject line for notification email
      • getRoomId

        public Integer getRoomId()
        Id of the workspace
        Returns:
        Id of the workspace
      • setRoomId

        public void setRoomId​(Integer roomId)
        Id of the workspace
        Parameters:
        roomId - Id of the workspace
      • getEmailMessage

        public String getEmailMessage()
        Text of email
        Returns:
        Text of email
      • setEmailMessage

        public void setEmailMessage​(String emailMessage)
        Text of email
        Parameters:
        emailMessage - Text of email
      • isIsWatermark

        public boolean isIsWatermark()
      • getIsWatermark

        @Deprecated
        public boolean getIsWatermark()
        Deprecated.
      • setIsWatermark

        public void setIsWatermark​(boolean isWatermark)
      • getExpirationDate

        public Date getExpirationDate()
        Use the expiration field on the permissionsTemplate
        Returns:
        Use the expiration field on the permissionsTemplate
      • setExpirationDate

        public void setExpirationDate​(Date expirationDate)
        Use the expiration field on the permissionsTemplate
        Parameters:
        expirationDate - Use the expiration field on the permissionsTemplate