DBFILESListFolderResult

Objective-C

@interface DBFILESListFolderResult : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESListFolderResult : NSObject, DBSerializable, NSCopying

The ListFolderResult 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

  • The files and (direct) subfolders in the folder.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<DBFILESMetadata *> *_Nonnull entries;

    Swift

    var entries: [DBFILESMetadata] { get }
  • Pass the cursor into listFolderContinue to see what’s changed in the folder since your previous query.

    Declaration

    Objective-C

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

    Swift

    var cursor: String { get }
  • If true, then there are more entries available. Pass the cursor to listFolderContinue to retrieve the rest.

    Declaration

    Objective-C

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

    Swift

    var hasMore: NSNumber { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEntries:
                                (nonnull NSArray<DBFILESMetadata *> *)entries
                                     cursor:(nonnull NSString *)cursor
                                    hasMore:(nonnull NSNumber *)hasMore;

    Swift

    init(entries: [DBFILESMetadata], cursor: String, hasMore: NSNumber)

    Parameters

    entries

    The files and (direct) subfolders in the folder.

    cursor

    Pass the cursor into listFolderContinue to see what’s changed in the folder since your previous query.

    hasMore

    If true, then there are more entries available. Pass the cursor to listFolderContinue to retrieve the rest.

    Return Value

    An initialized instance.