Table of Contents

Interface IGuildOnboarding

Namespace
Discord
Assembly
Discord.Net.Core.dll

Represents the guild onboarding flow.

public interface IGuildOnboarding
Extension Methods

Properties

DefaultChannelIds

Gets IDs of channels that members get opted into automatically.

IReadOnlyCollection<ulong> DefaultChannelIds { get; }

Property Value

IReadOnlyCollection<ulong>

Guild

Gets the guild this onboarding is part of.

IGuild Guild { get; }

Property Value

IGuild

GuildId

Gets the ID of the guild this onboarding is part of.

ulong GuildId { get; }

Property Value

ulong

IsBelowRequirements

Gets whether the server does not meet requirements to enable guild onboarding.

bool IsBelowRequirements { get; }

Property Value

bool

IsEnabled

Gets whether onboarding is enabled in the guild.

bool IsEnabled { get; }

Property Value

bool

Mode

Gets the current mode of onboarding.

GuildOnboardingMode Mode { get; }

Property Value

GuildOnboardingMode

Prompts

Gets prompts shown during onboarding and in customize community.

IReadOnlyCollection<IGuildOnboardingPrompt> Prompts { get; }

Property Value

IReadOnlyCollection<IGuildOnboardingPrompt>

Methods

ModifyAsync(Action<GuildOnboardingProperties>, RequestOptions)

Modifies the onboarding object.

Task ModifyAsync(Action<GuildOnboardingProperties> props, RequestOptions options = null)

Parameters

props Action<GuildOnboardingProperties>
options RequestOptions

Returns

Task
Edit this page