DBTEAMMemberAddArg

Objective-C

@interface DBTEAMMemberAddArg
    : DBTEAMMemberAddArgBase <DBSerializable, NSCopying>

Swift

class DBTEAMMemberAddArg : DBTEAMMemberAddArgBase, DBSerializable, NSCopying

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


                    
                    
                    role

(no description).

Declaration

Objective-C

@property (nonatomic, readonly) DBTEAMAdminTier *_Nonnull role;

Swift

var role: DBTEAMAdminTier { get }

Constructors


                    
                    
                    -initWithMemberEmail:memberGivenName:memberSurname:memberExternalId:memberPersistentId:sendWelcomeEmail:isDirectoryRestricted:role:

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

Declaration

Objective-C

- (nonnull instancetype)
      initWithMemberEmail:(nonnull NSString *)memberEmail
          memberGivenName:(nullable NSString *)memberGivenName
            memberSurname:(nullable NSString *)memberSurname
         memberExternalId:(nullable NSString *)memberExternalId
       memberPersistentId:(nullable NSString *)memberPersistentId
         sendWelcomeEmail:(nullable NSNumber *)sendWelcomeEmail
    isDirectoryRestricted:(nullable NSNumber *)isDirectoryRestricted
                     role:(nullable DBTEAMAdminTier *)role;

Swift

init(memberEmail: String, memberGivenName: String?, memberSurname: String?, memberExternalId: String?, memberPersistentId: String?, sendWelcomeEmail: NSNumber?, isDirectoryRestricted: NSNumber?, role: DBTEAMAdminTier?)

Parameters

`memberEmail`	(no description).
`memberGivenName`	Member’s first name.
`memberSurname`	Member’s last name.
`memberExternalId`	External ID for member.
`memberPersistentId`	Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.
`sendWelcomeEmail`	Whether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves.
`isDirectoryRestricted`	Whether a user is directory restricted.
`role`	(no description).

Return Value

An initialized instance.


                    
                    
                    -initWithMemberEmail:

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

Declaration

Objective-C

- (nonnull instancetype)initWithMemberEmail:(nonnull NSString *)memberEmail;

Swift

init(memberEmail: String)

Parameters


                                memberEmail

(no description).

Return Value

An initialized instance.