dropbox.team.MemberAddResultBase

class documentation

class MemberAddResultBase(bb.Union): (source)

Known subclasses: dropbox.team.MemberAddResult, dropbox.team.MemberAddV2Result

View In Hierarchy

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 str team.MemberAddResultBase.team_license_limit: Team is already full. The organization has no available licenses. :ivar str team.MemberAddResultBase.free_team_member_limit_reached: Team is already full. The free team member limit has been reached. :ivar str team.MemberAddResultBase.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. :ivar str team.MemberAddResultBase.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. :ivar str team.MemberAddResultBase.user_already_paired: User is already paired. :ivar str team.MemberAddResultBase.user_migration_failed: User migration has failed. :ivar str team.MemberAddResultBase.duplicate_external_member_id: A user with the given external member ID already exists on the team (including in recoverable state). :ivar str team.MemberAddResultBase.duplicate_member_persistent_id: A user with the given persistent ID already exists on the team (including in recoverable state). :ivar str team.MemberAddResultBase.persistent_id_disabled: Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information. :ivar str team.MemberAddResultBase.user_creation_failed: User creation has failed.

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``.
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def duplicate_external_member_id(cls, val): (source)

Create an instance of this class set to the ``duplicate_external_member_id`` tag with value ``val``. :param str val: :rtype: MemberAddResultBase

@classmethod
def duplicate_member_persistent_id(cls, val): (source)

Create an instance of this class set to the ``duplicate_member_persistent_id`` tag with value ``val``. :param str val: :rtype: MemberAddResultBase

@classmethod
def free_team_member_limit_reached(cls, val): (source)

Create an instance of this class set to the ``free_team_member_limit_reached`` tag with value ``val``. :param str val: :rtype: MemberAddResultBase

@classmethod
def persistent_id_disabled(cls, val): (source)

Create an instance of this class set to the ``persistent_id_disabled`` tag with value ``val``. :param str val: :rtype: MemberAddResultBase

@classmethod
def team_license_limit(cls, val): (source)

Create an instance of this class set to the ``team_license_limit`` tag with value ``val``. :param str val: :rtype: MemberAddResultBase

@classmethod
def user_already_on_team(cls, val): (source)

Create an instance of this class set to the ``user_already_on_team`` tag with value ``val``. :param str val: :rtype: MemberAddResultBase

@classmethod
def user_already_paired(cls, val): (source)

Create an instance of this class set to the ``user_already_paired`` tag with value ``val``. :param str val: :rtype: MemberAddResultBase

@classmethod
def user_creation_failed(cls, val): (source)

Create an instance of this class set to the ``user_creation_failed`` tag with value ``val``. :param str val: :rtype: MemberAddResultBase

@classmethod
def user_migration_failed(cls, val): (source)

Create an instance of this class set to the ``user_migration_failed`` tag with value ``val``. :param str val: :rtype: MemberAddResultBase

@classmethod
def user_on_another_team(cls, val): (source)

Create an instance of this class set to the ``user_on_another_team`` tag with value ``val``. :param str val: :rtype: MemberAddResultBase

def get_duplicate_external_member_id(self): (source)

A user with the given external member ID already exists on the team (including in recoverable state). Only call this if :meth:`is_duplicate_external_member_id` is true. :rtype: str

def get_duplicate_member_persistent_id(self): (source)

A user with the given persistent ID already exists on the team (including in recoverable state). Only call this if :meth:`is_duplicate_member_persistent_id` is true. :rtype: str

def get_free_team_member_limit_reached(self): (source)

Team is already full. The free team member limit has been reached. Only call this if :meth:`is_free_team_member_limit_reached` is true. :rtype: str

def get_persistent_id_disabled(self): (source)

Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information. Only call this if :meth:`is_persistent_id_disabled` is true. :rtype: str

def get_team_license_limit(self): (source)

Team is already full. The organization has no available licenses. Only call this if :meth:`is_team_license_limit` is true. :rtype: str

def get_user_already_on_team(self): (source)

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. Only call this if :meth:`is_user_already_on_team` is true. :rtype: str

def get_user_already_paired(self): (source)

User is already paired. Only call this if :meth:`is_user_already_paired` is true. :rtype: str

def get_user_creation_failed(self): (source)

User creation has failed. Only call this if :meth:`is_user_creation_failed` is true. :rtype: str

def get_user_migration_failed(self): (source)

User migration has failed. Only call this if :meth:`is_user_migration_failed` is true. :rtype: str

def get_user_on_another_team(self): (source)

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. Only call this if :meth:`is_user_on_another_team` is true. :rtype: str

def is_duplicate_external_member_id(self): (source)

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

def is_duplicate_member_persistent_id(self): (source)

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

def is_free_team_member_limit_reached(self): (source)

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

def is_persistent_id_disabled(self): (source)

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

def is_team_license_limit(self): (source)

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

def is_user_already_on_team(self): (source)

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

def is_user_already_paired(self): (source)

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

def is_user_creation_failed(self): (source)

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

def is_user_migration_failed(self): (source)

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

def is_user_on_another_team(self): (source)

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

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)
overridden in dropbox.team.MemberAddResult, dropbox.team.MemberAddV2Result

Undocumented

_catch_all = (source)
overridden in dropbox.team.MemberAddV2Result

Undocumented