Class GuildManager

Hierarchy (View Summary)

BaseManager<Guild>
- GuildManager

Index

Constructors

Methods

fetch fetchChannels ban unban kick

Constructors

constructor

new GuildManager(rest: ChameleonREST, store: TongueStore): GuildManager
Parameters
- rest: ChameleonREST
- store: TongueStore
Returns GuildManager
Inherited from BaseManager.constructor
- Defined in managers/base.ts:7

Methods

fetch

fetch(id: string, force?: boolean): Promise<ChameleonAPIResult<Guild>>
Parameters
- id: string
- force: boolean = false
Returns Promise<ChameleonAPIResult<Guild>>
Inherited from BaseManager.fetch
- Defined in managers/base.ts:16

fetchChannels

fetchChannels(guildId: string): Promise<ChameleonAPIResult<Channel[]>>
Parameters
- guildId: string
Returns Promise<ChameleonAPIResult<Channel[]>>
- Defined in managers/guild.ts:14

ban

ban(
    guildId: string,
    userId: string,
    options?: { deleteMessageSeconds?: number; reason?: string },
): Promise<ChameleonAPIResult<void>>
Parameters
- guildId: string
- userId: string
- Optionaloptions: { deleteMessageSeconds?: number; reason?: string }
Returns Promise<ChameleonAPIResult<void>>
- Defined in managers/guild.ts:29

unban

unban(
    guildId: string,
    userId: string,
    reason?: string,
): Promise<ChameleonAPIResult<void>>
Parameters
- guildId: string
- userId: string
- Optionalreason: string
Returns Promise<ChameleonAPIResult<void>>
- Defined in managers/guild.ts:42

kick

kick(
    guildId: string,
    userId: string,
    reason?: string,
): Promise<ChameleonAPIResult<void>>
Parameters
- guildId: string
- userId: string
- Optionalreason: string
Returns Promise<ChameleonAPIResult<void>>
- Defined in managers/guild.ts:52