Method ModifyOnboardingAsync

Namespace

DisCatSharp.Entities

Assembly

DisCatSharp.dll

ModifyOnboardingAsync(Optional<List<DiscordOnboardingPrompt>>, Optional<List<ulong>>, Optional<bool>, Optional<OnboardingMode>, string?)

Modifies this guilds onboarding configuration.

[RequiresFeature(Features.Community)]
public Task<DiscordOnboarding> ModifyOnboardingAsync(Optional<List<DiscordOnboardingPrompt>> prompts = default, Optional<List<ulong>> defaultChannelIds = default, Optional<bool> enabled = default, Optional<OnboardingMode> mode = default, string? reason = null)

Parameters

prompts Optional<List<DiscordOnboardingPrompt>>

The onboarding prompts

defaultChannelIds Optional<List<ulong>>

The default channel ids.

enabled Optional<bool>

Whether onboarding is enabled.

mode Optional<OnboardingMode>

The onboarding mode.

reason string

The reason.

Returns

Task<DiscordOnboarding>

Exceptions

UnauthorizedException

Thrown when the client does not have the ManageGuild permission.

BadRequestException

Thrown when an invalid parameter was provided.

ServerErrorException

Thrown when Discord is unable to process the request.