DBSHARINGAddFolderMemberArg

Objective-C

@interface DBSHARINGAddFolderMemberArg : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGAddFolderMemberArg : NSObject, DBSerializable, NSCopying

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

  • The intended list of members to add. Added members will receive invites to join the shared folder.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray<DBSHARINGAddMember *> *_Nonnull members;

    Swift

    var members: [DBSHARINGAddMember] { get }

  • Whether added members should be notified via email and device notifications of their invite.

    Declaration

    Objective-C

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

    Swift

    var quiet: NSNumber { get }

  • Optional message to display to added members in their invitation.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *customMessage;

    Swift

    var customMessage: String? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithSharedFolderId:(nonnull NSString *)sharedFolderId
                   members:(nonnull NSArray<DBSHARINGAddMember *> *)members
                     quiet:(nullable NSNumber *)quiet
             customMessage:(nullable NSString *)customMessage;

    Swift

    init(sharedFolderId: String, members: [DBSHARINGAddMember], quiet: NSNumber?, customMessage: String?)

    Parameters

    sharedFolderId

    The ID for the shared folder.
    members

    The intended list of members to add. Added members will receive invites to join the shared folder.
    quiet

    Whether added members should be notified via email and device notifications of their invite.
    customMessage

    Optional message to display to added members in their invitation.

    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
                   members:(nonnull NSArray<DBSHARINGAddMember *> *)members;

    Swift

    init(sharedFolderId: String, members: [DBSHARINGAddMember])

    Parameters

    sharedFolderId

    The ID for the shared folder.
    members

    The intended list of members to add. Added members will receive invites to join the shared folder.

    Return Value

    An initialized instance.