Class: TriggerPreferenceService

Callbacks for persistent trigger preferences, available via k.triggers.

The streamer configures and enables the trigger. Registering or removing a callback only changes this execution's local listeners. An activation never starts an app: the app must already be running. Declare triggers:manage.

Constructors

Constructor

new TriggerPreferenceService(): TriggerPreferenceService;

Returns

TriggerPreferenceService

Methods

onTrigger()

Call Signature

onTrigger<TSchema>(preference, callback): () => void;

Register a callback for one preference. Replaces an earlier registration for the same identity and returns a local unsubscribe function. Register new collection entries again when preferences.UPDATED fires. Null, missing, or unsynchronized preferences are harmless no-ops.

Type Parameters

TSchema

TSchema extends DynamicTriggerArgumentSchema

Parameters

preference

TriggerPreference<TSchema>

callback

TriggerPreferenceCallback<TSchema>

Returns

() => void

Call Signature

onTrigger(preference, callback): () => void;

Register a callback for one preference. Replaces an earlier registration for the same identity and returns a local unsubscribe function. Register new collection entries again when preferences.UPDATED fires. Null, missing, or unsynchronized preferences are harmless no-ops.

Parameters

preference

unknown

callback

TriggerPreferenceCallback

Returns

() => void