DBFILESDownloadZipError

@interface DBFILESDownloadZipError : NSObject <DBSerializable, NSCopying>

The DownloadZipError union.

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

  • 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 too_large.

    Description of the too_large tag state: The folder is too large to download.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooLarge;

    Swift

    init(tooLarge: ())

    Return Value

    An initialized instance.

  • Initializes union class with tag state of too_many_files.

    Description of the too_many_files tag state: The folder has too many files to download.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyFiles;

    Swift

    init(tooManyFiles: ())

    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.

  • 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 too_large.

    Declaration

    Objective-C

    - (BOOL)isTooLarge;

    Swift

    func isTooLarge() -> Bool

    Return Value

    Whether the union’s current tag state has value too_large.

  • Retrieves whether the union’s current tag state has value too_many_files.

    Declaration

    Objective-C

    - (BOOL)isTooManyFiles;

    Swift

    func isTooManyFiles() -> Bool

    Return Value

    Whether the union’s current tag state has value too_many_files.

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