InsightInterface

This is for:

Developer

In this article

Methods
Attributes
Initialize
Related types

Note

This component was introduced in version 1.103.0.

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: () => void

A 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: InsightEngine

The insight engine.

Returns InsightInterface

`InsightAPIErrorStatusResponse`

Properties

message: string
statusCode: number
type: string
ignored?: boolean

`Unsubscribe`

Call signatures

(): void;