Class Member

constructor

• new Member(
      data: {
          isOwner: boolean;
          joinedAt: string;
          nickname?: string;
          roleIds: number[];
          user: {
              avatar?: string;
              banner?: string;
              createdAt: string;
              id: string;
              name: string;
              status?: { content?: string; emoteId: number };
              type?: UserType;
          };
      },
      client: Client,
      guildID: string,
  ): Member

  Parameters

  • data: {
        isOwner: boolean;
        joinedAt: string;
        nickname?: string;
        roleIds: number[];
        user: {
            avatar?: string;
            banner?: string;
            createdAt: string;
            id: string;
            name: string;
            status?: { content?: string; emoteId: number };
            type?: UserType;
        };
    }

    raw data.

    • isOwner: boolean

      Is owner

      Default

      false
      Copy

    • joinedAt: string

      Created at Format: date-time

      Description

      The ISO 8601 timestamp that the member was created at

    • Optionalnickname?: string

      Nickname

    • roleIds: number[]

      Role IDs

    • user: {
          avatar?: string;
          banner?: string;
          createdAt: string;
          id: string;
          name: string;
          status?: { content?: string; emoteId: number };
          type?: UserType;
      }

      • Optionalavatar?: string

        Avatar Format: media-uri

        Description

        The avatar image associated with the user

      • Optionalbanner?: string

        Banner Format: media-uri

        Description

        The banner image associated with the user

      • createdAt: string

        Created at Format: date-time

        Description

        The ISO 8601 timestamp that the user was created at

      • id: string

        User ID Format: user-id

        Description

        The ID of the user

      • name: string

        User name

        Description

        The user's name

      • Optionalstatus?: { content?: string; emoteId: number }

        • Optionalcontent?: string

          Content Format: status markdown

          Description

          The content of the user status. The supported markdown for this content only includes reactions and plaintext for now

        • emoteId: number

          Description

          Emote ID

      • Optionaltype?: UserType

        User type

        Description

        The type of user. If this property is absent, it can assumed to be of type user

  • client: Client

    client.
  • guildID: string

    ID of the guild.

  Returns Member

guildID

isOwner

joinedAt

nickname

roles

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

• get user(): User

  Member's user, shows less information.

  Returns User

addGroup

• addGroup(groupID: string): Promise<void>

  Add this member to a guild group.

  Parameters

  • groupID: string

    ID of the guild group.

  Returns Promise<void>

addRole

• addRole(roleID: number): Promise<void>

  Add a role to this member.

  Parameters

  • roleID: number

    ID of the role to be added.

  Returns Promise<void>

award

• award(amount: number): Promise<number>

  Award the member using the built-in EXP system.

  Parameters

  • amount: number

    Amount of experience to give.

  Returns Promise<number>

ban

• ban(reason?: string): Promise<BannedMember>

  Ban this member.

  Parameters

  • Optionalreason: string

    The reason of the ban.

  Returns Promise<BannedMember>

edit

• edit(options: EditMemberOptions): Promise<void>

  Edit this member.

  Parameters

  • options: EditMemberOptions

    Edit options.

  Returns Promise<void>

getPermission

• getPermission(): Promise<Permissions[]>

  Get member permission

  Returns Promise<Permissions[]>

getSocialLink

• getSocialLink(socialMediaName: string): Promise<SocialLink>

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

kick

• kick(): Promise<void>

  Kick this member.

  Returns Promise<void>

removeGroup

• removeGroup(groupID: string): Promise<void>

  Remove this member from a guild group.

  Parameters

  • groupID: string

    ID of the guild group.

  Returns Promise<void>

removeRole

• removeRole(roleID: number): Promise<void>

  Remove a role from this member.

  Parameters

  • roleID: number

    ID of the role to be added.

  Returns Promise<void>

setXP

• setXP(amount: number): Promise<number>

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

  Parameters

  • amount: number

    Amount of experience to set.

  Returns Promise<number>

toJSON

• toJSON(): JSONMember

  Returns JSONMember

unban

• unban(): Promise<void>

  Unban this member.

  Returns Promise<void>