Class BaseGuildStruct

Basic structure every guild-related structure extends Handles the creation of a guild property and guild-related methods

Hierarchy

BaseStruct
- BaseGuildStruct
  - Role
  - MemberPresence
  - Member
  - Webhook
  - GuildWidget
  - GuildBan
  - GuildIntegration

Index

Constructors

constructor

Properties

bot
guild

Methods

Constructors

constructor

new BaseGuildStruct(bot: Bot, guild: Guild, structure: GatewayStruct): BaseGuildStruct

Overrides BaseStruct.constructor
- Defined in src/structures/base/BaseGuildStruct.ts:13
Parameters
- bot: Bot
- guild: Guild
- structure: GatewayStruct
Returns BaseGuildStruct

Properties

bot

bot: Bot

The Bot operating this structure

guild

guild: Guild

The Guild associated to this structure

Methods

clone

clone(): this

Inherited from BaseStruct.clone
- Defined in src/structures/base/BaseStruct.ts:55
Clone a structure

Returns this

init

init(_struct: GatewayStruct): this

Inherited from BaseStruct.init
- Defined in src/structures/base/BaseStruct.ts:47
Virtual init method

Parameters
- _struct: GatewayStruct
  
  The structure to initialize from
Returns this

update

update(data: GatewayStruct): UpdateReturn<this>

Inherited from BaseStruct.update
- Defined in src/structures/base/BaseStruct.ts:64
Update a structure and return its before and after versions

Parameters
- data: GatewayStruct
  
  The updated data
Returns UpdateReturn<this>

Generated using TypeDoc