Struct dropbox_sdk::sharing::SharedFileMetadata

#[non_exhaustive]
pub struct SharedFileMetadata {

    pub id: FileId,
    pub name: String,
    pub policy: FolderPolicy,
    pub preview_url: String,
    pub access_type: Option<AccessLevel>,
    pub expected_link_metadata: Option<ExpectedSharedContentLinkMetadata>,
    pub link_metadata: Option<SharedContentLinkMetadata>,
    pub owner_display_names: Option<Vec<String>>,
    pub owner_team: Option<Team>,
    pub parent_shared_folder_id: Option<SharedFolderId>,
    pub path_display: Option<String>,
    pub path_lower: Option<String>,
    pub permissions: Option<Vec<FilePermission>>,
    pub time_invited: Option<DropboxTimestamp>,
}

This is supported on crate feature dbx_sharing only.

Properties of the shared file.

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.

id: FileId

The ID of the file.

name: String

The name of this file.

policy: FolderPolicy

Policies governing this shared file.

preview_url: String

URL for displaying a web preview of the shared file.

access_type: Option<AccessLevel>

The current user’s access level for this shared file.

expected_link_metadata: Option<ExpectedSharedContentLinkMetadata>

The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet.

link_metadata: Option<SharedContentLinkMetadata>

The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet.

owner_display_names: Option<Vec<String>>

The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.

owner_team: Option<Team>

The team that owns the file. This field is not present if the file is not owned by a team.

parent_shared_folder_id: Option<SharedFolderId>

The ID of the parent shared folder. This field is present only if the file is contained within a shared folder.

path_display: Option<String>

The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user’s filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files.

path_lower: Option<String>

The lower-case full path of this file. Absent for unmounted files.

permissions: Option<Vec<FilePermission>>

The sharing permissions that requesting user has on this file. This corresponds to the entries given in GetFileMetadataBatchArg::actions or GetFileMetadataArg::actions.

time_invited: Option<DropboxTimestamp>

Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

Implementations

impl SharedFileMetadata

pub fn new(
    id: FileId,
    name: String,
    policy: FolderPolicy,
    preview_url: String
) -> Self

pub fn with_access_type(self, value: AccessLevel) -> Self

pub fn with_expected_link_metadata(
    self,
    value: ExpectedSharedContentLinkMetadata
) -> Self

pub fn with_link_metadata(self, value: SharedContentLinkMetadata) -> Self

pub fn with_owner_display_names(self, value: Vec<String>) -> Self

pub fn with_owner_team(self, value: Team) -> Self

pub fn with_parent_shared_folder_id(self, value: SharedFolderId) -> Self

pub fn with_path_display(self, value: String) -> Self

pub fn with_path_lower(self, value: String) -> Self

pub fn with_permissions(self, value: Vec<FilePermission>) -> Self

pub fn with_time_invited(self, value: DropboxTimestamp) -> Self

Trait Implementations

impl Clone for SharedFileMetadata

fn clone(&self) -> SharedFileMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedFileMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SharedFileMetadata

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<SharedFileMetadata> for SharedFileMetadata

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for SharedFileMetadata

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SharedFileMetadata