class documentation

class UserResendResult(bb.Union): (source)

View In Hierarchy

Result of trying to resend verification emails to a user. 'success' is the only value indicating that a user was successfully retrieved for sending verification 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 UserResendEmailsResult UserResendResult.success: Describes a user and the results for each attempt to resend verification emails. :ivar UserSelectorArg UserResendResult.invalid_user: Specified user is not a valid target for resending verification emails.

Class Method invalid_user Create an instance of this class set to the ``invalid_user`` tag with value ``val``.
Class Method success Create an instance of this class set to the ``success`` tag with value ``val``.
Method get_invalid_user Specified user is not a valid target for resending verification emails.
Method get_success Describes a user and the results for each attempt to resend verification emails.
Method is_invalid_user Check if the union tag is ``invalid_user``.
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 invalid_user(cls, val): (source)

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

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

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

def get_invalid_user(self): (source)

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

def get_success(self): (source)

Describes a user and the results for each attempt to resend verification emails. Only call this if :meth:`is_success` is true. :rtype: UserResendEmailsResult

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_success(self): (source)

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

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented