Class CommandGroup

Hierarchy

BaseCommand
- CommandGroup

Index

Constructors

constructor

Properties

Constructors

constructor

new CommandGroup(cmd: string, commander: Commander): CommandGroup

Overrides BaseCommand.constructor
- Defined in src/command/CommandGroup.ts:9
Parameters
- cmd: string
- commander: Commander
Returns CommandGroup

Properties

Protected commander

commander: Commander

Private commands

commands: Array<Command> = []

Protected permissionHandler

permissionHandler: permissionHandler[] = []

Protected runHandler

runHandler: runHandler[] = []

Methods

addCommand

addCommand(name: string): Command

- Defined in src/command/CommandGroup.ts:37
Adds a new sub Commmand to the group

Parameters
- name: string
  
  the sub command name which should be added
Returns Command

addThrottle

addThrottle(throttle: Throttle): this

Inherited from BaseCommand.addThrottle
- Defined in src/command/BaseCommand.ts:137
adds an instance of a throttle class

Parameters
- throttle: Throttle
  
  adds the throttle instance
Returns this

checkPermission

checkPermission(callback: permissionHandler): this

Inherited from BaseCommand.checkPermission
- Defined in src/command/BaseCommand.ts:156
register a permission handler for this command

Parameters
- callback: permissionHandler
  
  gets called whenever the permission for a client gets checked
Returns this

clearManual

clearManual(): this

Inherited from BaseCommand.clearManual
- Defined in src/command/BaseCommand.ts:119
clears the current manual text

Returns this

disable

disable(): this

Inherited from BaseCommand.disable
- Defined in src/command/BaseCommand.ts:43
Returns this

Protected dispatchCommand

dispatchCommand(ev: CommanderTextMessage): Promise<void>

Inherited from BaseCommand.dispatchCommand
- Defined in src/command/BaseCommand.ts:165
Parameters
- ev: CommanderTextMessage
Returns Promise<void>

enable

enable(): this

Inherited from BaseCommand.enable
- Defined in src/command/BaseCommand.ts:37
Returns this

findSubCommandByName

findSubCommandByName(name: string): Command

- Defined in src/command/CommandGroup.ts:48
Retrieves a subcommand by its command name

Parameters
- name: string
  
  the name which should be searched for
Returns Command

getAvailableSubCommands

getAvailableSubCommands(client?: TeamSpeakClient, cmd?: undefined | string): Promise<BaseCommand[]>

- Defined in src/command/CommandGroup.ts:65
retrievel all available subcommands

Parameters
- Optional client: TeamSpeakClient
  
  the sinusbot client for which the commands should be retrieved if none has been omitted it will retrieve all available commands
- Optional cmd: undefined | string
  
  the command which should be searched for
Returns Promise<BaseCommand[]>

getCommandName

getCommandName(): string | function

Inherited from BaseCommand.getCommandName
- Defined in src/command/BaseCommand.ts:49
gets the command name without its prefix

Returns string | function

getFullCommandName

getFullCommandName(): string

Inherited from BaseCommand.getFullCommandName
- Defined in src/command/BaseCommand.ts:54
gets the command name with its prefix

Returns string

getHelp

getHelp(client: TeamSpeakClient): string

Inherited from BaseCommand.getHelp
- Defined in src/command/BaseCommand.ts:59
retrieves the help text

Parameters
- client: TeamSpeakClient
Returns string

getManual

getManual(client: TeamSpeakClient): string

Inherited from BaseCommand.getManual
- Defined in src/command/BaseCommand.ts:78
retrieves the current manual text

Parameters
- client: TeamSpeakClient
Returns string

getPrefix

getPrefix(): string

Inherited from BaseCommand.getPrefix
- Defined in src/command/BaseCommand.ts:101
gets the current prefix for this command

Returns string

getUsage

getUsage(): string

Overrides BaseCommand.getUsage
- Defined in src/command/CommandGroup.ts:19
Retrieves the usage of the command with its parameterized names

Returns string

retrieves the complete usage of the command with its argument names

handleRequest

handleRequest(args: string, ev: CommanderTextMessage): Promise<void>

Overrides BaseCommand.handleRequest
- Defined in src/command/CommandGroup.ts:73
Parameters
- args: string
- ev: CommanderTextMessage
Returns Promise<void>

hasHelp

hasHelp(): boolean

Inherited from BaseCommand.hasHelp
- Defined in src/command/BaseCommand.ts:73
returns a boolean wether a help text has been set or not

Returns boolean

hasManual

hasManual(): boolean

Inherited from BaseCommand.hasManual
- Defined in src/command/BaseCommand.ts:85
returns a boolean wether a help text has been set or not

Returns boolean

hasPermission

hasPermission(client: TeamSpeakClient): Promise<boolean>

Overrides BaseCommand.hasPermission
- Defined in src/command/CommandGroup.ts:27
checks if a client should have permission to use this command

Parameters
- client: TeamSpeakClient
  
  the client which should be checked
Returns Promise<boolean>

help

help(text: TranslationString): this

Inherited from BaseCommand.help
- Defined in src/command/BaseCommand.ts:67
sets a help text (should be a very brief description)

Parameters
- text: TranslationString
  
  help text
Returns this

isEnabled

isEnabled(): boolean

Inherited from BaseCommand.isEnabled
- Defined in src/command/BaseCommand.ts:32
checks if the command is enabled

Returns boolean

manual

manual(text: TranslationString): this

Inherited from BaseCommand.manual
- Defined in src/command/BaseCommand.ts:111
sets a manual text, this function can be called multiple times in order to create a multilined manual text

Parameters
- text: TranslationString
  
  the manual text
Returns this

Protected permCheck

permCheck(client: TeamSpeakClient): Promise<boolean>

Inherited from BaseCommand.permCheck
- Defined in src/command/BaseCommand.ts:161
Parameters
- client: TeamSpeakClient
Returns Promise<boolean>

prefix

prefix(prefix: string): this

Inherited from BaseCommand.prefix
- Defined in src/command/BaseCommand.ts:95
sets a prefix for this command should only used in specific cases by default the prefix gets inherited from its Commander

Parameters
- prefix: string
  
  the new prefix for this command
Returns this

run

run(callback: runHandler): this

Inherited from BaseCommand.run
- Defined in src/command/BaseCommand.ts:128
register an execution handler for this command

Parameters
- callback: runHandler
  
  gets called whenever the command should do something
Returns this

validate

validate(): object

Overrides BaseCommand.validate
- Defined in src/command/CommandGroup.ts:56
Command Groups generally dont have arguments

Returns object

Generated using TypeDoc