WelcomeScreen
Represents a guild's welcome screen.
Attributes
None, strDescription, of what is the server about.
The featured channels by the welcome screen.
Methods
__new__(...)
Creates a new welcome screen.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| description |
| Description, of what is the server about. | ||
| welcome_channels |
| The featured channels by the welcome screen. |
Raises
TypeError
- If a parameter's type is incorrect.
ValueError
- If a parameter's value is incorrect.
copy()
Copies the welcome screen.
Returns
new : instance<type<self>>
copy_with(...)
Copies the welcome screen with the given fields.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| description |
| Description, of what is the server about. | ||
| welcome_channels |
| The featured channels by the welcome screen. |
Returns
new : instance<type<self>>
Raises
TypeError
- If a parameter's type is incorrect.
ValueError
- If a parameter's value is incorrect.
from_data(data)
Creates a new welcome screen instance from the given data.
| Parameter | Type | Description |
|---|---|---|
| data |
| Welcome screen data. |
iter_welcome_channels()
Iterates over the welcome channels of the welcome screen.
This method is an iterable generator.
Yields
welcome_channel : WelcomeScreenChannel
to_data(...)
Converts the welcome screen to a json serializable object.
| Parameter | Type | Optional | Keyword only | Default | Description |
|---|---|---|---|---|---|
| defaults |
|
| Whether fields with their default values should be included as well. |
Returns
data : dict of (str, object) items
__eq__()
Returns whether the two welcome screens are equal.
__getattr__()
Drops a rich attribute error.
__hash__()
Returns the welcome screen's hash.
__repr__()
Returns the welcome screen's representation.