DBFILESAlphaGetMetadataArg

Objective-C

@interface DBFILESAlphaGetMetadataArg
    : DBFILESGetMetadataArg <DBSerializable, NSCopying>

Swift

class DBFILESAlphaGetMetadataArg : DBFILESGetMetadataArg, DBSerializable, NSCopying

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

  • If set to a valid list of template IDs, propertyGroups in DBFILESFileMetadata is set for files with custom properties.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSArray<NSString *> *includePropertyTemplates;

    Swift

    var includePropertyTemplates: [String]? { get }

Constructors

  • 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
            includePropertyTemplates:
                (nullable NSArray<NSString *> *)includePropertyTemplates;

    Swift

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

    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.
    includePropertyTemplates

    If set to a valid list of template IDs, propertyGroups in DBFILESFileMetadata is set for files with custom properties.

    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.