Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IApp

Hierarchy

  • IApp

Implemented by

Index

Methods

Methods

getAuthorInfo

  • Gets the information regarding the author/maintainer of this App.

    Returns IAppAuthorInfo

    author information

getDescription

  • getDescription(): string

  • Get the description of this App, mostly used to show to the clients/administrators.

    Returns string

    the description

getID

  • getID(): string

  • Get the ID of this App, please see for how to obtain an ID for your App.

    Returns string

    the ID

getInfo

  • Gets the entirity of the App's information.

    Returns IAppInfo

    App information

getLogger

  • Gets the ILogger instance for this App.

    Returns ILogger

    the logger instance

getName

  • getName(): string

  • Get the name of this App.

    Returns string

    the name

getNameSlug

  • getNameSlug(): string

  • Gets the sluggified name of this App.

    Returns string

    the name slugged

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

getStatus

  • Gets the status of this App.

    Returns AppStatus

    the status/state of the App

getVersion

  • getVersion(): string

Generated using TypeDoc