Adds docs for Onboarding updates and new mode field #6101
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hammerdr
force-pushed
the
onboarding/update
branch
from
a27d06d to
42336a7
Compare
This was referenced Apr 19, 2023
8 tasks
Victorsitou
reviewed
Apr 19, 2023
| @@ -1272,6 +1280,19 @@ Modify the guild's [Welcome Screen](#DOCS_RESOURCES_GUILD/welcome-screen-object) | |||
|
|
|||
| Returns the [Onboarding](#DOCS_RESOURCES_GUILD/guild-onboarding-object) object for the guild. | |||
|
|
|||
| ## Modify Guild Onboarding % PUT /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/onboarding | |||
There was a problem hiding this comment.
This seems to allow the X-Audit-Log-Reason header
jaw0r3k
reviewed
Apr 21, 2023
Comment on lines
+1299
to
+1302
| | prompts | array of [onboarding prompt](#DOCS_RESOURCES_GUILD/guild-onboarding-object-onboarding-prompt-structure) objects | Prompts shown during onboarding and in customize community | | ||
| | default_channel_ids | array of snowflakes | Channel IDs that members get opted into automatically | | ||
| | enabled | boolean | Whether onboarding is enabled in the guild | | ||
| | mode | [onboarding mode](#DOCS_RESOURCES_GUILD/guild-onboarding-object-onboarding-mode) | Current mode of onboarding | |
There was a problem hiding this comment.
Could you add a note that all params are optional?
lukellmann
reviewed
Apr 23, 2023
|
|
||
| | Field | Type | Description | | ||
| | ------------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | | ||
| | prompts | array of [onboarding prompt](#DOCS_RESOURCES_GUILD/guild-onboarding-object-onboarding-prompt-structure) objects | Prompts shown during onboarding and in customize community | |
There was a problem hiding this comment.
the Onboarding Prompt Structure contains an id, is it required to be included?
Victorsitou
reviewed
Apr 25, 2023
|
Suggestion: add the following error code to | 350001 | Cannot update onboarding while below requirements |Occurs when one of the requirements (number of default channels for example) isn't met anymore and a bot/user tries to edit any part of onboarding |
shaydewael
reviewed
May 25, 2023
DonovanDMC
added a commit
to OceanicJS/Oceanic
that referenced
this pull request
May 27, 2023
Co-authored-by: shay <swdewael@gmail.com>
This was referenced Jun 13, 2023
shaydewael
approved these changes
Jun 15, 2023
9 tasks
|
Thanks |
|
Thanks 😀😊 |
3 tasks
Nihlus
added a commit
to Remora/Remora.Discord
that referenced
this pull request
Jul 14, 2023
lukellmann
added a commit
to kordlib/kord
that referenced
this pull request
Sep 17, 2023
The DSL looks like this:
val onboarding = guild.editOnboarding {
enabled = true
mode = OnboardingMode.Advanced
defaultChannelId(channelId1)
defaultChannelId(channelId2)
defaultChannelId(channelId3)
defaultChannelId(channelId4)
defaultChannelId(channelId5)
defaultChannelId(channelId6)
defaultChannelId(channelId7)
prompt(
OnboardingPromptType.MultipleChoice,
title = "prompt title",
singleSelect = false,
required = false,
inOnboarding = true,
) {
option(title = "option 1 title") {
channelIds += someChannelId
description = "option 1 description"
}
option(title = "option 2 title") {
roleIds += someRoleId
}
}
}
println(onboarding)
See discord/discord-api-docs#6101
lukellmann
added a commit
to kordlib/kord
that referenced
this pull request
Sep 17, 2023
The DSL looks like this:
val onboarding = guild.editOnboarding {
enabled = true
mode = OnboardingMode.Advanced
defaultChannelId(channelId1)
defaultChannelId(channelId2)
defaultChannelId(channelId3)
defaultChannelId(channelId4)
defaultChannelId(channelId5)
defaultChannelId(channelId6)
defaultChannelId(channelId7)
prompt(
OnboardingPromptType.MultipleChoice,
title = "prompt title",
singleSelect = false,
required = false,
inOnboarding = true,
) {
option(title = "option 1 title") {
channelIds += someChannelId
description = "option 1 description"
}
option(title = "option 2 title") {
roleIds += someRoleId
}
}
}
println(onboarding)
See discord/discord-api-docs#6101
lukellmann
added a commit
to kordlib/kord
that referenced
this pull request
Sep 17, 2023
The DSL looks like this:
val onboarding = guild.editOnboarding {
enabled = true
mode = OnboardingMode.Advanced
defaultChannelId(channelId1)
defaultChannelId(channelId2)
defaultChannelId(channelId3)
defaultChannelId(channelId4)
defaultChannelId(channelId5)
defaultChannelId(channelId6)
defaultChannelId(channelId7)
prompt(
OnboardingPromptType.MultipleChoice,
title = "prompt title",
singleSelect = false,
required = false,
inOnboarding = true,
) {
option(title = "option 1 title") {
channelIds += someChannelId
description = "option 1 description"
}
option(title = "option 2 title") {
roleIds += someRoleId
}
}
}
println(onboarding)
See discord/discord-api-docs#6101
shaydewael
added a commit
to Jupith/discord-api-docs
that referenced
this pull request
May 14, 2024
* Adds docs for Onboarding updates and new mode field * Add constraints and info * Update docs/resources/Guild.md Co-authored-by: shay <swdewael@gmail.com> * add error codes for onboarding --------- Co-authored-by: shay <swdewael@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.