WelcomeScreenChannel
Represents a featured channel by a welcome screen.
Attributes
intThe represented channel's identifier.
None, strThe channel's short description.
None, EmojiAn emoji displayed before the description.
Properties
channel
Methods
__new__(...)
Creates a new welcome channel.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| channel_id |
| The represented channel or its identifier. | ||
| description |
| The channel's short description. | ||
| emoji |
| An emoji displayed before the |
Raises
TypeError
- If a parameter's type is incorrect.
ValueError
- If a parameter's value is incorrect.
copy()
Copies the welcome channel.
Returns
new : instance<type<self>>
copy_with(...)
Creates a new welcome channel with the given fields.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| channel_id |
| The represented channel or its identifier. | ||
| description |
| The channel's short description. | ||
| emoji |
| An emoji displayed before the |
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 channel instance from the given data.
| Parameter | Type | Description |
|---|---|---|
| data |
| Welcome channel data. |
Returns
new : instance<cls>
to_data(...)
Converts the welcome channel to a json serializable object.
| Parameter | Type | Optional | Keyword only | Default | Description |
|---|---|---|---|---|---|
| defaults |
|
| Whether default values should be included as well. |
Returns
data : str
__eq__()
Returns whether the two welcome channels are equal.
__getattr__()
Drops a rich attribute error.
__hash__()
Returns the welcome channel's hash.
__repr__()
Returns the welcome channel's representation.