DBTEAMMemberAddArgBase

Objective-C

@interface DBTEAMMemberAddArgBase : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMMemberAddArgBase : NSObject, DBSerializable, NSCopying

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

  • (no description).

    Declaration

    Objective-C

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

    Swift

    var memberEmail: String { get }

  • Member’s first name.

    Declaration

    Objective-C

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

    Swift

    var memberGivenName: String? { get }

  • Member’s last name.

    Declaration

    Objective-C

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

    Swift

    var memberSurname: String? { get }

  • External ID for member.

    Declaration

    Objective-C

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

    Swift

    var memberExternalId: String? { get }

  • Persistent ID for member. This field is only available to teams using persistent ID SAML configuration.

    Declaration

    Objective-C

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

    Swift

    var memberPersistentId: String? { get }

  • 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.

    Declaration

    Objective-C

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

    Swift

    var sendWelcomeEmail: NSNumber { get }

  • Whether a user is directory restricted.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *isDirectoryRestricted;

    Swift

    var isDirectoryRestricted: NSNumber? { get }

Constructors

  • 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;

    Swift

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

    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.

    Return Value

    An initialized instance.

  • 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.