dropbox.team.MemberAddResult

class documentation

class MemberAddResult(MemberAddResultBase): (source)

Describes the result of attempting to add a single user to the team. 'success' is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed. This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar TeamMemberInfo MemberAddResult.success: Describes a user that was successfully added to the team.

Class Method	`success`	Create an instance of this class set to the ``success`` tag with value ``val``.
Method	`get_success`	Describes a user that was successfully added to the team.
Method	`is_success`	Check if the union tag is ``success``.
Method	`_process_custom_annotations`	Undocumented

Inherited from MemberAddResultBase:

Class Method	`duplicate_external_member_id`	Create an instance of this class set to the ``duplicate_external_member_id`` tag with value ``val``.
Class Method	`duplicate_member_persistent_id`	Create an instance of this class set to the ``duplicate_member_persistent_id`` tag with value ``val``.
Class Method	`free_team_member_limit_reached`	Create an instance of this class set to the ``free_team_member_limit_reached`` tag with value ``val``.
Class Method	`persistent_id_disabled`	Create an instance of this class set to the ``persistent_id_disabled`` tag with value ``val``.
Class Method	`team_license_limit`	Create an instance of this class set to the ``team_license_limit`` tag with value ``val``.
Class Method	`user_already_on_team`	Create an instance of this class set to the ``user_already_on_team`` tag with value ``val``.
Class Method	`user_already_paired`	Create an instance of this class set to the ``user_already_paired`` tag with value ``val``.
Class Method	`user_creation_failed`	Create an instance of this class set to the ``user_creation_failed`` tag with value ``val``.
Class Method	`user_migration_failed`	Create an instance of this class set to the ``user_migration_failed`` tag with value ``val``.
Class Method	`user_on_another_team`	Create an instance of this class set to the ``user_on_another_team`` tag with value ``val``.
Method	`get_duplicate_external_member_id`	A user with the given external member ID already exists on the team (including in recoverable state).
Method	`get_duplicate_member_persistent_id`	A user with the given persistent ID already exists on the team (including in recoverable state).
Method	`get_free_team_member_limit_reached`	Team is already full. The free team member limit has been reached.
Method	`get_persistent_id_disabled`	Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.
Method	`get_team_license_limit`	Team is already full. The organization has no available licenses.
Method	`get_user_already_on_team`	User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.
Method	`get_user_already_paired`	User is already paired.
Method	`get_user_creation_failed`	User creation has failed.
Method	`get_user_migration_failed`	User migration has failed.
Method	`get_user_on_another_team`	User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.
Method	`is_duplicate_external_member_id`	Check if the union tag is ``duplicate_external_member_id``.
Method	`is_duplicate_member_persistent_id`	Check if the union tag is ``duplicate_member_persistent_id``.
Method	`is_free_team_member_limit_reached`	Check if the union tag is ``free_team_member_limit_reached``.
Method	`is_persistent_id_disabled`	Check if the union tag is ``persistent_id_disabled``.
Method	`is_team_license_limit`	Check if the union tag is ``team_license_limit``.
Method	`is_user_already_on_team`	Check if the union tag is ``user_already_on_team``.
Method	`is_user_already_paired`	Check if the union tag is ``user_already_paired``.
Method	`is_user_creation_failed`	Check if the union tag is ``user_creation_failed``.
Method	`is_user_migration_failed`	Check if the union tag is ``user_migration_failed``.
Method	`is_user_on_another_team`	Check if the union tag is ``user_on_another_team``.
Class Variable	`_catch_all`	Undocumented

@classmethod
def success(cls, val): (source) ¶

Create an instance of this class set to the ``success`` tag with value ``val``. :param TeamMemberInfo val: :rtype: MemberAddResult

def get_success(self): (source) ¶

Describes a user that was successfully added to the team. Only call this if :meth:`is_success` is true. :rtype: TeamMemberInfo

def is_success(self): (source) ¶

Check if the union tag is ``success``. :rtype: bool

def _process_custom_annotations(self, annotation_type, field_path, processor): (source) ¶

overrides dropbox.team.MemberAddResultBase._process_custom_annotations

Undocumented