Class GuildMember

constructor

• new GuildMember(
      client: UsingClient,
      data: GuildMemberData,
      user: APIUser,
      guildId: string,
  ): GuildMember

  Parameters

  • client: UsingClient
  • data: GuildMemberData
  • user: APIUser
  • guildId: string

    the choosen guild id

  Returns GuildMember

Readonlyclient

OptionalcommunicationDisabledUntilTimestamp

ReadonlyguildId

id

OptionaljoinedTimestamp

user

bot

• get bot(): undefined | boolean

  Returns undefined | boolean

createdAt

• get createdAt(): Date

  createdAt gets the creation Date instace of the current object.

  Returns Date

createdTimestamp

• get createdTimestamp(): number

  Create a timestamp for the current object.

  Returns number

displayName

• get displayName(): string

  gets the nickname or the username

  Returns string

globalName

• get globalName(): null | string

  Returns null | string

hasTimeout

• get hasTimeout(): number | false

  Returns number | false

name

• get name(): string

  Returns string

roles

• get roles(): {
      add: (id: string) => Promise<undefined>;
      highest: (force?: boolean) => Promise<GuildRole>;
      keys: string[];
      list: (force?: boolean) => Promise<GuildRole[]>;
      permissions: (force?: boolean) => Promise<PermissionsBitField>;
      remove: (id: string) => Promise<undefined>;
      sorted: (force?: boolean) => Promise<GuildRole[]>;
  }

  Returns {
      add: (id: string) => Promise<undefined>;
      highest: (force?: boolean) => Promise<GuildRole>;
      keys: string[];
      list: (force?: boolean) => Promise<GuildRole[]>;
      permissions: (force?: boolean) => Promise<PermissionsBitField>;
      remove: (id: string) => Promise<undefined>;
      sorted: (force?: boolean) => Promise<GuildRole[]>;
  }

tag

• get tag(): string

  Returns string

username

• get username(): string

  Returns string

avatarURL

• avatarURL(options: CDNUrlOptions & { exclude: true }): null | string

  Parameters

  • options: CDNUrlOptions & { exclude: true }

  Returns null | string

• avatarURL(options?: CDNUrlOptions & { exclude?: false }): string

  Parameters

  • Optionaloptions: CDNUrlOptions & { exclude?: false }

  Returns string

ban

• ban(body?: RESTPutAPIGuildBanJSONBody, reason?: string): Promise<void>

  Parameters

  • Optionalbody: RESTPutAPIGuildBanJSONBody
  • Optionalreason: string

  Returns Promise<void>

bannable

• bannable(force?: boolean): Promise<boolean>

  Parameters

  • force: boolean = false

  Returns Promise<boolean>

bannerURL

• bannerURL(options: CDNUrlOptions & { exclude: true }): undefined | null | string

  Parameters

  • options: CDNUrlOptions & { exclude: true }

  Returns undefined | null | string

• bannerURL(options?: CDNUrlOptions & { exclude?: false }): undefined | string

  Parameters

  • Optionaloptions: CDNUrlOptions & { exclude?: false }

  Returns undefined | string

defaultAvatarURL

• defaultAvatarURL(): string

  Returns string

dm

• dm(force?: boolean): Promise<DMChannel>

  Parameters

  • force: boolean = false

  Returns Promise<DMChannel>

edit

• edit(
      body: RESTPatchAPIGuildMemberJSONBody,
      reason?: string,
  ): Promise<GuildMember>

  Parameters

  • body: RESTPatchAPIGuildMemberJSONBody
  • Optionalreason: string

  Returns Promise<GuildMember>

fetch

• fetch(force?: boolean): Promise<GuildMember>

  Parameters

  • force: boolean = false

  Returns Promise<GuildMember>

fetchPermissions

• fetchPermissions(force?: boolean): Promise<PermissionsBitField>

  Parameters

  • force: boolean = false

  Returns Promise<PermissionsBitField>

guild

• guild(mode?: "rest" | "flow"): Promise<Guild<"cached" | "api">>

  Parameters

  • Optionalmode: "rest" | "flow"

  Returns Promise<Guild<"cached" | "api">>

• guild(mode: "cache"): ReturnCache<undefined | Guild<"cached">>

  Parameters

  • mode: "cache"

  Returns ReturnCache<undefined | Guild<"cached">>

kick

• kick(reason?: string): Promise<void>

  Parameters

  • Optionalreason: string

  Returns Promise<void>

kickable

• kickable(force?: boolean): Promise<boolean>

  Parameters

  • force: boolean = false

  Returns Promise<boolean>

manageable

• manageable(force?: boolean): Promise<boolean>

  Parameters

  • force: boolean = false

  Returns Promise<boolean>

moderatable

• moderatable(force?: boolean): Promise<boolean>

  Parameters

  • force: boolean = false

  Returns Promise<boolean>

presence

• presence(): ReturnCache<
      | undefined
      | Omit<GatewayPresenceUpdate, "user"> & { id: string; user_id: string } & {
          guild_id: string;
      },
  >

  Returns ReturnCache<
      | undefined
      | Omit<GatewayPresenceUpdate, "user"> & { id: string; user_id: string } & {
          guild_id: string;
      },
  >

timeout

• timeout(time: null | number, reason?: string): Promise<GuildMember>

  Parameters

  • time: null | number
  • Optionalreason: string

  Returns Promise<GuildMember>

toString

• toString(): `<@${string}>`

  Returns a string representation of an object.

  Returns `<@${string}>`

voice

• voice(mode?: "rest" | "flow"): Promise<VoiceState>

  Parameters

  • Optionalmode: "rest" | "flow"

  Returns Promise<VoiceState>

• voice(mode: "cache"): ReturnCache<undefined | VoiceState>

  Parameters

  • mode: "cache"

  Returns ReturnCache<undefined | VoiceState>

write

• write(
      body: Omit<
          RESTPostAPIChannelMessageJSONBody,
          "components"
          | "content"
          | "embeds"
          | "poll",
      > & SendResolverProps,
  ): Promise<Message>

  Parameters

  • body: Omit<
        RESTPostAPIChannelMessageJSONBody,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps

  Returns Promise<Message>

Staticmethods

• methods(
      __namedParameters: { client: UsingClient; guildId: string },
  ): {
      add: (
          id: string,
          body: RESTPutAPIGuildMemberJSONBody,
      ) => Promise<undefined | GuildMember>;
      addRole: (memberId: string, id: string) => Promise<undefined>;
      ban: (
          id: string,
          body?: RESTPutAPIGuildBanJSONBody,
          reason?: string,
      ) => Promise<void>;
      edit: (
          id: string,
          body: RESTPatchAPIGuildMemberJSONBody,
          reason?: string,
      ) => Promise<GuildMember>;
      fetch: (memberId: string, force?: boolean) => Promise<GuildMember>;
      kick: (id: string, reason?: string) => Promise<void>;
      list: (
          query?: RESTGetAPIGuildMembersQuery,
          force?: boolean,
      ) => Promise<GuildMember[]>;
      removeRole: (memberId: string, id: string) => Promise<undefined>;
      resolve: (
          resolve: GuildMemberResolvable,
      ) => Promise<undefined | GuildMember>;
      search: (
          query?: RESTGetAPIGuildMembersSearchQuery,
      ) => Promise<GuildMember[]>;
      unban: (id: string, reason?: string) => Promise<undefined>;
  }

  Parameters

  • __namedParameters: { client: UsingClient; guildId: string }

  Returns {
      add: (
          id: string,
          body: RESTPutAPIGuildMemberJSONBody,
      ) => Promise<undefined | GuildMember>;
      addRole: (memberId: string, id: string) => Promise<undefined>;
      ban: (
          id: string,
          body?: RESTPutAPIGuildBanJSONBody,
          reason?: string,
      ) => Promise<void>;
      edit: (
          id: string,
          body: RESTPatchAPIGuildMemberJSONBody,
          reason?: string,
      ) => Promise<GuildMember>;
      fetch: (memberId: string, force?: boolean) => Promise<GuildMember>;
      kick: (id: string, reason?: string) => Promise<void>;
      list: (
          query?: RESTGetAPIGuildMembersQuery,
          force?: boolean,
      ) => Promise<GuildMember[]>;
      removeRole: (memberId: string, id: string) => Promise<undefined>;
      resolve: (
          resolve: GuildMemberResolvable,
      ) => Promise<undefined | GuildMember>;
      search: (
          query?: RESTGetAPIGuildMembersSearchQuery,
      ) => Promise<GuildMember[]>;
      unban: (id: string, reason?: string) => Promise<undefined>;
  }