Class SocketGuildOnboardingPrompt

Namespace

Discord.WebSocket

Assembly

Discord.Net.WebSocket.dll

Represents the guild onboarding prompt.

public class SocketGuildOnboardingPrompt : SocketEntity<ulong>, IGuildOnboardingPrompt, ISnowflakeEntity, IEntity<ulong>

Inheritance

object

SocketEntity<ulong>

SocketGuildOnboardingPrompt

Implements

IGuildOnboardingPrompt

ISnowflakeEntity

IEntity<ulong>

Inherited Members

SocketEntity<ulong>.Id

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

GuildOnboardingExtensions.ToProperties(IGuildOnboardingPrompt)

Properties

CreatedAt

Gets when the snowflake was created.

public DateTimeOffset CreatedAt { get; }

Property Value

DateTimeOffset

A DateTimeOffset representing when the entity was first created.

IsInOnboarding

Indicates whether the prompt is present in the onboarding flow. If false, the prompt will only appear in the Channels and Roles tab.

public bool IsInOnboarding { get; }

Property Value

bool

IsRequired

Indicates whether the prompt is required before a user completes the onboarding flow.

public bool IsRequired { get; }

Property Value

bool

IsSingleSelect

Indicates whether users are limited to selecting one option for the prompt.

public bool IsSingleSelect { get; }

Property Value

bool

Options

Gets options available within the prompt.

public IReadOnlyCollection<SocketGuildOnboardingPromptOption> Options { get; }

Property Value

IReadOnlyCollection<SocketGuildOnboardingPromptOption>

Title

Gets the title of the prompt.

public string Title { get; }

Property Value

string

Type

Gets the type of the prompt.

public GuildOnboardingPromptType Type { get; }

Property Value

GuildOnboardingPromptType