Interface IApp

Hierarchy

IApp

Implemented by

App

Index

Methods

getAccessors getAppUserUsername getAuthorInfo getDescription getID getInfo getLogger getName getNameSlug getRequiredApiVersion getStatus getVersion

Methods

getAccessors

getAccessors(): IAppAccessors
Returns IAppAccessors
- Defined in src/definition/IApp.ts:89

getAppUserUsername

getAppUserUsername(): string
Gets the username of this App's app user.

Returns string
the username of the app user

Deprecated
This method will be removed in the next major version. Please use read.getAppUser instead.
- Defined in src/definition/IApp.ts:37

getAuthorInfo

getAuthorInfo(): IAppAuthorInfo
Gets the information regarding the author/maintainer of this App.

Returns IAppAuthorInfo
author information
- Defined in src/definition/IApp.ts:73

getDescription

getDescription(): string
Get the description of this App, mostly used to show to the clients/administrators.

Returns string
the description
- Defined in src/definition/IApp.ts:58

getID

getID(): string
Get the ID of this App, please see for how to obtain an ID for your App.

Returns string
the ID
- Defined in src/definition/IApp.ts:44

getInfo

getInfo(): IAppInfo
Gets the entirity of the App's information.

Returns IAppInfo
App information
- Defined in src/definition/IApp.ts:80

getLogger

getLogger(): ILogger
Gets the ILogger instance for this App.

Returns ILogger
the logger instance
- Defined in src/definition/IApp.ts:87

getName

getName(): string
Get the name of this App.

Returns string
the name
- Defined in src/definition/IApp.ts:20

getNameSlug

getNameSlug(): string
Gets the sluggified name of this App.

Returns string
the name slugged
- Defined in src/definition/IApp.ts:27

getRequiredApiVersion

getRequiredApiVersion(): string
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
- Defined in src/definition/IApp.ts:66

getStatus

getStatus(): Promise<AppStatus>
Gets the status of this App.

Returns Promise<AppStatus>
the status/state of the App
- Defined in src/definition/IApp.ts:13

getVersion

getVersion(): string
Get the version of this App, using http://semver.org/.

Returns string
the version
- Defined in src/definition/IApp.ts:51

Generated using TypeDoc