Class SocketGuildOnboarding

Namespace

Discord.WebSocket

Assembly

Discord.Net.WebSocket.dll

Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.

public class SocketGuildOnboarding : IGuildOnboarding

Inheritance

object

SocketGuildOnboarding

Implements

IGuildOnboarding

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

GuildOnboardingExtensions.ToProperties(IGuildOnboarding)

Properties

DefaultChannelIds

Gets IDs of channels that members get opted into automatically.

public IReadOnlyCollection<ulong> DefaultChannelIds { get; }

Property Value

IReadOnlyCollection<ulong>

DefaultChannels

Gets channels members get opted in automatically.

public IReadOnlyCollection<SocketGuildChannel> DefaultChannels { get; }

Property Value

IReadOnlyCollection<SocketGuildChannel>

Guild

Gets the guild this onboarding is part of.

public SocketGuild Guild { get; }

Property Value

SocketGuild

GuildId

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

public ulong GuildId { get; }

Property Value

ulong

IsBelowRequirements

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

public bool IsBelowRequirements { get; }

Property Value

bool

IsEnabled

Gets whether onboarding is enabled in the guild.

public bool IsEnabled { get; }

Property Value

bool

Mode

Gets the current mode of onboarding.

public GuildOnboardingMode Mode { get; }

Property Value

GuildOnboardingMode

Prompts

Gets prompts shown during onboarding and in customize community.

public IReadOnlyCollection<SocketGuildOnboardingPrompt> Prompts { get; }

Property Value

IReadOnlyCollection<SocketGuildOnboardingPrompt>

Methods

ModifyAsync(Action<GuildOnboardingProperties>, RequestOptions)

Modifies the onboarding object.

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

Parameters

props Action<GuildOnboardingProperties>

options RequestOptions

Returns

Task