Type Alias: DynamicTriggerCallFunction<TSchema, TUpdateData>

type DynamicTriggerCallFunction<TSchema, TUpdateData> = (trigger, trigger_request, resolve, reject) => Promise<string>;

Callback executed when a viewer activates a DynamicTrigger.

Type Parameters

TSchema

TSchema extends | DynamicTriggerArgumentSchema | undefined = undefined

TUpdateData

TUpdateData extends | DynamicTriggerCreateData | DynamicTriggerConfig = DynamicTriggerCreateData

Parameters

trigger

DynamicTrigger<TUpdateData, TSchema>

The DynamicTrigger that was fired.

trigger_request

DynamicTriggerRequestData<TSchema>

The trigger request data (author, arguments, metadata, currency spent…).

resolve

() => Promise<void>

Call this to confirm the activation (consumes the spent currency).

reject

(reason?) => Promise<void>

Call this to decline the activation (refunds the currency), with an optional reason.

Returns

Promise<string>

A promise resolving to a string (result / status of the processing).