DBFILESFolderMetadata

Objective-C

@interface DBFILESFolderMetadata : DBFILESMetadata <DBSerializable, NSCopying>

Swift

class DBFILESFolderMetadata : DBFILESMetadata, DBSerializable, NSCopying

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

  • id_

    A unique identifier for the folder.

    Declaration

    Objective-C

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

    Swift

    var id_: String { get }

  • Please use sharingInfo instead.

    Declaration

    Objective-C

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

    Swift

    var sharedFolderId: String? { get }

  • Set if the folder is contained in a shared folder or is a shared folder mount point.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) DBFILESFolderSharingInfo *sharingInfo;

    Swift

    var sharingInfo: DBFILESFolderSharingInfo? { get }

  • Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSArray<DBFILEPROPERTIESPropertyGroup *> *propertyGroups;

    Swift

    var propertyGroups: [DBFILEPROPERTIESPropertyGroup]? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
            initWithName:(nonnull NSString *)name
                     id_:(nonnull NSString *)id_
               pathLower:(nullable NSString *)pathLower
             pathDisplay:(nullable NSString *)pathDisplay
    parentSharedFolderId:(nullable NSString *)parentSharedFolderId
              previewUrl:(nullable NSString *)previewUrl
          sharedFolderId:(nullable NSString *)sharedFolderId
             sharingInfo:(nullable DBFILESFolderSharingInfo *)sharingInfo
          propertyGroups:(nullable NSArray<DBFILEPROPERTIESPropertyGroup *> *)
                             propertyGroups;

    Swift

    init(name: String, id_: String, pathLower: String?, pathDisplay: String?, parentSharedFolderId: String?, previewUrl: String?, sharedFolderId: String?, sharingInfo: DBFILESFolderSharingInfo?, propertyGroups: [DBFILEPROPERTIESPropertyGroup]?)

    Parameters

    name

    The last component of the path (including extension). This never contains a slash.
    id_

    A unique identifier for the folder.
    pathLower

    The lowercased full path in the user’s Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.
    pathDisplay

    The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user’s filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won’t be returned by listFolderContinue. This field will be null if the file or folder is not mounted.
    parentSharedFolderId

    Please use parentSharedFolderId in DBFILESFileSharingInfo or parentSharedFolderId in DBFILESFolderSharingInfo instead.
    previewUrl

    The preview URL of the file.
    sharedFolderId

    Please use sharingInfo instead.
    sharingInfo

    Set if the folder is contained in a shared folder or is a shared folder mount point.
    propertyGroups

    Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithName:(nonnull NSString *)name
                                 id_:(nonnull NSString *)id_;

    Swift

    init(name: String, id_: String)

    Parameters

    name

    The last component of the path (including extension). This never contains a slash.
    id_

    A unique identifier for the folder.

    Return Value

    An initialized instance.