InsightInterface

This is for:

Developer

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

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;