DBSHARINGAddFileMemberArgs

Objective-C

@interface DBSHARINGAddFileMemberArgs : NSObject <DBSerializable, NSCopying>

Swift

class DBSHARINGAddFileMemberArgs : NSObject, DBSerializable, NSCopying

The AddFileMemberArgs struct.

Arguments for addFileMember.

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

Instance fields

  • File to which to add members.

    Declaration

    Objective-C

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

    Swift

    var file: String { get }

  • Members to add. Note that even an email address is given, this may result in a user being directly added to the membership if that email is the user’s main account email.

    Declaration

    Objective-C

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

    Swift

    var members: [DBSHARINGMemberSelector] { get }

  • Message to send to added members in their invitation.

    Declaration

    Objective-C

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

    Swift

    var customMessage: String? { get }

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

    Declaration

    Objective-C

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

    Swift

    var quiet: NSNumber { get }

  • AccessLevel union object, describing what access level we want to give new members.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBSHARINGAccessLevel *_Nonnull accessLevel;

    Swift

    var accessLevel: DBSHARINGAccessLevel { get }

  • If the custom message should be added as a comment on the file.

    Declaration

    Objective-C

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

    Swift

    var addMessageAsComment: NSNumber { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)
           initWithFile:(nonnull NSString *)file
                members:(nonnull NSArray<DBSHARINGMemberSelector *> *)members
          customMessage:(nullable NSString *)customMessage
                  quiet:(nullable NSNumber *)quiet
            accessLevel:(nullable DBSHARINGAccessLevel *)accessLevel
    addMessageAsComment:(nullable NSNumber *)addMessageAsComment;

    Swift

    init(file: String, members: [DBSHARINGMemberSelector], customMessage: String?, quiet: NSNumber?, accessLevel: DBSHARINGAccessLevel?, addMessageAsComment: NSNumber?)

    Parameters

    file

    File to which to add members.
    members

    Members to add. Note that even an email address is given, this may result in a user being directly added to the membership if that email is the user’s main account email.
    customMessage

    Message to send to added members in their invitation.
    quiet

    Whether added members should be notified via email and device notifications of their invitation.
    accessLevel

    AccessLevel union object, describing what access level we want to give new members.
    addMessageAsComment

    If the custom message should be added as a comment on the file.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithFile:(nonnull NSString *)file
         members:(nonnull NSArray<DBSHARINGMemberSelector *> *)members;

    Swift

    init(file: String, members: [DBSHARINGMemberSelector])

    Parameters

    file

    File to which to add members.
    members

    Members to add. Note that even an email address is given, this may result in a user being directly added to the membership if that email is the user’s main account email.

    Return Value

    An initialized instance.