DBFILESExportArg

Objective-C

@interface DBFILESExportArg : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESExportArg : NSObject, DBSerializable, NSCopying

The ExportArg 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 path of the file to be exported.

    Declaration

    Objective-C

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

    Swift

    var path: String { get }

  • The file format to which the file should be exported. This must be one of the formats listed in the file’s export_options returned by getMetadata. If none is specified, the default format (specified in export_as in file metadata) will be used.

    Declaration

    Objective-C

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

    Swift

    var exportFormat: String? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull NSString *)path
                        exportFormat:(nullable NSString *)exportFormat;

    Swift

    init(path: String, exportFormat: String?)

    Parameters

    path

    The path of the file to be exported.
    exportFormat

    The file format to which the file should be exported. This must be one of the formats listed in the file’s export_options returned by getMetadata. If none is specified, the default format (specified in export_as in file metadata) will be used.

    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 the file to be exported.

    Return Value

    An initialized instance.