DBSHARINGRelinquishFolderMembershipArg

Objective-C

@interface DBSHARINGRelinquishFolderMembershipArg
    : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGRelinquishFolderMembershipArg : NSObject, DBSerializable, NSCopying

The RelinquishFolderMembershipArg 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 }

  • Keep a copy of the folder’s contents upon relinquishing membership. This must be set to false when the folder is within a team folder or another shared folder.

    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

    Keep a copy of the folder’s contents upon relinquishing membership. This must be set to false when the folder is within a team folder or another shared folder.

    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.