DBFILESRelocationError

Objective-C

@interface DBFILESRelocationError : NSObject <DBSerializable, NSCopying>

Swift

class DBFILESRelocationError : NSObject, DBSerializable, NSCopying

The RelocationError 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) DBFILESRelocationErrorTag tag;

    Swift

    var tag: DBFILESRelocationErrorTag { get }
  • (no description). - note: Ensure the isFromLookup method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

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

    Swift

    var fromLookup: DBFILESLookupError { get }
  • (no description). - note: Ensure the isFromWrite method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESWriteError *_Nonnull fromWrite;

    Swift

    var fromWrite: DBFILESWriteError { get }
  • to

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

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESWriteError *_Nonnull to;

    Swift

    var to: DBFILESWriteError { get }
  • Some content cannot be moved into Vault under certain circumstances, see detailed error. - note: Ensure the isCantMoveIntoVault method returns true before accessing, otherwise a runtime exception will be raised.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBFILESMoveIntoVaultError *_Nonnull cantMoveIntoVault;

    Swift

    var cantMoveIntoVault: DBFILESMoveIntoVaultError { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFromLookup:
        (nonnull DBFILESLookupError *)fromLookup;

    Swift

    init(fromLookup: DBFILESLookupError)

    Parameters

    fromLookup

    (no description).

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFromWrite:
        (nonnull DBFILESWriteError *)fromWrite;

    Swift

    init(fromWrite: DBFILESWriteError)

    Parameters

    fromWrite

    (no description).

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTo:(nonnull DBFILESWriteError *)to;

    Swift

    init(to: DBFILESWriteError)

    Parameters

    to

    (no description).

    Return Value

    An initialized instance.

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

    Description of the “cant_copy_shared_folder” tag state: Shared folders can’t be copied.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCantCopySharedFolder;

    Swift

    init(cantCopySharedFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “cant_nest_shared_folder” tag state: Your move operation would result in nested shared folders. This is not allowed.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCantNestSharedFolder;

    Swift

    init(cantNestSharedFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “cant_move_folder_into_itself” tag state: You cannot move a folder into itself.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCantMoveFolderIntoItself;

    Swift

    init(cantMoveFolderIntoItself: ())

    Return Value

    An initialized instance.

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

    Description of the “too_many_files” tag state: The operation would involve more than 10,000 files and folders.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithTooManyFiles;

    Swift

    init(tooManyFiles: ())

    Return Value

    An initialized instance.

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

    Description of the “duplicated_or_nested_paths” tag state: There are duplicated/nested paths among fromPath in DBFILESRelocationArg and toPath in DBFILESRelocationArg.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDuplicatedOrNestedPaths;

    Swift

    init(duplicatedOrNestedPaths: ())

    Return Value

    An initialized instance.

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

    Description of the “cant_transfer_ownership” tag state: Your move operation would result in an ownership transfer. You may reissue the request with the field allowOwnershipTransfer in DBFILESRelocationArg to true.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCantTransferOwnership;

    Swift

    init(cantTransferOwnership: ())

    Return Value

    An initialized instance.

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

    Description of the “insufficient_quota” tag state: The current user does not have enough space to move or copy the files.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInsufficientQuota;

    Swift

    init(insufficientQuota: ())

    Return Value

    An initialized instance.

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

    Description of the “internal_error” tag state: Something went wrong with the job on Dropbox’s end. You’ll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithInternalError;

    Swift

    init(internalError: ())

    Return Value

    An initialized instance.

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

    Description of the “cant_move_shared_folder” tag state: Can’t move the shared folder to the given destination.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCantMoveSharedFolder;

    Swift

    init(cantMoveSharedFolder: ())

    Return Value

    An initialized instance.

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

    Description of the “cant_move_into_vault” tag state: Some content cannot be moved into Vault under certain circumstances, see detailed error.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCantMoveIntoVault:
        (nonnull DBFILESMoveIntoVaultError *)cantMoveIntoVault;

    Swift

    init(cantMoveIntoVault: DBFILESMoveIntoVaultError)

    Parameters

    cantMoveIntoVault

    Some content cannot be moved into Vault under certain circumstances, see detailed error.

    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 “from_lookup”.

    Note

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

    Declaration

    Objective-C

    - (BOOL)isFromLookup;

    Swift

    func isFromLookup() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isFromWrite;

    Swift

    func isFromWrite() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isTo;

    Swift

    func isTo() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isCantCopySharedFolder;

    Swift

    func isCantCopySharedFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isCantNestSharedFolder;

    Swift

    func isCantNestSharedFolder() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isCantMoveFolderIntoItself;

    Swift

    func isCantMoveFolderIntoItself() -> Bool

    Return Value

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

  • 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 “duplicated_or_nested_paths”.

    Declaration

    Objective-C

    - (BOOL)isDuplicatedOrNestedPaths;

    Swift

    func isDuplicatedOrNestedPaths() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isCantTransferOwnership;

    Swift

    func isCantTransferOwnership() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInsufficientQuota;

    Swift

    func isInsufficientQuota() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isInternalError;

    Swift

    func isInternalError() -> Bool

    Return Value

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

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

    Declaration

    Objective-C

    - (BOOL)isCantMoveSharedFolder;

    Swift

    func isCantMoveSharedFolder() -> Bool

    Return Value

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

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

    Note

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

    Declaration

    Objective-C

    - (BOOL)isCantMoveIntoVault;

    Swift

    func isCantMoveIntoVault() -> Bool

    Return Value

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

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