Struct twilight_http::request::guild::member::get_guild_members::GetGuildMembers

pub struct GetGuildMembers<'a> { /* fields omitted */ }

Get the members of a guild, by id.

The upper limit to this request is 1000. If more than 1000 members are needed, the requests must be chained. Discord defaults the limit to 1.

Examples

Get the first 500 members of guild 100 after user ID 3000:

use twilight_http::Client;
use twilight_model::id::{GuildId, UserId};

let client = Client::new("my token".to_owned());

let guild_id = GuildId::new(100).expect("non zero");
let user_id = UserId::new(3000).expect("non zero");
let members = client.guild_members(guild_id).after(user_id).exec().await?;

Implementations

impl<'a> GetGuildMembers<'a>

pub const fn after(self, after: UserId) -> Self

Sets the user ID to get members after.

pub const fn limit(self, limit: u64) -> Result<Self, GetGuildMembersError>

Sets the number of members to retrieve per request.

The limit must be greater than 0 and less than 1000.

Errors

Returns a GetGuildMembersErrorType::LimitInvalid error type if the limit is 0 or greater than 1000.

pub const fn presences(self, presences: bool) -> Self

Sets whether to retrieve matched member presences

pub fn exec(self) -> ResponseFuture<MemberListBody>

Execute the request, returning a future resolving to a Response.