Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Guild

Hierarchy

  • Guild

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Guild(data: Guild): Guild

Properties

channels

channels: Map<"id", Channel> = ...

Returns total guild channels

Protected data

data: Guild

members

members: Map<string, Member> = ...

Returns total guild members

Accessors

banner

  • get banner(): string

createdAt

  • get createdAt(): Date

desc

  • get desc(): string

icon

  • get icon(): string

id

  • get id(): string

isLarge

  • get isLarge(): boolean

isOwner

  • get isOwner(): boolean

  • Checks if the user id passed has the same id as the guild owner.

    Returns boolean

    boolean

isUnavailable

  • get isUnavailable(): boolean

name

  • get name(): string

nsfwLevel

  • get nsfwLevel(): GuildNsfwLevel

ownerId

  • get ownerId(): string

roles

  • get roles(): Map<"id", Role>

size

  • get size(): number

  • ! WARNING: This does not yet take into account sharding. Returns in total guild size

    Returns number

welcomeChannels

  • get welcomeChannels(): WelcomeScreen

Methods

leave

  • leave(): Promise<void>

  • Allows the given application to leave the current requested guild.

    Returns Promise<void>

Static get

  • get(id: string, force?: boolean): Promise<Guild>

  • Allows the API to fetch all base Guild information.

    Parameters

    • id: string

      the ID of the guild.

    • force: boolean = false

      by default we search the bot cache only, but if forced = true it will search the discord api if no guild is in the cache.

    Returns Promise<Guild>

    fuwa.js#Guild