Class GuildOnboardingPromptProperties

Namespace

NetCord.Rest

Assembly

NetCord.dll

public class GuildOnboardingPromptProperties

Inheritance

object

GuildOnboardingPromptProperties

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

GuildOnboardingPromptProperties(GuildOnboardingPromptType, IEnumerable<GuildOnboardingPromptOptionProperties>, string)

public GuildOnboardingPromptProperties(GuildOnboardingPromptType type, IEnumerable<GuildOnboardingPromptOptionProperties> options, string title)

Parameters

type GuildOnboardingPromptType

Type of the prompt.

options IEnumerable<GuildOnboardingPromptOptionProperties>

Options available within the prompt.

title string

Title of the prompt.

Properties

Id

ID of the prompt.

[JsonPropertyName("id")]
public ulong? Id { get; set; }

Property Value

ulong?

InOnboarding

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

[JsonPropertyName("in_onboarding")]
public bool InOnboarding { get; set; }

Property Value

bool

Options

Options available within the prompt.

[JsonPropertyName("options")]
public IEnumerable<GuildOnboardingPromptOptionProperties> Options { get; set; }

Property Value

IEnumerable<GuildOnboardingPromptOptionProperties>

Required

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

[JsonPropertyName("required")]
public bool Required { get; set; }

Property Value

bool

SingleSelect

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

[JsonPropertyName("single_select")]
public bool SingleSelect { get; set; }

Property Value

bool

Title

Title of the prompt.

[JsonPropertyName("title")]
public string Title { get; set; }

Property Value

string

Type

Type of the prompt.

[JsonPropertyName("type")]
public GuildOnboardingPromptType Type { get; set; }

Property Value

GuildOnboardingPromptType

Methods

AddOptions(params IEnumerable<GuildOnboardingPromptOptionProperties>)

Options available within the prompt.

public GuildOnboardingPromptProperties AddOptions(params IEnumerable<GuildOnboardingPromptOptionProperties> options)

Parameters

options IEnumerable<GuildOnboardingPromptOptionProperties>

Returns

GuildOnboardingPromptProperties

WithId(ulong?)

ID of the prompt.

public GuildOnboardingPromptProperties WithId(ulong? id)

Parameters

id ulong?

Returns

GuildOnboardingPromptProperties

WithInOnboarding(bool)

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

public GuildOnboardingPromptProperties WithInOnboarding(bool inOnboarding = true)

Parameters

inOnboarding bool

Returns

GuildOnboardingPromptProperties

WithOptions(IEnumerable<GuildOnboardingPromptOptionProperties>)

Options available within the prompt.

public GuildOnboardingPromptProperties WithOptions(IEnumerable<GuildOnboardingPromptOptionProperties> options)

Parameters

options IEnumerable<GuildOnboardingPromptOptionProperties>

Returns

GuildOnboardingPromptProperties

WithRequired(bool)

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

public GuildOnboardingPromptProperties WithRequired(bool required = true)

Parameters

required bool

Returns

GuildOnboardingPromptProperties

WithSingleSelect(bool)

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

public GuildOnboardingPromptProperties WithSingleSelect(bool singleSelect = true)

Parameters

singleSelect bool

Returns

GuildOnboardingPromptProperties

WithTitle(string)

Title of the prompt.

public GuildOnboardingPromptProperties WithTitle(string title)

Parameters

title string

Returns

GuildOnboardingPromptProperties

WithType(GuildOnboardingPromptType)

Type of the prompt.

public GuildOnboardingPromptProperties WithType(GuildOnboardingPromptType type)

Parameters

type GuildOnboardingPromptType

Returns

GuildOnboardingPromptProperties