DBSHARINGListFoldersResult

Objective-C

@interface DBSHARINGListFoldersResult : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGListFoldersResult : NSObject, DBSerializable, NSCopying

The ListFoldersResult struct.

Result for listFolders or listMountableFolders, depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of pathLower in DBSHARINGSharedFolderMetadata.

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

Instance fields

  • List of all shared folders the authenticated user has access to.

    Declaration

    Objective-C

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

    Swift

    var entries: [DBSHARINGSharedFolderMetadata] { get }

  • Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either listFoldersContinue or listMountableFoldersContinue) to list additional folders.

    Declaration

    Objective-C

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

    Swift

    var cursor: String? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithEntries:(nonnull NSArray<DBSHARINGSharedFolderMetadata *> *)entries
             cursor:(nullable NSString *)cursor;

    Swift

    init(entries: [DBSHARINGSharedFolderMetadata], cursor: String?)

    Parameters

    entries

    List of all shared folders the authenticated user has access to.
    cursor

    Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either listFoldersContinue or listMountableFoldersContinue) to list additional folders.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithEntries:
    (nonnull NSArray<DBSHARINGSharedFolderMetadata *> *)entries;

    Swift

    init(entries: [DBSHARINGSharedFolderMetadata])

    Parameters

    entries

    List of all shared folders the authenticated user has access to.

    Return Value

    An initialized instance.