Interface EditOnboardingOptions

interface EditOnboardingOptions {
    defaultChannelIDs?: string[];
    enabled?: boolean;
    mode?: OnboardingModes;
    prompts?: OnboardingPrompt[];
    reason?: string;
}

Index

Properties

defaultChannelIDs? enabled? mode? prompts? reason?

Properties

`Optional` defaultChannelIDs

defaultChannelIDs?: string[]

Channel IDs that members get opted into automatically.

`Optional` enabled

enabled?: boolean

If onboarding is enabled.

`Optional` mode

mode?: OnboardingModes

The mode for onboarding, used to determine requirements.

`Optional` prompts

prompts?: OnboardingPrompt[]

The prompts shown during onboarding.

`Optional` reason

reason?: string

The reason for editing the onboarding configuration.