DBFILESListFolderArg

Objective-C

@interface DBFILESListFolderArg : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESListFolderArg : NSObject, DBSerializable, NSCopying

The ListFolderArg struct.

This class implements the DBSerializable protocol (serialize and deserialize instance methods), which is required for all Obj-C SDK API route objects.

Instance fields

  • A unique identifier for the file.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull path;

    Swift

    var path: String { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull recursive;

    Swift

    var recursive: NSNumber { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull includeMediaInfo;

    Swift

    var includeMediaInfo: NSNumber { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull includeDeleted;

    Swift

    var includeDeleted: NSNumber { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull includeHasExplicitSharedMembers;

    Swift

    var includeHasExplicitSharedMembers: NSNumber { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull includeMountedFolders;

    Swift

    var includeMountedFolders: NSNumber { get }

  • 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

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *limit;

    Swift

    var limit: NSNumber? { get }

  • 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 in DBFILESListFolderArg will be relative to root of the shared link. Only non-recursive mode is supported for shared link.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBFILESSharedLink *sharedLink;

    Swift

    var sharedLink: DBFILESSharedLink? { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBFILEPROPERTIESTemplateFilterBase *includePropertyGroups;

    Swift

    var includePropertyGroups: DBFILEPROPERTIESTemplateFilterBase? { get }

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSNumber *_Nonnull includeNonDownloadableFiles;

    Swift

    var includeNonDownloadableFiles: NSNumber { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull NSString *)path
                           recursive:(nullable NSNumber *)recursive
                    includeMediaInfo:(nullable NSNumber *)includeMediaInfo
                      includeDeleted:(nullable NSNumber *)includeDeleted
     includeHasExplicitSharedMembers:
         (nullable NSNumber *)includeHasExplicitSharedMembers
               includeMountedFolders:(nullable NSNumber *)includeMountedFolders
                               limit:(nullable NSNumber *)limit
                          sharedLink:(nullable DBFILESSharedLink *)sharedLink
               includePropertyGroups:
                   (nullable DBFILEPROPERTIESTemplateFilterBase *)
                       includePropertyGroups
         includeNonDownloadableFiles:
             (nullable NSNumber *)includeNonDownloadableFiles;

    Swift

    init(path: String, recursive: NSNumber?, includeMediaInfo: NSNumber?, includeDeleted: NSNumber?, includeHasExplicitSharedMembers: NSNumber?, includeMountedFolders: NSNumber?, limit: NSNumber?, sharedLink: DBFILESSharedLink?, includePropertyGroups: DBFILEPROPERTIESTemplateFilterBase?, includeNonDownloadableFiles: NSNumber?)

    Parameters

    path

    A unique identifier for the file.
    recursive

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

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

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

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

    If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.
    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

    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 in DBFILESListFolderArg will be relative to root of the shared link. Only non-recursive mode is supported for shared link.
    includePropertyGroups

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

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

    Return Value

    An initialized instance.

  • Convenience constructor (exposes only non-nullable instance variables with no default value).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull NSString *)path;

    Swift

    init(path: String)

    Parameters

    path

    A unique identifier for the file.

    Return Value

    An initialized instance.