Settings – Event Methods and Data Model Interfaces

Prev Next

Event Methods

Settings-related events are exposed as lifecycle methods in the App class. These methods are triggered when a setting belonging to the app is about to be updated or has been updated.

Event Method

Description

onSettingUpdated

Called after a setting belonging to the app has been updated by an external system (not the app itself).

onPreSettingUpdate

Called before a setting belonging to the app is updated by an external system.

Data Model Interfaces

The following data model interfaces are passed into the event methods. They describe the details of the setting and its update context, but they are not events themselves.

Interface

Description

ISetting

Represents a setting and provides details such as ID, type, value, etc.

ISettingUpdateContext

Provides context for the event, including the new setting value.

SettingType

Represents the type of setting configured for the app.

For the full definitions, see the Rocket.Chat Apps-Engine source code.