Menu

Preset Events

       Preset events include _appInstall, _appStart, and _appEnd.

Event NameEvent IdentifierDescription
App Install_appInstallAutomatically reported every time the app is installed and opened for the first time.
App Launch_appStartAutomatically reported every time the app is opened, either from a closed state or transitioning from the background to the foreground after being inactive for more than 30 seconds.
App Exit_appEndAutomatically reported every time the app is closed or when it remains inactive in the background for more than 30 seconds.

Set Preset Event Custom Properties

       The SolarEngine SDK supports developers to set custom properties for three preset events: app startup, installation, and exit.

Parameter NameParameter MeaningParameter TypeMandatory
eventTypePreset events, e.g.
0: AppInstall
1: AppStart
2: AppEnd
3: All
numberYes
propertiesCustom propertiesobjectNo

Call example:

let customProperties = {
    test1:"key1",
    test2:2,
    test3:[1,"2"]
}
solarengine.setPresetEventProperties(3,customProperties);

// After calling setPresetEvent API, _appInstall, _appStart and _appEnd will all bring the custom properties.

Note:

  • Preset event properties should be set before SDK initialization. In this way, the properties will apply to all subsequent preset events reported by the SDK. If set after SDK initialization, the preset events generated before setting will not include these custom properties.
  • Custom preset event properties are not cached. Only the last setting will take effect if multiple settings are made for the same preset event.
  • If set multiple times, only the last setting will be effective.
  • Please do not customize properties with a key starting with an underscore "_". The SE SDK will abandon properties like this.


Previous
Get Preset Properties
Next
Predefined Events
Last modified: 2024-10-29Powered by