DBFILESExportError

Objective-C

@interface DBFILESExportError : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESExportError : NSObject, DBSerializable, NSCopying

The ExportError union.

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

Instance fields

  • tag

    Represents the union’s current tag state.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESExportErrorTag tag;

    Swift

    var tag: DBFILESExportErrorTag { get }

  • (no description). - note: Ensure the isPath method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESLookupError *_Nonnull path;

    Swift

    var path: DBFILESLookupError { get }

Constructors

  • Initializes union class with tag state of “path”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithPath:(nonnull DBFILESLookupError *)path;

    Swift

    init(path: DBFILESLookupError)

    Parameters

    path

    (no description).

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “non_exportable”.

    Description of the “non_exportable” tag state: This file type cannot be exported. Use download instead.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithNonExportable;

    Swift

    init(nonExportable: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “invalid_export_format”.

    Description of the “invalid_export_format” tag state: The specified export format is not a valid option for this file type.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInvalidExportFormat;

    Swift

    init(invalidExportFormat: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “retry_error”.

    Description of the “retry_error” tag state: The exportable content is not yet available. Please retry later.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRetryError;

    Swift

    init(retryError: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of “other”.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithOther;

    Swift

    init(other: ())

    Return Value

    An initialized instance.

Tag state methods

  • Retrieves whether the union’s current tag state has value “path”.

    Note

    Call this method and ensure it returns true before accessing the path property, otherwise a runtime exception will be thrown.

    Declaration

    Objective-C

    - (BOOL)isPath;

    Swift

    func isPath() -> Bool

    Return Value

    Whether the union’s current tag state has value “path”.

  • Retrieves whether the union’s current tag state has value “non_exportable”.

    Declaration

    Objective-C

    - (BOOL)isNonExportable;

    Swift

    func isNonExportable() -> Bool

    Return Value

    Whether the union’s current tag state has value “non_exportable”.

  • Retrieves whether the union’s current tag state has value “invalid_export_format”.

    Declaration

    Objective-C

    - (BOOL)isInvalidExportFormat;

    Swift

    func isInvalidExportFormat() -> Bool

    Return Value

    Whether the union’s current tag state has value “invalid_export_format”.

  • Retrieves whether the union’s current tag state has value “retry_error”.

    Declaration

    Objective-C

    - (BOOL)isRetryError;

    Swift

    func isRetryError() -> Bool

    Return Value

    Whether the union’s current tag state has value “retry_error”.

  • Retrieves whether the union’s current tag state has value “other”.

    Declaration

    Objective-C

    - (BOOL)isOther;

    Swift

    func isOther() -> Bool

    Return Value

    Whether the union’s current tag state has value “other”.

  • Retrieves string value of union’s current tag state.

    Declaration

    Objective-C

    - (nonnull NSString *)tagName;

    Swift

    func tagName() -> String

    Return Value

    A human-readable string representing the union’s current tag state.