Class ListFolderArg

The list folder arg object

Inheritance

object

ListFolderArg

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Dropbox.Api.Files

Assembly: Dropbox.Api.dll

Syntax

public class ListFolderArg

Constructors

ListFolderArg(string, bool, bool, bool, bool, bool, uint?, SharedLink, TemplateFilterBase, bool, bool)

Initializes a new instance of the ListFolderArg class.

Declaration

public ListFolderArg(string path, bool recursive = false, bool includeMediaInfo = false, bool includeDeleted = false, bool includeHasExplicitSharedMembers = false, bool includeMountedFolders = true, uint? limit = null, SharedLink sharedLink = null, TemplateFilterBase includePropertyGroups = null, bool includeNonDownloadableFiles = true, bool includeRestorableInfo = false)

Parameters

Type	Name	Description
string	path	A unique identifier for the file.
bool	recursive	If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. In some cases, setting Recursive to true may lead to performance issues or errors, especially when traversing folder structures with a large number of items. A workaround for such cases is to set Recursive to false and traverse subfolders one at a time.
bool	includeMediaInfo	Field is deprecated. If true, MediaInfo is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.
bool	includeDeleted	If true, the results will include entries for files and folders that used to exist but were deleted.
bool	includeHasExplicitSharedMembers	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
bool	includeMountedFolders	If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.
uint?	limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.
SharedLink	sharedLink	A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, Path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.
TemplateFilterBase	includePropertyGroups	If set to a valid list of template IDs, PropertyGroups is set if there exists property data associated with the file and each of the listed templates.
bool	includeNonDownloadableFiles	If true, include files that are not downloadable, i.e. Google Docs.
bool	includeRestorableInfo	If true, each returned deleted entry will include whether that entry can be restored.

Properties

IncludeDeleted

If true, the results will include entries for files and folders that used to exist but were deleted.

Declaration

public bool IncludeDeleted { get; protected set; }

Property Value

Type	Description
bool

IncludeHasExplicitSharedMembers

If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

Declaration

public bool IncludeHasExplicitSharedMembers { get; protected set; }

Property Value

Type	Description
bool

IncludeMediaInfo

Field is deprecated. If true, MediaInfo is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.

Declaration

public bool IncludeMediaInfo { get; protected set; }

Property Value

Type	Description
bool

IncludeMountedFolders

If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.

Declaration

public bool IncludeMountedFolders { get; protected set; }

Property Value

Type	Description
bool

IncludeNonDownloadableFiles

If true, include files that are not downloadable, i.e. Google Docs.

Declaration

public bool IncludeNonDownloadableFiles { get; protected set; }

Property Value

Type	Description
bool

IncludePropertyGroups

If set to a valid list of template IDs, PropertyGroups is set if there exists property data associated with the file and each of the listed templates.

Declaration

public TemplateFilterBase IncludePropertyGroups { get; protected set; }

Property Value

Type	Description
TemplateFilterBase

IncludeRestorableInfo

If true, each returned deleted entry will include whether that entry can be restored.

Declaration

public bool IncludeRestorableInfo { get; protected set; }

Property Value

Type	Description
bool

Limit

The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.

Declaration

public uint? Limit { get; protected set; }

Property Value

Type	Description
uint?

Path

A unique identifier for the file.

Declaration

public string Path { get; protected set; }

Property Value

Type	Description
string

Recursive

If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. In some cases, setting Recursive to true may lead to performance issues or errors, especially when traversing folder structures with a large number of items. A workaround for such cases is to set Recursive to false and traverse subfolders one at a time.

Declaration

public bool Recursive { get; protected set; }

Property Value

Type	Description
bool

SharedLink

A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, Path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.

Declaration

public SharedLink SharedLink { get; protected set; }

Property Value

Type	Description
SharedLink