Class MessageCenter

Hierarchy (View Summary)

ManagementCenter<MessageModule, MessageModuleClass, MessageEvents>
- MessageCenter

Index

Constructors

Properties

allCommands? client eventHandler guild_ids? helpEmbed? helpText modules validated

Methods

addModules generateHelpCommand generateHelpCommandAsEmbed getAllCommands hasHandler on runAllHandler unionAllGuildIds useHelpCommand validateCommands

Constructors

constructor

new MessageCenter(
    client: Client,
    criteria: MessageCriteria,
    guild_ids?: string[],
): MessageCenter
Parameters
- client: Client
  You know what this is
- criteria: MessageCriteria
  this may look complex but it basically means either
- Optionalguild_ids: string[]
  Specify guild_ids to enable guild-specific commands
  
  { mention: true }
  
  or
  
  { prefixes: ["!", ...] }
  
  The prefixes can be anything as long as it is not empty string array
Returns MessageCenter
Overrides ManagementCenter.constructor
- Defined in packages/cocoa-discord/src/message/MessageCenter.ts:38

Properties

`Protected` `Optional`allCommands

allCommands?: BaseCommand[]

`Protected` `Readonly`client

client: Client

`Protected`eventHandler

eventHandler: {
error: ((name: string, error: unknown, msg: Message) => Awaitable<void>)[];
message: ((name: string, msg: Message) => Awaitable<void>)[];
}

`Protected` `Optional`guild_ids

guild_ids?: string[] | "Global"

`Optional`helpEmbed

helpEmbed?: EmbedBuilder

helpText

helpText: string = ""

`Protected`modules

modules: MessageModule[] = []

`Protected`validated

validated: boolean = false

Methods

addModules

addModules(...modules: NonEmptyArray<MessageModule | MessageModuleClass>): void
Parameters
- ...modules: NonEmptyArray<MessageModule | MessageModuleClass>
Returns void
Inherited from ManagementCenter.addModules
- Defined in packages/cocoa-discord/src/base/Center.ts:41

`Protected`generateHelpCommand

generateHelpCommand(): string
Returns string
Inherited from ManagementCenter.generateHelpCommand
- Defined in packages/cocoa-discord/src/base/Center.ts:119

`Protected`generateHelpCommandAsEmbed

generateHelpCommandAsEmbed(): EmbedBuilder
Returns EmbedBuilder
Inherited from ManagementCenter.generateHelpCommandAsEmbed
- Defined in packages/cocoa-discord/src/base/Center.ts:138

`Protected`getAllCommands

getAllCommands(): BaseCommand[]
Returns BaseCommand[]
Inherited from ManagementCenter.getAllCommands
- Defined in packages/cocoa-discord/src/base/Center.ts:171

`Protected`hasHandler

hasHandler(event: keyof MessageEvents): boolean
Parameters
- event: keyof MessageEvents
Returns boolean
Inherited from ManagementCenter.hasHandler
- Defined in packages/cocoa-discord/src/base/Center.ts:50

on

on<T extends keyof MessageEvents>(event: T, callback: MessageEvents[T]): void
Type Parameters
- T extends keyof MessageEvents
Parameters
- event: T
- callback: MessageEvents[T]
Returns void
Inherited from ManagementCenter.on
- Defined in packages/cocoa-discord/src/base/Center.ts:46

`Protected`runAllHandler

runAllHandler<T extends keyof MessageEvents>(
event: T,
...args: Parameters<MessageEvents[T]>,
): Promise<void>
Type Parameters
- T extends keyof MessageEvents
Parameters
- event: T
- ...args: Parameters<MessageEvents[T]>
Returns Promise<void>
Inherited from ManagementCenter.runAllHandler
- Defined in packages/cocoa-discord/src/base/Center.ts:54

`Protected`unionAllGuildIds

unionAllGuildIds<HasGlobal extends boolean = false>(): HasGlobal extends true
    ? string[]
    | "Global"
    : string[]
Type Parameters
- HasGlobal extends boolean = false
Returns HasGlobal extends true ? string[] | "Global" : string[]
Inherited from ManagementCenter.unionAllGuildIds
- Defined in packages/cocoa-discord/src/base/Center.ts:150

useHelpCommand

useHelpCommand(style?: EmbedStyle): void
Generate Cog that contains Help Command

Should be called after all cogs are added and before commands validation.

Make sure to NOT name any cog Help or any command help
Parameters
- Optionalstyle: EmbedStyle
Returns void
Overrides ManagementCenter.useHelpCommand
- Defined in packages/cocoa-discord/src/message/MessageCenter.ts:156

validateCommands

validateCommands(): Promise<void>
No multiple Cogs or commands should have same name, and Cog.commands key and value must be the same command name

This function will ensure that and should be called after all cogs are added

Note: It is recommended to use checkLogin() instead for simplicity

Returns Promise<void>
Inherited from ManagementCenter.validateCommands
- Defined in packages/cocoa-discord/src/base/Center.ts:93

Class MessageCenter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MessageCenter

Properties

Protected OptionalallCommands

Protected Readonlyclient

ProtectedeventHandler

Protected Optionalguild_ids

OptionalhelpEmbed

helpText

Protectedmodules

Protectedvalidated

Methods

addModules

Parameters

Returns void

ProtectedgenerateHelpCommand

Returns string

ProtectedgenerateHelpCommandAsEmbed

Returns EmbedBuilder

ProtectedgetAllCommands

Returns BaseCommand[]

ProtectedhasHandler

Parameters

Returns boolean

on

Type Parameters

Parameters

Returns void

ProtectedrunAllHandler

Type Parameters

Parameters

Returns Promise<void>

ProtectedunionAllGuildIds

Type Parameters

Returns HasGlobal extends true ? string[] | "Global" : string[]

useHelpCommand

Parameters

Returns void

validateCommands

Returns Promise<void>

Settings

On This Page

`Protected` `Optional`allCommands

`Protected` `Readonly`client

`Protected`eventHandler

`Protected` `Optional`guild_ids

`Optional`helpEmbed

`Protected`modules

`Protected`validated

`Protected`generateHelpCommand

`Protected`generateHelpCommandAsEmbed

`Protected`getAllCommands

`Protected`hasHandler

`Protected`runAllHandler

`Protected`unionAllGuildIds