dropbox.team.DeleteSecondaryEmailResult

class documentation

class DeleteSecondaryEmailResult(bb.Union): (source)

View In Hierarchy

Result of trying to delete a secondary email address. 'success' is the only value indicating that a secondary email was successfully deleted. The other values explain the type of error that occurred, and include the email 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 str team.DeleteSecondaryEmailResult.success: The secondary email was successfully deleted. :ivar str team.DeleteSecondaryEmailResult.not_found: The email address was not found for the user. :ivar str team.DeleteSecondaryEmailResult.cannot_remove_primary: The email address is the primary email address of the user, and cannot be removed.

Class Method cannot_remove_primary Create an instance of this class set to the ``cannot_remove_primary`` tag with value ``val``.
Class Method not_found Create an instance of this class set to the ``not_found`` tag with value ``val``.
Class Method success Create an instance of this class set to the ``success`` tag with value ``val``.
Method get_cannot_remove_primary The email address is the primary email address of the user, and cannot be removed.
Method get_not_found The email address was not found for the user.
Method get_success The secondary email was successfully deleted.
Method is_cannot_remove_primary Check if the union tag is ``cannot_remove_primary``.
Method is_not_found Check if the union tag is ``not_found``.
Method is_other Check if the union tag is ``other``.
Method is_success Check if the union tag is ``success``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def cannot_remove_primary(cls, val): (source)

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

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

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

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

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

def get_cannot_remove_primary(self): (source)

The email address is the primary email address of the user, and cannot be removed. Only call this if :meth:`is_cannot_remove_primary` is true. :rtype: str

def get_not_found(self): (source)

The email address was not found for the user. Only call this if :meth:`is_not_found` is true. :rtype: str

def get_success(self): (source)

The secondary email was successfully deleted. Only call this if :meth:`is_success` is true. :rtype: str

def is_cannot_remove_primary(self): (source)

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

def is_not_found(self): (source)

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

def is_other(self): (source)

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

def is_success(self): (source)

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

other = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented