Show / Hide Table of Contents

Class ListFolderArg

The list folder arg object

Inheritance
System.Object
ListFolderArg
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.Files
Assembly: Dropbox.Api.dll
Syntax
public class ListFolderArg

Constructors

| Improve this Doc View Source

ListFolderArg(String, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<UInt32>, SharedLink, TemplateFilterBase, Boolean)

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)
Parameters
Type Name Description
System.String path

A unique identifier for the file.

System.Boolean recursive

If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.

System.Boolean includeMediaInfo

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

System.Boolean includeDeleted

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

System.Boolean includeHasExplicitSharedMembers

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

System.Boolean includeMountedFolders

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

System.Nullable<System.UInt32> 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.

System.Boolean includeNonDownloadableFiles

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

Properties

| Improve this Doc View Source

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
System.Boolean
| Improve this Doc View Source

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
System.Boolean
| Improve this Doc View Source

IncludeMediaInfo

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
System.Boolean
| Improve this Doc View Source

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
System.Boolean
| Improve this Doc View Source

IncludeNonDownloadableFiles

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

Declaration
public bool IncludeNonDownloadableFiles { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

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
| Improve this Doc View Source

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
System.Nullable<System.UInt32>
| Improve this Doc View Source

Path

A unique identifier for the file.

Declaration
public string Path { get; protected set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Recursive

If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.

Declaration
public bool Recursive { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

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
  • Improve this Doc
  • View Source
In This Article
  • Constructors
    • ListFolderArg(String, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<UInt32>, SharedLink, TemplateFilterBase, Boolean)
  • Properties
    • IncludeDeleted
    • IncludeHasExplicitSharedMembers
    • IncludeMediaInfo
    • IncludeMountedFolders
    • IncludeNonDownloadableFiles
    • IncludePropertyGroups
    • Limit
    • Path
    • Recursive
    • SharedLink
Back to top Generated by DocFX