VerificationScreenStep
Represents a step of a VerificationScreen.
Attributes
boolWhether the user must accept this step to continue.
strThe step's title.
VerificationScreenStepTypeThe type of the step.
None, tuple of strThe values of the step.
Methods
__new__(...)
Creates a new verification screen step.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| required |
| Whether the user must accept this step to continue. | ||
| step_type | The type of the step. | |||
| title |
| The step's title. | ||
| values |
| The values of the step. |
Raises
TypeError
- If a parameter's type is invalid.
ValueError
- If a parameter's value is invalid.
copy()
Copies the verification screen step.
Returns
new : instance<type<self>>
copy_with(...)
Copies the verification step with the given fields.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| required |
| Whether the user must accept this step to continue. | ||
| step_type | The type of the step. | |||
| title |
| The step's title. | ||
| values |
| The values of the step. |
Returns
new : instance<type<self>>
Raises
TypeError
- If a parameter's type is invalid.
ValueError
- If a parameter's value is invalid.
from_data(data)
Creates a new verification screen step from the given data.
| Parameter | Type | Description |
|---|---|---|
| data |
| Verification screen step data. |
iter_values()
Iterates over the values of the verification screen.
This method is an iterable generator.
Yields
value : str
to_data(...)
Converts the verification screen step to a json serializable object.
| Parameter | Type | Optional | Keyword only | Default | Description |
|---|---|---|---|---|---|
| defaults |
|
| Whether default values should be included as well. |
Returns
data : dict of (str, object)
__eq__()
Returns whether the two verification screen steps are equal
__getattr__()
Drops a rich attribute error.
__hash__()
Returns the verification screen step's hash value.
__repr__()
Returns the verification screen step's representation.