Package com.dropbox.core.v2.sharing

Class LinkPermissions.Builder

    • Field Detail

      • canRevoke

        protected final boolean canRevoke

      • visibilityPolicies

        protected final java.util.List<VisibilityPolicy> visibilityPolicies

      • canSetExpiry

        protected final boolean canSetExpiry

      • canRemoveExpiry

        protected final boolean canRemoveExpiry

      • allowDownload

        protected final boolean allowDownload

      • canAllowDownload

        protected final boolean canAllowDownload

      • canDisallowDownload

        protected final boolean canDisallowDownload

      • allowComments

        protected final boolean allowComments

      • teamRestrictsComments

        protected final boolean teamRestrictsComments

      • effectiveAudience

        protected LinkAudience effectiveAudience

      • canSetPassword

        protected java.lang.Boolean canSetPassword

      • canRemovePassword

        protected java.lang.Boolean canRemovePassword

      • requirePassword

        protected java.lang.Boolean requirePassword

      • canUseExtendedSharingControls

        protected java.lang.Boolean canUseExtendedSharingControls

    • Constructor Detail

      • Builder

        protected Builder​(boolean canRevoke,
                  java.util.List<VisibilityPolicy> visibilityPolicies,
                  boolean canSetExpiry,
                  boolean canRemoveExpiry,
                  boolean allowDownload,
                  boolean canAllowDownload,
                  boolean canDisallowDownload,
                  boolean allowComments,
                  boolean teamRestrictsComments)

    • Method Detail

      • withResolvedVisibility

        public LinkPermissions.Builder withResolvedVisibility​(ResolvedVisibility resolvedVisibility)
        Set value for optional field.
        Parameters:
        resolvedVisibility - The current visibility of the link after considering the shared links policies of the the team (in case the link's owner is part of a team) and the shared folder (in case the linked file is part of a shared folder). This field is shown only if the caller has access to this info (the link's owner always has access to this data). For some links, an effective_audience value is returned instead.
        Returns:
        this builder

      • withRequestedVisibility

        public LinkPermissions.Builder withRequestedVisibility​(RequestedVisibility requestedVisibility)
        Set value for optional field.
        Parameters:
        requestedVisibility - The shared link's requested visibility. This can be overridden by the team and shared folder policies. The final visibility, after considering these policies, can be found in LinkPermissions.getResolvedVisibility(). This is shown only if the caller is the link's owner and resolved_visibility is returned instead of effective_audience.
        Returns:
        this builder

      • withEffectiveAudience

        public LinkPermissions.Builder withEffectiveAudience​(LinkAudience effectiveAudience)
        Set value for optional field.
        Parameters:
        effectiveAudience - The type of audience who can benefit from the access level specified by the `link_access_level` field.
        Returns:
        this builder

      • withLinkAccessLevel

        public LinkPermissions.Builder withLinkAccessLevel​(LinkAccessLevel linkAccessLevel)
        Set value for optional field.
        Parameters:
        linkAccessLevel - The access level that the link will grant to its users. A link can grant additional rights to a user beyond their current access level. For example, if a user was invited as a viewer to a file, and then opens a link with `link_access_level` set to `editor`, then they will gain editor privileges. The `link_access_level` is a property of the link, and does not depend on who is calling this API. In particular, `link_access_level` does not take into account the API caller's current permissions to the content.
        Returns:
        this builder

      • withAudienceOptions

        public LinkPermissions.Builder withAudienceOptions​(java.util.List<LinkAudienceOption> audienceOptions)
        Set value for optional field.
        Parameters:
        audienceOptions - A list of link audience options the user might be able to set as the new audience. Must not contain a null item.
        Returns:
        this builder
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

      • withCanSetPassword

        public LinkPermissions.Builder withCanSetPassword​(java.lang.Boolean canSetPassword)
        Set value for optional field.
        Parameters:
        canSetPassword - Whether the user can set a password for the link.
        Returns:
        this builder

      • withCanRemovePassword

        public LinkPermissions.Builder withCanRemovePassword​(java.lang.Boolean canRemovePassword)
        Set value for optional field.
        Parameters:
        canRemovePassword - Whether the user can remove the password of the link.
        Returns:
        this builder

      • withRequirePassword

        public LinkPermissions.Builder withRequirePassword​(java.lang.Boolean requirePassword)
        Set value for optional field.
        Parameters:
        requirePassword - Whether the user is required to provide a password to view the link.
        Returns:
        this builder

      • withCanUseExtendedSharingControls

        public LinkPermissions.Builder withCanUseExtendedSharingControls​(java.lang.Boolean canUseExtendedSharingControls)
        Set value for optional field.
        Parameters:
        canUseExtendedSharingControls - Whether the user can use extended sharing controls, based on their account type.
        Returns:
        this builder