DBFILESRelocationArg

@interface DBFILESRelocationArg
    : DBFILESRelocationPath <DBSerializable, NSCopying>

The RelocationArg struct.

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

  • If true, dCopy will copy contents in shared folder, otherwise cantCopySharedFolder in DBFILESRelocationError will be returned if fromPath contains shared folder. This field is always true for move.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSNumber *_Nonnull allowSharedFolder;

    Swift

    var allowSharedFolder: NSNumber { get }
  • If there’s a conflict, have the Dropbox server try to autorename the file to avoid the conflict.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSNumber *_Nonnull autorename;

    Swift

    var autorename: NSNumber { get }
  • Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

    Declaration

    Objective-C

    @property (readonly, nonatomic) NSNumber *_Nonnull allowOwnershipTransfer;

    Swift

    var allowOwnershipTransfer: NSNumber { get }
  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFromPath:(nonnull NSString *)fromPath
                                      toPath:(nonnull NSString *)toPath
                           allowSharedFolder:(nullable NSNumber *)allowSharedFolder
                                  autorename:(nullable NSNumber *)autorename
                      allowOwnershipTransfer:
                          (nullable NSNumber *)allowOwnershipTransfer;

    Swift

    init(fromPath: String, toPath: String, allowSharedFolder: NSNumber?, autorename: NSNumber?, allowOwnershipTransfer: NSNumber?)

    Parameters

    fromPath

    Path in the user’s Dropbox to be copied or moved.

    toPath

    Path in the user’s Dropbox that is the destination.

    allowSharedFolder

    If true, dCopy will copy contents in shared folder, otherwise cantCopySharedFolder in DBFILESRelocationError will be returned if fromPath contains shared folder. This field is always true for move.

    autorename

    If there’s a conflict, have the Dropbox server try to autorename the file to avoid the conflict.

    allowOwnershipTransfer

    Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithFromPath:(nonnull NSString *)fromPath
                                      toPath:(nonnull NSString *)toPath;

    Swift

    init(fromPath: String, toPath: String)

    Parameters

    fromPath

    Path in the user’s Dropbox to be copied or moved.

    toPath

    Path in the user’s Dropbox that is the destination.

    Return Value

    An initialized instance.