DBFILESGetMetadataArg

@interface DBFILESGetMetadataArg : NSObject <DBSerializable, NSCopying>

The GetMetadataArg struct.

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

  • The path of a file or folder on Dropbox.

    Declaration

    Objective-C

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

    Swift

    var path: String { get }
  • If true, mediaInfo in DBFILESFileMetadata is set for photo and video.

    Declaration

    Objective-C

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

    Swift

    var includeMediaInfo: NSNumber { get }
  • If true, DeletedMetadata will be returned for deleted file or folder, otherwise notFound in DBFILESLookupError will be returned.

    Declaration

    Objective-C

    @property (readonly, nonatomic) 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 (readonly, nonatomic)
        NSNumber *_Nonnull includeHasExplicitSharedMembers;

    Swift

    var includeHasExplicitSharedMembers: NSNumber { 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 (readonly, nonatomic, nullable)
        DBFILEPROPERTIESTemplateFilterBase *includePropertyGroups;

    Swift

    var includePropertyGroups: DBFILEPROPERTIESTemplateFilterBase? { get }
  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull NSString *)path
                        includeMediaInfo:(nullable NSNumber *)includeMediaInfo
                          includeDeleted:(nullable NSNumber *)includeDeleted
         includeHasExplicitSharedMembers:
             (nullable NSNumber *)includeHasExplicitSharedMembers
                   includePropertyGroups:
                       (nullable DBFILEPROPERTIESTemplateFilterBase *)
                           includePropertyGroups;

    Swift

    init(path: String, includeMediaInfo: NSNumber?, includeDeleted: NSNumber?, includeHasExplicitSharedMembers: NSNumber?, includePropertyGroups: DBFILEPROPERTIESTemplateFilterBase?)

    Parameters

    path

    The path of a file or folder on Dropbox.

    includeMediaInfo

    If true, mediaInfo in DBFILESFileMetadata is set for photo and video.

    includeDeleted

    If true, DeletedMetadata will be returned for deleted file or folder, otherwise notFound in DBFILESLookupError will be returned.

    includeHasExplicitSharedMembers

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

    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.

    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

    The path of a file or folder on Dropbox.

    Return Value

    An initialized instance.