Method will be called during initialization. It allows for adding custom configuration options and defaults
Gets the username of this App's app user.
the username of the app user
Gets the information regarding the author/maintainer of this App.
author information
Get the description of this App, mostly used to show to the clients/administrators.
the description
Get the ID of this App, please see for how to obtain an ID for your App.
the ID
Gets the entirity of the App's information.
App information
Gets the ILogger instance for this App.
the logger instance
Get the name of this App.
the name
Gets the sluggified name of this App.
the name slugged
Gets the API Version which this App depends on (http://semver.org/). This property is used for the dependency injections.
the required api version
Get the version of this App, using http://semver.org/.
the version
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.
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.
Method which is called when this App is enabled and can be called several
times during this instance's life time. Once after the initialize() 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).
whether the App should be enabled or not
Method which is called when the App is installed and it is called one single time.
This method is NOT called when the App is updated.
Method which is called before a setting which belongs to this App is going to be updated by an external system and not this App itself. The setting passed is the newly updated one.
the accessor to modifiy the system
an accessor to the outside world
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.
the setting which was updated
the accessor to modifiy the system
an accessor to the outside world
Method which is called when the App is uninstalled and it is called one single time.
This method will NOT be called when an App is getting disabled manually, ONLY when it's being uninstalled from Rocket.Chat.
Sets the status this App is now at, use only when 100% true (it's protected for a reason).
the new status of this App
Generated using TypeDoc
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 theinitialize()method to do items instead of the constructor as the constructor might be called more than once but theinitialize()will only be called once.