Struct AddMember

pub struct AddMember { /* private fields */ }

A builder to add parameters when using GuildId::add_member.

Discord docs.

Implementations

impl AddMember

pub fn new(access_token: String) -> Self

Constructs a new builder with the given access token, leaving all other fields empty.

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

Sets the OAuth2 access token for this request, replacing the current one.

Requires the access token to have the guilds.join scope granted.

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

Sets the member’s nickname.

Requires the Manage Nicknames permission.

pub fn roles(self, roles: impl IntoIterator<Item = impl Into<RoleId>>) -> Self

Sets the list of roles that the member should have.

Requires the Manage Roles permission.

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

Whether to mute the member.

Requires the Mute Members permission.

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

Whether to deafen the member.

Requires the Deafen Members permission.

Trait Implementations

impl Builder for AddMember

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,

Adds a User to this guild with a valid OAuth2 access token.

Returns the created Member object, or nothing if the user is already a member of the guild.

Errors

Returns Error::Http if the current user lacks permission, or if invalid data is given.

type Context<'ctx> = (GuildId, UserId)

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

type Built = Option<Member>

impl Clone for AddMember

fn clone(&self) -> AddMember

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AddMember

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

Formats the value using the given formatter.

impl Serialize for AddMember

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

where __S: Serializer,

Serialize this value into the given Serde serializer.