OnboardingScreen
Represents a guild onboarding screen.
Attributes
None, tuple of intThe channels' identifiers that new members get opted into automatically.
boolWhether onboarding is enabled.
intThe guild's identifier the onboarding screen is part of.
OnboardingModeOnboarding mode.
The prompts shown during onboarding and in customize community.
Properties
default_channels
Returns the default channels that new get opted into automatically.
Returns
default_channels : None, tuple of Channel
guild
Returns the onboarding screen's owner guild identifier. If the guild is not cached then returns None.
Returns
guild : None, Guild
Methods
__new__(...)
Creates an onboarding screen instance from the given parameters.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| default_channel_ids |
| The channels' identifiers that new members get opted into automatically. | ||
| enabled |
| Whether onboarding is enabled. | ||
| mode |
| Onboarding mode. | ||
| prompts |
| The prompts shown during onboarding and in customize community. |
Raises
TypeError
- If a parameter's type is incorrect.
ValueError
- If a parameter's value is incorrect.
copy()
Copies the onboarding screen.
Returns
new : instance<cls>
copy_with(...)
Copies the onboarding screen with the given screen.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| default_channel_ids |
| The channels' identifiers that new members get opted into automatically. | ||
| enabled |
| Whether onboarding is enabled. | ||
| mode |
| Onboarding mode. | ||
| prompts |
| The prompts shown during onboarding and in customize community. |
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 onboarding screen instance from the given data.
| Parameter | Type | Description |
|---|---|---|
| data |
| Auto moderation rule trigger metadata payload. |
Returns
self : instance<cls>
iter_default_channel_ids()
Iterates over the default channels that new get opted into automatically.
This method is an iterable generator.
Yields
default_channel_id : int
iter_default_channels()
Iterates over the default channels that new get opted into automatically.
This method is an iterable generator.
Yields
default_channel : Channel
iter_prompts()
Iterates over the prompts that are shown during onboarding and in customize community.
This method is an iterable generator.
Yields
prompt : OnboardingPrompt
precreate(...)
Precreates an onboarding screen. Since they are not cached, this method just a .__new__ alternative.
| Parameter | Type | Optional | Keyword only | Description |
|---|---|---|---|---|
| **keyword_parameters | Keyword parameters | Additional parameters defining how the option's fields should be set. | ||
| default_channel_ids |
| The channels' identifiers that new members get opted into automatically. | ||
| default_channels |
| Alternative of | ||
| enabled |
| Whether onboarding is enabled. | ||
| guild |
| Alternative of | ||
| guild_id |
| The guild's identifier the onboarding screen is part of. | ||
| mode |
| Onboarding mode. | ||
| prompts |
| The prompts shown during onboarding and in customize community. |
Returns
self : instance<type<self>>
to_data(...)
Converts the onboarding screen to a json serializable object.
| Parameter | Type | Optional | Keyword only | Default | Description |
|---|---|---|---|---|---|
| defaults |
|
| Whether default fields should be included as well. | ||
| include_internals |
|
| Whether internal fields (like id-s) should be included. |
Returns
data : dict of (str, object) items
__eq__()
Returns whether the two onboarding screen's are equal.
__getattr__()
Drops a rich attribute error.
__hash__()
Returns the onboarding screen's hash value .
__repr__()
Returns the onboarding screen's representation.