DBFILESRelocationBatchArg

@interface DBFILESRelocationBatchArg : NSObject <DBSerializable, NSCopying>

The RelocationBatchArg struct.

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

  • List of entries to be moved or copied. Each entry is RelocationPath.

    Declaration

    Objective-C

    @property (readonly, nonatomic)
        NSArray<DBFILESRelocationPath *> *_Nonnull entries;

    Swift

    var entries: [DBFILESRelocationPath] { get }
  • If true, dCopyBatch will copy contents in shared folder, otherwise cantCopySharedFolder in DBFILESRelocationError will be returned if fromPath in DBFILESRelocationPath contains shared folder. This field is always true for moveBatch.

    Declaration

    Objective-C

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

    Swift

    var allowSharedFolder: NSNumber { get }
  • If there’s a conflict with any file, have the Dropbox server try to autorename that 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)
           initWithEntries:(nonnull NSArray<DBFILESRelocationPath *> *)entries
         allowSharedFolder:(nullable NSNumber *)allowSharedFolder
                autorename:(nullable NSNumber *)autorename
    allowOwnershipTransfer:(nullable NSNumber *)allowOwnershipTransfer;

    Swift

    init(entries: [DBFILESRelocationPath], allowSharedFolder: NSNumber?, autorename: NSNumber?, allowOwnershipTransfer: NSNumber?)

    Parameters

    entries

    List of entries to be moved or copied. Each entry is RelocationPath.

    allowSharedFolder

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

    autorename

    If there’s a conflict with any file, have the Dropbox server try to autorename that 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)initWithEntries:
        (nonnull NSArray<DBFILESRelocationPath *> *)entries;

    Swift

    init(entries: [DBFILESRelocationPath])

    Parameters

    entries

    List of entries to be moved or copied. Each entry is RelocationPath.

    Return Value

    An initialized instance.