gluon
    Preparing search index...

    Class Member

    Represents a guild member.

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

    Implements

    • Member
    Index

    Constructors

    constructor

    Accessors

    _originalAvatarHash avatarIsAnimated displayAvatarURL displayAvatarURLNoFallback flags guild guildId hashName highestRolePosition id joinedAt mention nick pending permissions rejoined roles timeoutUntil user

    Methods

    [custom] addRole encrypt massUpdateRoles removeRole timeoutAdd timeoutRemove toJSON toString addRole decrypt getAvatarUrl getHashName getMention removeRole shouldCache

    Constructors

    • Creates the structure for a guild member.

      Parameters

      • client: Client

        The client instance.

      • data:
            | MemberStorageJSON
            | MemberCacheJSON
            | APIGuildMember
            | APIInteractionDataResolvedGuildMember
            | MemberDiscordJSON
            | GatewayGuildMemberUpdateDispatchData

        The raw member data from Discord.

      • options: { guildId: string; nocache?: boolean; user?: User; userId: string }

        Additional options for the member.

        • guildId: string

          The id of the guild that the member belongs to.

        • Optionalnocache?: boolean

          Whether this member should be cached.

        • Optionaluser?: User

          A user object for this member.

        • userId: string

          The id of the member.

      Returns Member

    Accessors

    _originalAvatarHash

    • get _originalAvatarHash(): null | string

      The hash of the member's avatar, as it was received from Discord.

      Returns null | string

    • get avatarIsAnimated(): boolean

      Whether the user has an animated avatar or not.

      Returns boolean

    • get displayAvatarURL(): any

      The url of the member's avatar.

      Returns any

    • get displayAvatarURLNoFallback(): null | string

      The url of the member's avatar without falling back to the user's avatar.

      Returns null | string

    • get guild(): Guild

      The guild that this member belongs to.

      Returns Guild

    • get guildId(): string

      The id of the guild that this member belongs to.

      Returns string

    • get hashName(): string

      The hash name for the member.

      Returns string

    • get highestRolePosition(): number

      The position of the member's highest role.

      Returns number

    • get joinedAt(): undefined | number

      The UNIX timestamp for when this member joined the guild.

      Returns undefined | number

    • get mention(): string

      The mention string for the member.

      Returns string

    • get nick(): null | string

      The nickname of the member.

      Returns null | string

    • get pending(): boolean

      Whether the user has not yet passed the guild's membership screening requirements.

      Returns boolean

    • get permissions(): null | string

      The overall calculated permissions for this member.

      Returns null | string

    • get rejoined(): boolean

      Whether the member has joined the guild before.

      Returns boolean

    • get roles(): null | Role[]

      The member's roles.

      Returns null | Role[]

    • get timeoutUntil(): null | number

      The UNIX timestamp for when this member's timeout expires, if applicable.

      Returns null | number

    • get user(): User | User

      Gets the user associated with this member.

      Returns User | User

      The user associated with this member.

      If the user cannot be found.

    Methods

    • Adds a role to the member.

      Parameters

      • role_id: string

        The id of the role to add to the member.

      • Optionaloptions: { reason?: string } = {}

        The options for adding the role to the member.

        • Optionalreason?: string

          The reason for adding the role to the member.

      Returns Promise<void>

    • Updates the member's roles.

      Parameters

      • roles: string[]

        An array of role ids for the roles the member should be updated with.

      • Optionaloptions: { reason?: string } = {}

        The options for updating the member's roles.

        • Optionalreason?: string

          The reason for updating the member's roles.

      Returns Promise<void>

    • Removes a role from the member.

      Parameters

      • role_id: string

        The id of the role to remove from the member.

      • Optionaloptions: { reason?: string } = {}

        The options for removing the role from the member.

        • Optionalreason?: string

          The reason for removing the role from the member.

      Returns Promise<void>

    • Adds a timeout to the member.

      Parameters

      • timeout_until: number

        The UNIX timestamp for when the member's timeout should end.

      • Optionaloptions: { reason?: string } = {}

        The options for timing out the member.

        • Optionalreason?: string

          The reason for timing out the member.

      Returns Promise<void>

    • Removes a timeout from the member.

      Parameters

      • Optionaloptions: { reason?: string } = {}

        The options for untiming out the member.

        • Optionalreason?: string

          The reason for removing the time out from the member.

      Returns Promise<void>

    • Returns the JSON representation of this structure.

      Parameters

      • Optionalformat: JsonTypes

        The format to return the data in.

      Returns
          | {
              _attributes: number;
              avatar: null
              | string;
              communication_disabled_until: undefined | number;
              flags: number;
              joined_at: undefined | number;
              nick: null | string;
              pending?: undefined;
              permissions: string;
              roles: undefined | string[];
              user: undefined | UserCacheJSON | UserStorageJSON;
          }
          | {
              _attributes?: undefined;
              avatar: null
              | string;
              communication_disabled_until: undefined | number;
              flags: number;
              joined_at: undefined | string;
              nick: null | string;
              pending: boolean;
              permissions: string;
              roles: undefined | string[];
              user: undefined | UserDiscordJSON;
          }

    • Adds a role to a member.

      Parameters

      • client: Client

        The client instance.

      • guildId: string

        The guild id the member belongs to.

      • userId: string

        The id of the member who the action is occuring on.

      • roleId: string

        The id of the role to add.

      • Optionaloptions: { reason?: string } = {}

        The options for adding the role.

        • Optionalreason?: string

          The reason for adding the role.

      Returns Promise<void>

    • Decrypts a member.

      Parameters

      • client: Client

        The client instance.

      • data: string

        The encrypted message data.

      • guildId: string

        The id of the guild that the message belongs to.

      • userId: string

        The id of the member.

      Returns Member

    • Returns the avatar url for the member.

      Parameters

      • id: string

        The id of the user.

      • guildId: string
      • Optionalhash: null | string

        The avatar hash of the user.

      Returns null | string

    • Returns the hash name for the message.

      Parameters

      • guildId: string

        The id of the guild that the message belongs to.

      • memberId: string

        The id of the member.

      Returns string

    • Returns the mention string for the member.

      Parameters

      • userId: string

        The id of the user to mention.

      Returns string

    • Removes a role from a member.

      Parameters

      • client: Client

        The client instance.

      • guildId: string

        The guild id the member belongs to.

      • userId: string

        The id of the member who the action is occuring on.

      • roleId: string

        The id of the role to remove.

      • Optionaloptions: { reason?: string } = {}

        The options for removing the role.

        • Optionalreason?: string

          The reason for removing the role.

      Returns Promise<void>

    • Determines whether the member should be cached.

      Parameters

      • gluonCacheOptions: GluonCacheOptions

        The cache options for the client.

      • guildCacheOptions: GuildCacheOptions

        The cache options for the guild.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods