Struct LinkPermissions

#[non_exhaustive]
pub struct LinkPermissions {

    pub can_revoke: bool,
    pub visibility_policies: Vec<VisibilityPolicy>,
    pub can_set_expiry: bool,
    pub can_remove_expiry: bool,
    pub allow_download: bool,
    pub can_allow_download: bool,
    pub can_disallow_download: bool,
    pub allow_comments: bool,
    pub team_restricts_comments: bool,
    pub resolved_visibility: Option<ResolvedVisibility>,
    pub requested_visibility: Option<RequestedVisibility>,
    pub revoke_failure_reason: Option<SharedLinkAccessFailureReason>,
    pub effective_audience: Option<LinkAudience>,
    pub link_access_level: Option<LinkAccessLevel>,
    pub audience_options: Option<Vec<LinkAudienceOption>>,
    pub can_set_password: Option<bool>,
    pub can_remove_password: Option<bool>,
    pub require_password: Option<bool>,
    pub can_use_extended_sharing_controls: Option<bool>,
}

Available on crate features sync_routes and dbx_sharing only.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

can_revoke: bool

Whether the caller can revoke the shared link.

visibility_policies: Vec<VisibilityPolicy>

A list of policies that the user might be able to set for the visibility.

can_set_expiry: bool

Whether the user can set the expiry settings of the link. This refers to the ability to create a new expiry and modify an existing expiry.

can_remove_expiry: bool

Whether the user can remove the expiry of the link.

allow_download: bool

Whether the link can be downloaded or not.

can_allow_download: bool

Whether the user can allow downloads via the link. This refers to the ability to remove a no-download restriction on the link.

can_disallow_download: bool

Whether the user can disallow downloads via the link. This refers to the ability to impose a no-download restriction on the link.

allow_comments: bool

Whether comments are enabled for the linked file. This takes the team commenting policy into account.

team_restricts_comments: bool

Whether the team has disabled commenting globally.

resolved_visibility: Option<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.

requested_visibility: Option<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 resolved_visibility. This is shown only if the caller is the link’s owner and resolved_visibility is returned instead of effective_audience.

revoke_failure_reason: Option<SharedLinkAccessFailureReason>

The failure reason for revoking the link. This field will only be present if the can_revoke is false.

effective_audience: Option<LinkAudience>

The type of audience who can benefit from the access level specified by the link_access_level field.

link_access_level: Option<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.

audience_options: Option<Vec<LinkAudienceOption>>

A list of link audience options the user might be able to set as the new audience.

can_set_password: Option<bool>

Whether the user can set a password for the link.

can_remove_password: Option<bool>

Whether the user can remove the password of the link.

require_password: Option<bool>

Whether the user is required to provide a password to view the link.

can_use_extended_sharing_controls: Option<bool>

Whether the user can use extended sharing controls, based on their account type.

Implementations

impl LinkPermissions

pub fn new( can_revoke: bool, visibility_policies: Vec<VisibilityPolicy>, can_set_expiry: bool, can_remove_expiry: bool, allow_download: bool, can_allow_download: bool, can_disallow_download: bool, allow_comments: bool, team_restricts_comments: bool, ) -> Self

pub fn with_resolved_visibility(self, value: ResolvedVisibility) -> Self

pub fn with_requested_visibility(self, value: RequestedVisibility) -> Self

pub fn with_revoke_failure_reason( self, value: SharedLinkAccessFailureReason, ) -> Self

pub fn with_effective_audience(self, value: LinkAudience) -> Self

pub fn with_link_access_level(self, value: LinkAccessLevel) -> Self

pub fn with_audience_options(self, value: Vec<LinkAudienceOption>) -> Self

pub fn with_can_set_password(self, value: bool) -> Self

pub fn with_can_remove_password(self, value: bool) -> Self

pub fn with_require_password(self, value: bool) -> Self

pub fn with_can_use_extended_sharing_controls(self, value: bool) -> Self

Trait Implementations

impl Clone for LinkPermissions

fn clone(&self) -> LinkPermissions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LinkPermissions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LinkPermissions

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for LinkPermissions

fn eq(&self, other: &LinkPermissions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LinkPermissions

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for LinkPermissions

impl StructuralPartialEq for LinkPermissions