Class GuildOnboardingOptions

Namespace

NetCord.Rest

Assembly

NetCord.dll

public class GuildOnboardingOptions

Inheritance

object

GuildOnboardingOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

DefaultChannelIds

Channel ids that members get opted into automatically.

[JsonPropertyName("default_channel_ids")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IEnumerable<ulong>? DefaultChannelIds { get; set; }

Property Value

IEnumerable<ulong>

Enabled

Whether onboarding is enabled in the guild.

[JsonPropertyName("enabled")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? Enabled { get; set; }

Property Value

bool?

Mode

Current mode of onboarding.

[JsonPropertyName("mode")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public GuildOnboardingMode? Mode { get; set; }

Property Value

GuildOnboardingMode?

Prompts

Prompts shown during onboarding and in customize community.

[JsonPropertyName("prompts")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IEnumerable<GuildOnboardingPromptProperties>? Prompts { get; set; }

Property Value

IEnumerable<GuildOnboardingPromptProperties>

Methods

AddDefaultChannelIds(IEnumerable<ulong>)

Channel ids that members get opted into automatically.

public GuildOnboardingOptions AddDefaultChannelIds(IEnumerable<ulong> defaultChannelIds)

Parameters

defaultChannelIds IEnumerable<ulong>

Returns

GuildOnboardingOptions

AddDefaultChannelIds(params ulong[])

Channel ids that members get opted into automatically.

public GuildOnboardingOptions AddDefaultChannelIds(params ulong[] defaultChannelIds)

Parameters

defaultChannelIds ulong[]

Returns

GuildOnboardingOptions

AddPrompts(params GuildOnboardingPromptProperties[])

Prompts shown during onboarding and in customize community.

public GuildOnboardingOptions AddPrompts(params GuildOnboardingPromptProperties[] prompts)

Parameters

prompts GuildOnboardingPromptProperties[]

Returns

GuildOnboardingOptions

AddPrompts(IEnumerable<GuildOnboardingPromptProperties>)

Prompts shown during onboarding and in customize community.

public GuildOnboardingOptions AddPrompts(IEnumerable<GuildOnboardingPromptProperties> prompts)

Parameters

prompts IEnumerable<GuildOnboardingPromptProperties>

Returns

GuildOnboardingOptions

WithDefaultChannelIds(IEnumerable<ulong>?)

Channel ids that members get opted into automatically.

public GuildOnboardingOptions WithDefaultChannelIds(IEnumerable<ulong>? defaultChannelIds)

Parameters

defaultChannelIds IEnumerable<ulong>

Returns

GuildOnboardingOptions

WithEnabled(bool?)

Whether onboarding is enabled in the guild.

public GuildOnboardingOptions WithEnabled(bool? enabled = true)

Parameters

enabled bool?

Returns

GuildOnboardingOptions

WithMode(GuildOnboardingMode?)

Current mode of onboarding.

public GuildOnboardingOptions WithMode(GuildOnboardingMode? mode)

Parameters

mode GuildOnboardingMode?

Returns

GuildOnboardingOptions

WithPrompts(IEnumerable<GuildOnboardingPromptProperties>?)

Prompts shown during onboarding and in customize community.

public GuildOnboardingOptions WithPrompts(IEnumerable<GuildOnboardingPromptProperties>? prompts)

Parameters

prompts IEnumerable<GuildOnboardingPromptProperties>

Returns

GuildOnboardingOptions