The date and time (in ISO8601 format) at which the member will be unmuted (or put in "timeout").
If the member is not muted, this will be null.
The guild id of the guild this member instance belongs to.
The date and time the member joined in ISO8601 format (YYYY-MM-DDTHH:mm:ss).
The member's nickname, if set.
The member's pending status. If true, the member has not accepted the guild's rules or passed member verification.
Calculated permissions for the member based on the currently assigned roles.
Note: See GuildChannel.getMemberPermissions if you need channel-specific permissions.
The date and time the member started boosting (otherwise, null) in ISO 8601 format (YYYY-MM-DDTHH:mm:ss).
An array of role ids this user has assigned to them.
A reference to the underling discord.User object.
Attempts to add a role (by id) to the member.
Requires the discord.Permissions.MANAGE_ROLES permission.
If an error occurs, a discord.ApiError is thrown.
Attempts to ban the member from the guild.
If an error occurs, a discord.ApiError is thrown.
Returns true if the member can perform actions that require the specified permission. Otherwise, false is returned.
The permission to check for.
Updates the guild member.
All properties of the options parameter are optional, but you must send at least one modification.
If an error occurs, a discord.ApiError is thrown.
Properties to modify on this member.
Fetches an instance of the guild this member belongs to.
Returns the latest discord.Presence data for this member.
The presence object contains their online/offline status, custom status, and other real-time activity data.
Fetches an instance of the user for this guild member.
Attempts to kick the member from the guild.
If an error occurs, a discord.ApiError is thrown.
Attempts to remove a role (by id) to the member.
Requires the discord.Permissions.MANAGE_ROLES permission.
If an error occurs, a discord.ApiError is thrown.
Returns a mention string in the format of <@!id> where id is the id of this user.
Generated using TypeDoc
Pylon SDK Reference
A GuildMember is a wrapper around a discord.User containing information on their guild membership.
Stores the member's nickname, list of roles, the time they joined, the time they started boosting the server, and a guild id.
The class also contains a handful of utility methods, such as permission helpers, kick/ban functions, and role utilities. See the Functions below for more info.
You can access the underlying user object via discord.GuildMember.user.