Member

type

A user within a guild: roles, nickname, flags, activities and dates.

34 syntaxesnet.dv8tion.jda.api.entities.Member

34 / 34

Properties

propertyText

[the] effective name of %member%

%member%'s effective name

Helpful?

propertylist of Role since 5.0.0-a1

[the] roles of %member%

%member%'s roles

The roles of the member. Add or remove roles to grant/revoke them.

change modes addremove

Helpful?

propertyDatesince 5.0.0-a1

[the] join date of %member%

%member%'s join date

The date at which the member joined the guild.

Helpful?

propertyDatesince 5.0.0-a1

[the] boost date of %member%

%member%'s boost date

The date at which the member started boosting the guild, or null if the member is not boosting.

Helpful?

propertylist of MemberFlag since 5.0.0-a1

[the] flags of %member%

%member%'s flags

The flags of the member (e.g. did rejoin, completed onboarding, bypasses verification...). Add or remove modifiable flags to toggle them.

change modes addremove

Helpful?

propertyRolecolorsince 5.0.0-a1

[the] discord colors of %member%

%member%'s discord colors

The role colors of a member's name in the guild.

Determined by the colors of the highest role assigned to the member that does not have the default colors.

Helpful?

propertylist of Activitysince 5.0.0-a1

[the] activities of %member%

%member%'s activities

All activities of a member (playing, streaming, listening, watching, custom status, competing).

Returns an empty list if the member has no activity.

Requires CacheFlag.ACTIVITY to be enabled on the bot, along with the GUILD_PRESENCES intent.

Helpful?

propertyAudiochannelsince 5.0.0-a1

[the] voice channel of %member%

%member%'s voice channel

The audio (voice) channel the member is currently connected to, or null if they are not in a voice channel.

Helpful?

propertylist of Permissionsince 5.0.0-b1

[the] discord permissions of %member%

%member%'s discord permissions

The effective guild-wide permissions of the member: every permission given by its roles and by @everyone, or all of them for the owner and for an administrator. Channel overrides are not included; use the discord permissions of the member in a channel for that.

Read-only: a member gets its permissions from its roles, so change the roles or the role permissions instead.

Helpful?

propertyText since 5.0.0-a1

[the] nickname of %member%

%member%'s nickname

A guild member's nickname, which is their display name on that guild. Co-owned with Skript's native Property.DISPLAY_NAME, so "nickname of", "display name of" and "custom name of" all reach it.

For the name that falls back to the account name when no nickname is set, use "effective name".

change modes set

mentioned inLinking

Helpful?

propertyText since 5.0.0-a1

[the] name of %member%

%member%'s name

The name of a Discord entity: a user's or member's account name, a guild's name, a role/channel name, a bot's define-name. Registered on Skript's native Property.NAME, so the idiomatic "name of %x%" works without colliding. For a member's server nickname or display name, use "effective name".

Helpful?

propertyOnlineStatus since 5.0.0-a1

[the] online status of %member%

%member%'s online status

The online status of a Discord entity. Read-only on a member (the presence Discord reports: online, idle, do not disturb, offline...). On a bot it is the live presence and can be set (online / idle / dnd / invisible). One syntax, dispatched per type — "online status of %member/bot%".

Helpful?

propertyText since 5.0.0-a1

[the] avatar url of %member%

%member%'s avatar url

The avatar/icon URL of a Discord entity: a user/member's avatar, a guild's icon, a sticker's image, an application's icon... Co-owned across every type that has one, so "avatar url of %x%" works on any of them. Always a string (the image URL).

Helpful?

propertyGuild since 5.0.0-a1

[the] guild of %member%

%member%'s guild

The guild a Discord entity belongs to: a member's, message's, role's, channel's, webhook's, sticker's, emoji's or scheduled event's guild. Co-owned across every such type, so "guild of %x%" works on any of them (null when the entity is not tied to a guild, e.g. a message from DMs).

Helpful?

Getters

getterMember since 5.0.0-a1

Feeling lost? This is covered in the guide Getting entities by id

member with id %string% (in|from) [the] [guild] %guild%

The member with the given id; cache, or online with await.

mentioned inCache and await

Helpful?

Effects

effect since 5.0.0-a1

[discord] ban [the] [member] %member% [and (delete|remove) %-timespan% [worth ]of message[s]] [(due to|because of|with [the] reason) %-string%]

Bans a member from their guild, optionally deleting their recent messages.

The bot needs the Ban Members permission and a role above the target's.

Helpful?

effect since 5.0.0-a1

[voice] deafen [the] [member] %member% [(due to|because of|with [the] reason) %-string%]

Server-deafens a member. The member must be connected to a voice channel.

Helpful?

effect since 5.0.0-a1

[voice] disconnect [the] [member] %member%

Disconnects a member from the voice channel they are in.

Helpful?

effect since 5.0.0-a1

[discord] kick [the] [member] %member% [(due to|because of|with [the] reason) %-string%]

Kicks a member from their guild.

mentioned inErrors

Helpful?

effect since 5.0.0-a1

[voice] move [the] [member] %member% to [the] [voice] [channel] %audiochannel%

Moves a member to another voice channel. The member must already be connected.

Helpful?

effect since 5.0.0-a1

[voice] mute [the] [member] %member% [(due to|because of|with [the] reason) %-string%]

Server-mutes a member. The member must be connected to a voice channel.

Helpful?

effect since 5.0.0-a1

Lifts a member's time out.

Helpful?

effect since 5.0.0-a1

time[( |-)]out [the] [member] %member% for %timespan% [(due to|because of|with [the] reason) %-string%]

Times a member out for a duration (Discord caps it at 28 days).

A timed-out member cannot talk, react, or join voice channels.

Helpful?

effect since 5.0.0-a1

time[( |-)]out [the] [member] %member% until %date% [(due to|because of|with [the] reason) %-string%]

Times a member out until a given date (Discord caps it at 28 days out).

Helpful?

effect since 5.0.0-a1

[voice] un[ |-]deafen [the] [member] %member% [(due to|because of|with [the] reason) %-string%]

Lifts a member's server deafen.

Helpful?

effect since 5.0.0-a1

[voice] un[ |-]mute [the] [member] %member% [(due to|because of|with [the] reason) %-string%]

Lifts a member's server mute.

Helpful?

Conditions

conditionsince 5.0.0-a1

%members% (is|are) muted

Whether the member is muted (self or by the guild) in a voice channel.

Helpful?

conditionsince 5.0.0-a1

%members% (is|are) deafened

Whether the member is deafened (self or by the guild) in a voice channel.

Helpful?

conditionsince 5.0.0-a1

%members% (is|are) timed out

Whether the member is currently timed out in the guild.

Helpful?

conditionsince 5.0.0-a1

%members% (is|are) [a] discord bot

Whether the member's account is a Discord bot.

Helpful?

conditionsince 5.0.0-a1

%members% (has|have) discord [role] %role%

Whether the member has the given role.

Helpful?

conditionsince 5.0.0-a1

%member% can interact with %members/roles%

Whether the member can interact with (act upon) any of the given members or roles.

Helpful?

conditionsince 5.0.0-a1

%members% (has|have) [the] discord permission[s] %permissions% [in [the] [channel] %-guildchannel%]

Whether the member has all the given permissions, either guild-wide or in a specific channel (channel overrides included). An administrator has every permission.

Helpful?

conditionsince 5.0.0-a1

%members% (is|are) in [the] thread %threadchannel%

Whether the member has joined the given thread. Useful to avoid errors when adding a member to a thread they are already in.

Helpful?

Returned by

Syntaxes elsewhere in DiSky that return Member.

[the] members of %audiochannel%Audio Channel [the] creator of %automodrule%AutoMod Rule [the] member of %user% in [the] [guild] %guild%Core · Expressions [the] boosters of %guild%Guild [the] discord owner of %guild%Guild [the] members of %guild%Guild member with id %string% (in|from) [the] [guild] %guild%Member [the] member author of %message%Message [the] mentioned members of %message%Message [the] interested members of %scheduledevent%Scheduled Event [the] discord owner of %threadchannel%Thread Channel [the] thread members of %threadchannel%Thread Channel [the] webhook owner of %webhook%Webhook

Documentation

Hand-written guides that cover Member.

Cache and awaitWhat the cache holds, the three rules that decide when a line needs await, and the reads that always do.Docs Getting entities by idLook a guild, role, user, member, channel or message up from its Discord id, from the cache or from Discord.Docs ErrorsWhat happens when Discord refuses an action, and how try/catch and the last discord error let a script react to it.Docs LinkingReferencing syntaxes, entities, events and other doc pages.Docs