DBFILESPreviewArg

Objective-C

@interface DBFILESPreviewArg : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESPreviewArg : NSObject, DBSerializable, NSCopying

The PreviewArg 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 preview.

    Declaration

    Objective-C

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

    Swift

    var path: String { get }
  • rev

    Please specify revision in path instead.

    Declaration

    Objective-C

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

    Swift

    var rev: String? { get }

Constructors

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

    Declaration

    Objective-C

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

    Swift

    init(path: String, rev: String?)

    Parameters

    path

    The path of the file to preview.
    rev

    Please specify revision in path instead.

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

    Return Value

    An initialized instance.