Member

Implementation of the Discord Member class in Luau

https://discord.com/developers/docs/resources/guild#guild-member-object

Properties

user

Member.user :: Classes.User

The user this member represents.

communicationDisabledUntil

Member.communicationDisabledUntil :: DateTime

When the member’s communication is disabled until.

avatarDecorationData

Member.avatarDecorationData :: Classes.AvatarDecoration

The member’s avatar decoration data.

flags

Member.flags :: Classes.GuildMemberBitflag

Member flags combined as a bitfield.

joinedAt

Member.joinedAt :: DateTime

When the member joined the guild.

premiumSince

Member.premiumSince :: DateTime

When the member started boosting the guild.

nick

Member.nick :: string

The member’s nickname.

avatar

Member.avatar :: string

The member’s avatar hash.

roles

Member.roles :: { string }

The member’s role IDs.

deaf

Member.deaf :: boolean

Whether the member is deafened.

mute

Member.mute :: boolean

Whether the member is muted.

pending

Member.pending :: boolean

Whether the member has not yet passed the guild’s Membership Screening requirements.

permissions

Member.permissions :: string

The member’s permissions.

Methods

The Member instance has no set methods!

Functions

banAsync

Member . banAsync (

     self: Member
     reason: string?
     deleteMessageDays: number?
     deleteMessageSeconds: number?
) -> ()

Create a guild ban, and optionally delete previous messages sent by the banned user.

kickAsync

Member . kickAsync (

self: Member
reason: string?
) -> ()

Removes a role from a guild member. Requires the MANAGE_ROLES permission.

modifyAsync

Member . modifyAsync (

     self: Member
     data: {
       nickname: string?,
       roles: { apiTypes.Snowflake,
    } | boolean)?, communicationDisabledUntil: string?, }
     reason: string?
) -> ()

Modify attributes of a guild member. Returns updated guild member. If the channel_id is set to null, this will force the target user to be disconnected from voice.

muteAsync

Member . muteAsync (

self: Member
reason: string?
) -> ()

Will mute the user in voice channels the user is in. Returns the updated Member.

unmuteAsync

Member . unmuteAsync (

self: Member
reason: string?
) -> ()

Will unmute the user in voice channels the user is in. Returns the updated Member.

deafenAsync

Member . deafenAsync (

self: Member
reason: string?
) -> ()

Will deafen the user in voice channels the user is in. Returns the updated Member.

undeafenAsync

Member . undeafenAsync (

self: Member
reason: string?
) -> ()

Will undeafen the user in voice channels the user is in. Returns the updated Member.

setNicknameAsync

Member . setNicknameAsync (

     self: Member
     nickname: string
     reason: string?
) -> ()

Will set the nickname of the user. Returns the updated Member.

setRolesAsync

Member . setRolesAsync (

     self: Member
     roles: { apiTypes.Snowflake }
     reason: string?
) -> ()

Will set all roles that the user has in this guild. Returns the updated Member.

moveVoiceChannelAsync

Member . moveVoiceChannelAsync (

     self: Member
     channelId: apiTypes.Snowflake
     reason: string?
) -> ()

Will move the user between different voice channels. Returns the updated Member.

disconnectFromVoiceChannelAsync

Member . disconnectFromVoiceChannelAsync (

self: Member
reason: string?
) -> ()

Will disconnect the user from voice channels the user is in. Returns the updated Member.

disableAsync

Member . disableAsync (

     self: Member
     disabledUntil: stdPolyfills.DateTime
     reason: string?
) -> ()

Disables the users communication up to a specific time. Returns the updated Member.

addRoleAsync

Member . addRoleAsync (

     self: Member
     roleId: apiTypes.Snowflake
     reason: string?
) -> ()

Add a role to a guild member.

removeRoleAsync

Member . removeRoleAsync (

     self: Member
     roleId: apiTypes.Snowflake
     reason: string?
) -> ()

Remove a role from a guild member.

sync

Member . sync (

self: Member
guildMemberData: apiTypes.GuildMemberObject
) -> ()

Synchronizes the member object with the data from the API.

new

Member . new (

     state: state.State
     guildId: apiTypes.Snowflake
     guildMemberData: apiTypes.GuildMemberObject
) -> ()

Creates a new Member instance with the specified member data.