dropbox.team.UserAddResult

class documentation

class UserAddResult(bb.Union): (source)

View In Hierarchy

Result of trying to add secondary emails to a user. 'success' is the only value indicating that a user was successfully retrieved for adding secondary emails. The other values explain the type of error that occurred, and include the user for which the error occurred. 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 UserSecondaryEmailsResult UserAddResult.success: Describes a user and the results for each attempt to add a secondary email. :ivar UserSelectorArg UserAddResult.invalid_user: Specified user is not a valid target for adding secondary emails. :ivar UserSelectorArg UserAddResult.unverified: Secondary emails can only be added to verified users. :ivar UserSelectorArg UserAddResult.placeholder_user: Secondary emails cannot be added to placeholder users.

Class Method invalid_user Create an instance of this class set to the ``invalid_user`` tag with value ``val``.
Class Method placeholder_user Create an instance of this class set to the ``placeholder_user`` tag with value ``val``.
Class Method success Create an instance of this class set to the ``success`` tag with value ``val``.
Class Method unverified Create an instance of this class set to the ``unverified`` tag with value ``val``.
Method get_invalid_user Specified user is not a valid target for adding secondary emails.
Method get_placeholder_user Secondary emails cannot be added to placeholder users.
Method get_success Describes a user and the results for each attempt to add a secondary email.
Method get_unverified Secondary emails can only be added to verified users.
Method is_invalid_user Check if the union tag is ``invalid_user``.
Method is_other Check if the union tag is ``other``.
Method is_placeholder_user Check if the union tag is ``placeholder_user``.
Method is_success Check if the union tag is ``success``.
Method is_unverified Check if the union tag is ``unverified``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def invalid_user(cls, val): (source)

Create an instance of this class set to the ``invalid_user`` tag with value ``val``. :param UserSelectorArg val: :rtype: UserAddResult

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

Create an instance of this class set to the ``placeholder_user`` tag with value ``val``. :param UserSelectorArg val: :rtype: UserAddResult

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

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

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

Create an instance of this class set to the ``unverified`` tag with value ``val``. :param UserSelectorArg val: :rtype: UserAddResult

def get_invalid_user(self): (source)

Specified user is not a valid target for adding secondary emails. Only call this if :meth:`is_invalid_user` is true. :rtype: UserSelectorArg

def get_placeholder_user(self): (source)

Secondary emails cannot be added to placeholder users. Only call this if :meth:`is_placeholder_user` is true. :rtype: UserSelectorArg

def get_success(self): (source)

Describes a user and the results for each attempt to add a secondary email. Only call this if :meth:`is_success` is true. :rtype: UserSecondaryEmailsResult

def get_unverified(self): (source)

Secondary emails can only be added to verified users. Only call this if :meth:`is_unverified` is true. :rtype: UserSelectorArg

def is_invalid_user(self): (source)

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

def is_other(self): (source)

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

def is_placeholder_user(self): (source)

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

def is_success(self): (source)

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

def is_unverified(self): (source)

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

other = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented