DBPAPERPaperDocCreateArgs

Objective-C

@interface DBPAPERPaperDocCreateArgs : NSObject <DBSerializable, NSCopying>

Swift

class DBPAPERPaperDocCreateArgs : NSObject, DBSerializable, NSCopying

The PaperDocCreateArgs 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 Paper folder ID where the Paper document should be created. The API user has to have write access to this folder or error is thrown.

    Declaration

    Objective-C

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

    Swift

    var parentFolderId: String? { get }

  • The format of provided data.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBPAPERImportFormat *_Nonnull importFormat;

    Swift

    var importFormat: DBPAPERImportFormat { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithImportFormat:(nonnull DBPAPERImportFormat *)importFormat
          parentFolderId:(nullable NSString *)parentFolderId;

    Swift

    init(importFormat: DBPAPERImportFormat, parentFolderId: String?)

    Parameters

    importFormat

    The format of provided data.
    parentFolderId

    The Paper folder ID where the Paper document should be created. The API user has to have write access to this folder or error is thrown.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithImportFormat:
    (nonnull DBPAPERImportFormat *)importFormat;

    Swift

    init(importFormat: DBPAPERImportFormat)

    Parameters

    importFormat

    The format of provided data.

    Return Value

    An initialized instance.