DBTEAMMembersSetProfileArg

Objective-C

@interface DBTEAMMembersSetProfileArg : NSObject <DBSerializable, NSCopying>

Swift

class DBTEAMMembersSetProfileArg : NSObject, DBSerializable, NSCopying

The MembersSetProfileArg struct.

Exactly one of team_member_id, email, or external_id must be provided to identify the user account. At least one of new_email, new_external_id, new_given_name, and/or new_surname must be provided.

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

Instance fields

  • Identity of user whose profile will be set.

    Declaration

    Objective-C

    @property (nonatomic, readonly) DBTEAMUserSelectorArg *_Nonnull user;

    Swift

    var user: DBTEAMUserSelectorArg { get }

  • New email for member.

    Declaration

    Objective-C

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

    Swift

    var dNewEmail: String? { get }

  • New external ID for member.

    Declaration

    Objective-C

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

    Swift

    var dNewExternalId: String? { get }

  • New given name for member.

    Declaration

    Objective-C

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

    Swift

    var dNewGivenName: String? { get }

  • New surname for member.

    Declaration

    Objective-C

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

    Swift

    var dNewSurname: String? { get }

  • New persistent ID. This field only available to teams using persistent ID SAML configuration.

    Declaration

    Objective-C

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

    Swift

    var dNewPersistentId: String? { get }

  • New value for whether the user is a directory restricted user.

    Declaration

    Objective-C

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

    Swift

    var dNewIsDirectoryRestricted: NSNumber? { get }

Constructors

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUser:(nonnull DBTEAMUserSelectorArg *)user
                           dNewEmail:(nullable NSString *)dNewEmail
                      dNewExternalId:(nullable NSString *)dNewExternalId
                       dNewGivenName:(nullable NSString *)dNewGivenName
                         dNewSurname:(nullable NSString *)dNewSurname
                    dNewPersistentId:(nullable NSString *)dNewPersistentId
           dNewIsDirectoryRestricted:
               (nullable NSNumber *)dNewIsDirectoryRestricted;

    Swift

    init(user: DBTEAMUserSelectorArg, dNewEmail: String?, dNewExternalId: String?, dNewGivenName: String?, dNewSurname: String?, dNewPersistentId: String?, dNewIsDirectoryRestricted: NSNumber?)

    Parameters

    user

    Identity of user whose profile will be set.
    dNewEmail

    New email for member.
    dNewExternalId

    New external ID for member.
    dNewGivenName

    New given name for member.
    dNewSurname

    New surname for member.
    dNewPersistentId

    New persistent ID. This field only available to teams using persistent ID SAML configuration.
    dNewIsDirectoryRestricted

    New value for whether the user is a directory restricted user.

    Return Value

    An initialized instance.

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

    Declaration

    Objective-C

    - (nonnull instancetype)initWithUser:(nonnull DBTEAMUserSelectorArg *)user;

    Swift

    init(user: DBTEAMUserSelectorArg)

    Parameters

    user

    Identity of user whose profile will be set.

    Return Value

    An initialized instance.