Class GuildRole

constructor

• new GuildRole(client: UsingClient, data: APIRole, guildId: string): GuildRole

  Parameters

  • client: UsingClient
  • data: APIRole
  • guildId: string

  Returns GuildRole

ReadonlyguildId

permissions

delete

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

  Parameters

  • Optionalreason: string

  Returns Promise<void>

edit

• edit(body: RESTPatchAPIGuildRoleJSONBody): Promise<GuildRole>

  Parameters

  • body: RESTPatchAPIGuildRoleJSONBody

  Returns Promise<GuildRole>

fetch

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

  Parameters

  • force: boolean = false

  Returns Promise<GuildRole>

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

toString

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

  Returns a string representation of an object.

  Returns `<@&${string}>`

Staticmethods

• methods(
      ctx: { client: UsingClient; guildId: string },
  ): {
      create: (body: RESTPostAPIGuildRoleJSONBody) => Promise<GuildRole>;
      delete: (roleId: string, reason?: string) => Promise<void>;
      edit: (
          roleId: string,
          body: RESTPatchAPIGuildRoleJSONBody,
          reason?: string,
      ) => Promise<GuildRole>;
      editPositions: (
          body: RESTPatchAPIGuildRolePositionsJSONBody,
      ) => Promise<GuildRole[]>;
      list: (force?: boolean) => Promise<GuildRole[]>;
  }

  Parameters

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

  Returns {
      create: (body: RESTPostAPIGuildRoleJSONBody) => Promise<GuildRole>;
      delete: (roleId: string, reason?: string) => Promise<void>;
      edit: (
          roleId: string,
          body: RESTPatchAPIGuildRoleJSONBody,
          reason?: string,
      ) => Promise<GuildRole>;
      editPositions: (
          body: RESTPatchAPIGuildRolePositionsJSONBody,
      ) => Promise<GuildRole[]>;
      list: (force?: boolean) => Promise<GuildRole[]>;
  }