Struct EditGuildWelcomeScreen

pub struct EditGuildWelcomeScreen<'a> { /* private fields */ }

A builder to edit the welcome screen of a guild

Discord docs

Implementations

impl<'a> EditGuildWelcomeScreen<'a>

pub fn new() -> Self

Equivalent to Self::default.

pub fn enabled(self, enabled: bool) -> Self

Whether the welcome screen is enabled or not.

pub fn description(self, description: impl Into<String>) -> Self

The server description shown in the welcome screen.

pub fn add_welcome_channel(self, channel: CreateGuildWelcomeChannel) -> Self

pub fn set_welcome_channels( self, channels: Vec<CreateGuildWelcomeChannel>, ) -> Self

Channels linked in the welcome screen and their display options

pub fn audit_log_reason(self, reason: &'a str) -> Self

Sets the request’s audit log reason.

Trait Implementations

impl Builder for EditGuildWelcomeScreen<'_>

fn execute<'life0, 'async_trait>( self, cache_http: impl 'async_trait + CacheHttp, ctx: Self::Context<'life0>, ) -> Pin<Box<dyn Future<Output = Result<Self::Built>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Edits the guild’s welcome screen.

Note: Requires the Manage Guild permission.

Errors

Returns Error::Http if the current user lacks permission.

type Context<'ctx> = GuildId

Additional data that’s only required when sending a request off to the API.

type Built = GuildWelcomeScreen

impl<'a> Clone for EditGuildWelcomeScreen<'a>

fn clone(&self) -> EditGuildWelcomeScreen<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for EditGuildWelcomeScreen<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for EditGuildWelcomeScreen<'a>

fn default() -> EditGuildWelcomeScreen<'a>

Returns the “default value” for a type.

impl<'a> Serialize for EditGuildWelcomeScreen<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.