Documentation Index

Fetch the complete documentation index at: https://engage-docs.frigade.com/llms.txt

Use this file to discover all available pages before exploring further.

The Frigade class is the main entry point for the Frigade JS SDK. It is used to create a new instance of the Frigade SDK and to interact with the Frigade API. The Step type is a representation of a step in a Flow. It contains all the data and methods needed to build custom components with Frigade and to interact with the Frigade API without writing a single custom network call.

​

Properties

​

getCollections

▸ getCollections(): Promise<CollectionsList>

---

​

getConfig

▸ getConfig(): FrigadeConfig Gets the current configuration. See FrigadeConfig for a list of available options.

---

​

getFlow

▸ getFlow(flowId): Promise<Flow> Get a Flow by its ID. Parameters

---

​

getFlows

▸ getFlows(): Promise<Flow[]>

---

​

group

▸ group(groupId?, properties?): Promise<void> Set the group for the current user. Parameters

---

​

hasFailedToLoad

▸ hasFailedToLoad(): boolean Returns true if the JS SDK failed to connect to the Frigade API.

---

​

identify

▸ identify(userId, properties?): Promise<void> Set the current user. Parameters

---

​

off

▸ off(event, handler): Promise<void> Removes the given handler. Parameters

---

​

on

▸ on(event, handler): Promise<void> Event handler that captures all changes that happen to the state of the Flows. Use flow.any to capture all events. Parameters

---

​

onStateChange

▸ onStateChange(handler): Promise<void> Event handler that captures all changes that happen to the state of the Flows. Parameters Deprecated Use frigade.on instead.

---

​

registerCollection

▸ registerCollection(collectionId): Promise<void> Parameters

---

​

reload

▸ reload(config?): Promise<void> Reload the current state of the flows by calling the Frigade API. This will trigger all event handlers. Parameters

---

​

removeStateChangeHandler

▸ removeStateChangeHandler(handler): Promise<void> Removes the given handler from the list of event handlers. Parameters

---

​

resync

▸ resync(): Promise<void>

---

​

track

▸ track(event, properties?): Promise<void> Track an event for the current user (and group if set). Parameters

---

​

triggerAllEventHandlers

▸ triggerAllEventHandlers(): void View definition