FeedbackAgentSession

class FeedbackAgentSession : MapboxNavigationObserver

Access point for core functionality of the Feedback Agent SDK, including environment configuration, lifecycle management, and surface capabilities.

Parameters

options

a set of FeedbackAgentOptions used to customize various features

Types

Link copied to clipboard
class Builder

Builder for creating a new instance of FeedbackAgentSession.

Functions

Link copied to clipboard
fun connect()

Starts a new session.

Link copied to clipboard
fun disconnect()

Closes the current session and disconnects from the host.

Link copied to clipboard
fun interruptListening()

Terminate ongoing conversation manually to close microphone and ignore the last user input.

Link copied to clipboard
open override fun onAttached(mapboxNavigation: MapboxNavigation)

Signals that the mapboxNavigation instance is ready for use.

Link copied to clipboard
open override fun onDetached(mapboxNavigation: MapboxNavigation)

Signals that the mapboxNavigation instance is being detached.

Link copied to clipboard
fun startListening()

Starts listening for user input.

Link copied to clipboard
fun stopListening()

Stop user input. If the user mic is open and listening, it should be closed

Properties

Link copied to clipboard
val asrState: StateFlow<ASRState?>

A StateFlow representing the current user input state.

Link copied to clipboard
val options: FeedbackAgentOptions