Class Member

Represents a guild user.

Hierarchy

Constructors

constructor

Properties

avatarURL bannerURL bot client createdAt guildID id isOwner joinedAt nickname roles type username

Accessors

guild user

Methods

addGroup addRole award ban edit getSocialLink kick removeGroup removeRole setXP toJSON unban

Constructors

constructor

Properties

avatarURL

avatarURL: null | string

Current avatar url of the user.

bannerURL

bannerURL: null | string

Current banned url of the user.

bot

bot: boolean

If true, the user is a bot.

client

client: Client

Bot's client.

createdAt

createdAt: Date

When the user account was created.

guildID

guildID: string

Server ID.

id

id: string

Item ID

isOwner

isOwner: boolean

Tells you if the member is the server owner.

joinedAt

joinedAt: null | Date

When this member joined the guild.

nickname

nickname: null | string

Member's server nickname.

roles

roles: number[]

Array of member's roles.

type

type: null | UserTypes

User type

username

username: string

User's username.

Accessors

guild

  • get guild(): Guild | Promise<Guild>

  • Guild where the user comes from, returns Guild or a promise. If guild isn't cached & the request failed, this will return you undefined.

    Returns Guild | Promise<Guild>

user

Methods

addGroup

  • Add this member to a guild group.

    Parameters

    • groupID: string

      ID of the guild group.

    Returns Promise<void>

addRole

  • Add a role to this member.

    Parameters

    • roleID: number

      ID of the role to be added.

    Returns Promise<void>

award

  • Award the member using the built-in EXP system.

    Parameters

    • amount: number

      Amount of experience to give.

    Returns Promise<number>

ban

edit

getSocialLink

  • Get a specified social link from the member, if member is connected to them through Guilded.

    Parameters

    • socialMediaName: string

      Name of a social media linked to this member.

    Returns Promise<GetSocialLink>

kick

removeGroup

  • Remove this member from a guild group.

    Parameters

    • groupID: string

      ID of the guild group.

    Returns Promise<void>

removeRole

  • Remove a role from this member.

    Parameters

    • roleID: number

      ID of the role to be added.

    Returns Promise<void>

setXP

  • Set member's experience using the built-in EXP system.

    Parameters

    • amount: number

      Amount of experience to set.

    Returns Promise<number>

toJSON

unban

Settings

Member Visibility

Theme