Class App

Hierarchy

App

Implements

IApp

Index

Constructors

constructor

Methods

Constructors

Protected constructor

new App(info: IAppInfo, logger: ILogger): App

- Defined in App.ts:16
Create a new App, this is called whenever the server starts up and initiates the Apps. Note, your implementation of this class should call super(name, id, version) so we have it. Also, please use the initialize() method to do items instead of the constructor as the constructor might be called more than once but the initialize() will only be called once.

Parameters
- info: IAppInfo
- logger: ILogger
Returns App

Methods

Protected extendConfiguration

extendConfiguration(configuration: IConfigurationExtend, environmentRead: IEnvironmentRead): Promise<void>

- Defined in App.ts:164
Method will be called during initialization. It allows for adding custom configuration options and defaults

Parameters
- configuration: IConfigurationExtend
- environmentRead: IEnvironmentRead
Returns Promise<void>

getAuthorInfo

getAuthorInfo(): IAppAuthorInfo

Implementation of IApp.getAuthorInfo
- Defined in App.ts:96
Gets the information regarding the author/maintainer of this App.

Returns IAppAuthorInfo

author information

getDescription

getDescription(): string

Implementation of IApp.getDescription
- Defined in App.ts:77
Get the description of this App, mostly used to show to the clients/administrators.

Returns string

the description

getID

getID(): string

Implementation of IApp.getID
- Defined in App.ts:59
Get the ID of this App, please see for how to obtain an ID for your App.

Returns string

the ID

getInfo

getInfo(): IAppInfo

Implementation of IApp.getInfo
- Defined in App.ts:105
Gets the entirity of the App's information.

Returns IAppInfo

App information

getLogger

getLogger(): ILogger

Implementation of IApp.getLogger
- Defined in App.ts:114
Gets the ILogger instance for this App.

Returns ILogger

the logger instance

getName

getName(): string

Implementation of IApp.getName
- Defined in App.ts:41
Get the name of this App.

Returns string

the name

getNameSlug

getNameSlug(): string

Implementation of IApp.getNameSlug
- Defined in App.ts:50
Gets the sluggified name of this App.

Returns string

the name slugged

getRequiredApiVersion

getRequiredApiVersion(): string

Implementation of IApp.getRequiredApiVersion
- Defined in App.ts:87
Gets the API Version which this App depends on (http://semver.org/). This property is used for the dependency injections.

Returns string

the required api version

getStatus

getStatus(): AppStatus

Implementation of IApp.getStatus
- Defined in App.ts:32
Returns AppStatus

getVersion

getVersion(): string

Implementation of IApp.getVersion
- Defined in App.ts:68
Get the version of this App, using http://semver.org/.

Returns string

the version

initialize

initialize(configurationExtend: IConfigurationExtend, environmentRead: IEnvironmentRead): Promise<void>

- Defined in App.ts:122
Method which will be called when the App is initialized. This is the recommended place to add settings and slash commands. If an error is thrown, all commands will be unregistered.

Parameters
- configurationExtend: IConfigurationExtend
- environmentRead: IEnvironmentRead
Returns Promise<void>

onDisable

onDisable(configurationModify: IConfigurationModify): Promise<void>

- Defined in App.ts:143
Method which is called when this App is disabled and it can be called several times. If this App was enabled and then the user disabled it, this method will be called.

Parameters
- configurationModify: IConfigurationModify
Returns Promise<void>

onEnable

onEnable(environment: IEnvironmentRead, configurationModify: IConfigurationModify): Promise<boolean>

- Defined in App.ts:135
Method which is called when this App is enabled and can be called several times during this instance's life time. Once after the ititialize() is called, pending it doesn't throw an error, and then anytime the App is enabled by the user. If this method, onEnable(), returns false, then this App will not actually be enabled (ex: a setting isn't configured).

Parameters
- environment: IEnvironmentRead
- configurationModify: IConfigurationModify
Returns Promise<boolean>

whether the App should be enabled or not

onSettingUpdated

onSettingUpdated(setting: ISetting, configurationModify: IConfigurationModify, read: IRead, http: IHttp): Promise<void>

- Defined in App.ts:156
Method which is called whenever a setting which belongs to this App has been updated by an external system and not this App itself. The setting passed is the newly updated one.

Parameters
- setting: ISetting
  
  the setting which was updated
- configurationModify: IConfigurationModify
  
  the accessor to modifiy the system
- read: IRead
- http: IHttp
  
  an accessor to the outside world
Returns Promise<void>

Protected setStatus

setStatus(status: AppStatus): Promise<void>

- Defined in App.ts:173
Sets the status this App is now at, use only when 100% true (it's protected for a reason).

Parameters
- status: AppStatus
  
  the new status of this App
Returns Promise<void>

Generated using TypeDoc