Class Member

Represents a guild user.

Hierarchy

Constructors

constructor

Properties

_createdAt _joinedAt avatarURL bannerURL bot client guildID id isOwner nickname roles type username

Accessors

createdAt guild joinedAt user

Methods

addRole addToGroup award getSocialLink removeFromGroup removeRole setXP

Constructors

constructor

Properties

_createdAt

_createdAt: number

Timestamp (unix epoch time) of the user's account creation.

_joinedAt

_joinedAt: null | number

Timestamp (unix epoch time) of when the member joined the server.

avatarURL

avatarURL: null | string

Current avatar url of the user.

bannerURL

bannerURL: null | string

Current banned url of the user.

bot

bot: boolean

If set to true, the user is a bot.

client

client: Client

Bot's client.

guildID

guildID: string

Server ID.

id

id: string | number

Item ID

isOwner

isOwner: boolean

Tells you if the member is the server owner.

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

createdAt

  • get createdAt(): Date

  • Date of the user's account creation.

    Returns Date

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>

joinedAt

  • get joinedAt(): null | number | Date

  • String representation of the _joinedAt timestamp.

    Returns null | number | Date

user

Methods

addRole

  • Add a role to this member.

    Parameters

    • roleID: number

      ID of the role to be added.

    Returns Promise<void>

addToGroup

  • Add this member to a guild group.

    Parameters

    • groupID: string

      ID of the guild group.

    Returns Promise<void>

award

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

    Parameters

    • amount: number

      Amount of experience to give.

    Returns Promise<number>

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<void | socialLinkTypes>

removeFromGroup

  • 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>

Settings

Member Visibility

Theme