Class SpectrumCommands

class: SpectrumCommand

Hierarchy

SpectrumCommands

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SpectrumCommands(): SpectrumCommands

- Defined in Spectrum/services/commands.service.ts:25
Returns SpectrumCommands

Properties

Private Broadcaster

Broadcaster: Broadcaster = Broadcaster.getInstance()

Our RSI WS API instance

Private RSI

RSI: RSI = RSI.getInstance()

Our RSI API instance

Protected _commandMap

_commandMap: TSMap<string, aSpectrumCommand> = new TSMap<string, aSpectrumCommand>()

Map of commands

Protected _listenerId

_listenerId: number

Main listener for commands

Protected prefix

prefix: string = "\spbot"

The prefix for the commands

Methods

addCommand

addCommand(name: any, shortCode: any, callback: any, manual: any): aSpectrumCommand

- Defined in Spectrum/services/commands.service.ts:104
Alias of registerCommand

Parameters
- name: any
- shortCode: any
- callback: any
- manual: any
Returns aSpectrumCommand

Private checkForCommand

checkForCommand(payload: object): boolean

- Defined in Spectrum/services/commands.service.ts:31
Parameters
- payload: object
  - message: receivedTextMessage
Returns boolean

getCommandList

getCommandList(): aSpectrumCommand[]

- Defined in Spectrum/services/commands.service.ts:123
Returns aSpectrumCommand[]

registerCommand

registerCommand(command: aSpectrumCommand): aSpectrumCommand
registerCommand(name: string, shortCode: any, callback: any, manual: any): aSpectrumCommand

- Defined in Spectrum/services/commands.service.ts:84
Registers a command and listen for it. Either supply aBotCommand or argument to create one.

Parameters
- command: aSpectrumCommand
  
  the aBotCommand to listen to
Returns aSpectrumCommand

the aSpectrumCommand object that we are now listening for.
- Defined in Spectrum/services/commands.service.ts:85
Parameters
- name: string
- shortCode: any
- callback: any
- manual: any
Returns aSpectrumCommand

setPrefix

setPrefix(prefix: string): void

- Defined in Spectrum/services/commands.service.ts:70
Parameters
- prefix: string
Returns void

unRegisterCommand

unRegisterCommand(command: aBotCommand): any
unRegisterCommand(commandId: number): any

- Defined in Spectrum/services/commands.service.ts:111
Unbinds a command and stop listening to it.

Parameters
- command: aBotCommand
Returns any
- Defined in Spectrum/services/commands.service.ts:112
Parameters
- commandId: number
Returns any

Generated using TypeDoc