Interface ChatInstanceTours

Methods provided to developers to interact with the tour feature.

interface ChatInstanceTours {
    endTour: () => void;
    goToNextStep: () => void;
    goToStep: (stepId: string) => void;
    startTour: (message: string) => void;
}

Properties

endTour goToNextStep goToStep startTour

Properties

endTour

endTour: () => void

Clears all tour data, closes the tour, and switches to the launcher.

goToNextStep

goToNextStep: () => void

Moves forward one step in the tour.

goToStep

goToStep: (stepId: string) => void

Looks for the provided stepId string within the tour step items. If a step with a matching step_id is found then moves to that step within the tour.

startTour

startTour: (message: string) => void

Sends the given message to the back-end with the skipTourCard option set to true. When a tour response is received, this method automatically starts the tour and skips the tour card. If a response other than a tour is received, then an error is logged.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR