DBSHARINGUnshareFolderArg

Objective-C

@interface DBSHARINGUnshareFolderArg : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGUnshareFolderArg : NSObject, DBSerializable, NSCopying

The UnshareFolderArg struct.

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

Instance fields

  • The ID for the shared folder.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull sharedFolderId;

    Swift

    var sharedFolderId: String { get }

  • If true, members of this shared folder will get a copy of this folder after it’s unshared. Otherwise, it will be removed from their Dropbox. The current user, who is an owner, will always retain their copy.

    Declaration

    Objective-C

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

    Swift

    var leaveACopy: NSNumber { get }

Constructors

  • Full constructor for the struct (exposes all instance variables).

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSharedFolderId:
                            (nonnull NSString *)sharedFolderId
                                    leaveACopy:(nullable NSNumber *)leaveACopy;

    Swift

    init(sharedFolderId: String, leaveACopy: NSNumber?)

    Parameters

    sharedFolderId

    The ID for the shared folder.
    leaveACopy

    If true, members of this shared folder will get a copy of this folder after it’s unshared. Otherwise, it will be removed from their Dropbox. The current user, who is an owner, will always retain their copy.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithSharedFolderId:
    (nonnull NSString *)sharedFolderId;

    Swift

    init(sharedFolderId: String)

    Parameters

    sharedFolderId

    The ID for the shared folder.

    Return Value

    An initialized instance.