dropbox.team.ResendSecondaryEmailResult

class documentation

class ResendSecondaryEmailResult(bb.Union): (source)

View In Hierarchy

Result of trying to resend verification email to a secondary email address. 'success' is the only value indicating that a verification email was successfully sent. 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.ResendSecondaryEmailResult.success: A verification email was successfully sent to the secondary email address. :ivar str team.ResendSecondaryEmailResult.not_pending: This secondary email address is not pending for the user. :ivar str team.ResendSecondaryEmailResult.rate_limited: Too many emails are being sent to this email address. Please try again later.

Class Method not_pending Create an instance of this class set to the ``not_pending`` tag with value ``val``.
Class Method rate_limited Create an instance of this class set to the ``rate_limited`` tag with value ``val``.
Class Method success Create an instance of this class set to the ``success`` tag with value ``val``.
Method get_not_pending This secondary email address is not pending for the user.
Method get_rate_limited Too many emails are being sent to this email address. Please try again later.
Method get_success A verification email was successfully sent to the secondary email address.
Method is_not_pending Check if the union tag is ``not_pending``.
Method is_other Check if the union tag is ``other``.
Method is_rate_limited Check if the union tag is ``rate_limited``.
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 not_pending(cls, val): (source)

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

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

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

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

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

def get_not_pending(self): (source)

This secondary email address is not pending for the user. Only call this if :meth:`is_not_pending` is true. :rtype: str

def get_rate_limited(self): (source)

Too many emails are being sent to this email address. Please try again later. Only call this if :meth:`is_rate_limited` is true. :rtype: str

def get_success(self): (source)

A verification email was successfully sent to the secondary email address. Only call this if :meth:`is_success` is true. :rtype: str

def is_not_pending(self): (source)

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

def is_other(self): (source)

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

def is_rate_limited(self): (source)

Check if the union tag is ``rate_limited``. :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