Class SharedFileMetadata

Properties of the shared file.

Inheritance

System.Object

SharedFileMetadata

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dropbox.Api.Sharing

Assembly: Dropbox.Api.dll

Syntax

public class SharedFileMetadata

Constructors

SharedFileMetadata(String, String, FolderPolicy, String, AccessLevel, ExpectedSharedContentLinkMetadata, SharedContentLinkMetadata, IEnumerable<String>, Team, String, String, String, IEnumerable<FilePermission>, Nullable<DateTime>)

Initializes a new instance of the SharedFileMetadata class.

Declaration

public SharedFileMetadata(string id, string name, FolderPolicy policy, string previewUrl, AccessLevel accessType = null, ExpectedSharedContentLinkMetadata expectedLinkMetadata = null, SharedContentLinkMetadata linkMetadata = null, IEnumerable<string> ownerDisplayNames = null, Team ownerTeam = null, string parentSharedFolderId = null, string pathDisplay = null, string pathLower = null, IEnumerable<FilePermission> permissions = null, DateTime? timeInvited = null)

Parameters

Type	Name	Description
System.String	id	The ID of the file.
System.String	name	The name of this file.
FolderPolicy	policy	Policies governing this shared file.
System.String	previewUrl	URL for displaying a web preview of the shared file.
AccessLevel	accessType	The current user's access level for this shared file.
ExpectedSharedContentLinkMetadata	expectedLinkMetadata	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.
SharedContentLinkMetadata	linkMetadata	The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet.
System.Collections.Generic.IEnumerable<System.String>	ownerDisplayNames	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.
Team	ownerTeam	The team that owns the file. This field is not present if the file is not owned by a team.
System.String	parentSharedFolderId	The ID of the parent shared folder. This field is present only if the file is contained within a shared folder.
System.String	pathDisplay	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.
System.String	pathLower	The lower-case full path of this file. Absent for unmounted files.
System.Collections.Generic.IEnumerable<FilePermission>	permissions	The sharing permissions that requesting user has on this file. This corresponds to the entries given in Actions or Actions.
System.Nullable<System.DateTime>	timeInvited	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.

Properties

AccessType

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

Declaration

public AccessLevel AccessType { get; protected set; }

Property Value

Type	Description
AccessLevel

ExpectedLinkMetadata

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.

Declaration

public ExpectedSharedContentLinkMetadata ExpectedLinkMetadata { get; protected set; }

Property Value

Type	Description
ExpectedSharedContentLinkMetadata

Id

The ID of the file.

Declaration

public string Id { get; protected set; }

Property Value

Type	Description
System.String

LinkMetadata

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

Declaration

public SharedContentLinkMetadata LinkMetadata { get; protected set; }

Property Value

Type	Description
SharedContentLinkMetadata

Name

The name of this file.

Declaration

public string Name { get; protected set; }

Property Value

Type	Description
System.String

OwnerDisplayNames

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.

Declaration

public IList<string> OwnerDisplayNames { get; protected set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

OwnerTeam

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

Declaration

public Team OwnerTeam { get; protected set; }

Property Value

Type	Description
Team

ParentSharedFolderId

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

Declaration

public string ParentSharedFolderId { get; protected set; }

Property Value

Type	Description
System.String

PathDisplay

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.

Declaration

public string PathDisplay { get; protected set; }

Property Value

Type	Description
System.String

PathLower

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

Declaration

public string PathLower { get; protected set; }

Property Value

Type	Description
System.String

Permissions

The sharing permissions that requesting user has on this file. This corresponds to the entries given in Actions or Actions.

Declaration

public IList<FilePermission> Permissions { get; protected set; }

Property Value

Type	Description
System.Collections.Generic.IList<FilePermission>

Policy

Policies governing this shared file.

Declaration

public FolderPolicy Policy { get; protected set; }

Property Value

Type	Description
FolderPolicy

PreviewUrl

URL for displaying a web preview of the shared file.

Declaration

public string PreviewUrl { get; protected set; }

Property Value

Type	Description
System.String

TimeInvited

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.

Declaration

public DateTime? TimeInvited { get; protected set; }

Property Value

Type	Description
System.Nullable<System.DateTime>