navigation-ux-ipc-client-core/com.mapbox.dash.sdk.ipc.client.core

Package-level declarations

Types

Link copied to clipboard
interface IpcRateLimiter
Link copied to clipboard
@AnyThread
interface Logger
Link copied to clipboard
@AnyThread
interface NavManagerService

Represent a remote Navigation Service, serving different requests like search and navigation.

Link copied to clipboard
class WindowIpcRateLimiter(windowMs: Long, currentTimeMs: () -> Long = SystemClock::elapsedRealtime) : IpcRateLimiter

A lightweight fixed-window per-second rate limiter for IPC commands.

Functions

Link copied to clipboard
suspend fun NavManagerService.back(letAppMoveToBackground: Boolean = false): Result<Unit>

Sends a back request to the navigation app, which is an equivalent to the back click.

Link copied to clipboard
fun NavManagerService.getEventsFlowByType(eventTypeId: String, version: Int? = null): Flow<Event>

Gets the events flow and filters it to only emit events of the specified type. This is a convenience function that combines getEventsFlow and filterByEventType.

Link copied to clipboard
suspend fun NavManagerService.getForegroundActivities(): Result<List<String>>

Lets the caller get the foreground Activities of the nav app (i.e. is STARTED/RESUMED).

Link copied to clipboard
suspend fun NavManagerService.isAppInForeground(): Result<Boolean>

Lets the caller know if the nav app is in the foreground (i.e. is STARTED/RESUMED).

Link copied to clipboard
suspend fun NavManagerService.moveTaskToBack(): Result<Unit>

Sends a request to the navigation app to call Activity.moveTaskToBack, which should move the app to the background if it is in the foreground.

Link copied to clipboard
fun NavManagerService.observeForegroundActivities(): Flow<List<String>>

Lets the caller observe the foreground Activities of the nav app (i.e. is STARTED/RESUMED).

Link copied to clipboard
fun NavManagerService.observeIsAppInForeground(): Flow<Boolean>

Lets the caller observe the foreground state of the nav app.