InsightInterface (Deprecated)
InsightInterface (Deprecated)
The InsightInterface controller is responsible for retrieving the Insight interface configuration.
Methods
fetch
Fetches the Insight interface configuration.
subscribe
Adds a callback that’s invoked on state change.
Parameters
-
listener:
() => voidA callback that’s invoked on state change.
Returns Unsubscribe: A function to remove the listener.
Attributes
state
A scoped and simplified part of the headless state that is relevant to the InsightInterface controller.
Properties
-
loading:
boolean -
config?:
{ contextFields: Record<string, string>; interface?: InsightInterface; } -
error?:
InsightAPIErrorStatusResponse
Initialize
buildInsightInterface
Creates an InsightInterface controller instance.
Parameters
-
engine:
InsightEngineThe insight engine.
Returns InsightInterface
Related Types
InsightAPIErrorStatusResponse
Properties
-
message:
string -
statusCode:
number -
type:
string -
ignored?:
boolean
Unsubscribe
Call signatures
-
(): void