DBPAPERAddPaperDocUser

Objective-C

@interface DBPAPERAddPaperDocUser
    : DBPAPERRefPaperDoc <DBSerializable, NSCopying>

Swift

class DBPAPERAddPaperDocUser : DBPAPERRefPaperDoc, DBSerializable, NSCopying

The AddPaperDocUser 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


                    
                    
                    members

User which should be added to the Paper doc. Specify only email address or Dropbox account ID.

Declaration

Objective-C

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

Swift

var members: [DBPAPERAddMember] { get }


                    
                    
                    customMessage

A personal message that will be emailed to each successfully added member.

Declaration

Objective-C

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

Swift

var customMessage: String? { get }

quiet
Clients should set this to true if no email message shall be sent to added users.
Declaration
Objective-C

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

var quiet: NSNumber { get }

Constructors


                    
                    
                    -initWithDocId:members:customMessage:quiet:

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

Declaration

Objective-C

- (nonnull instancetype)initWithDocId:(nonnull NSString *)docId
                              members:
                                  (nonnull NSArray<DBPAPERAddMember *> *)members
                        customMessage:(nullable NSString *)customMessage
                                quiet:(nullable NSNumber *)quiet;

Swift

init(docId: String, members: [DBPAPERAddMember], customMessage: String?, quiet: NSNumber?)

Parameters

`docId`	The Paper doc ID.
`members`	User which should be added to the Paper doc. Specify only email address or Dropbox account ID.
`customMessage`	A personal message that will be emailed to each successfully added member.
`quiet`	Clients should set this to true if no email message shall be sent to added users.

Return Value

An initialized instance.


                    
                    
                    -initWithDocId:members:

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

Declaration

Objective-C

- (nonnull instancetype)initWithDocId:(nonnull NSString *)docId
                              members:(nonnull NSArray<DBPAPERAddMember *> *)
                                          members;

Swift

init(docId: String, members: [DBPAPERAddMember])

Parameters

`docId`	The Paper doc ID.
`members`	User which should be added to the Paper doc. Specify only email address or Dropbox account ID.

Return Value

An initialized instance.