RouteRefreshExtra

object RouteRefreshExtra

Extra data of route refresh

Types

Link copied to clipboard
annotation class RouteRefreshState

Route refresh states. See RouteRefreshStatesObserver.

Properties

Link copied to clipboard
const val REFRESH_STATE_CANCELED: String

The state becomes REFRESH_STATE_CANCELED when a route refresh canceled. It occurs when a new set of routes are set, that leads to interrupt route refresh process.

Link copied to clipboard
const val REFRESH_STATE_CLEARED_EXPIRED: String

The state becomes REFRESH_STATE_CLEARED_EXPIRED when expired incidents and congestion annotations are removed from the route due to failure of a route refresh request.

Link copied to clipboard
const val REFRESH_STATE_FINISHED_FAILED: String

The state becomes REFRESH_STATE_FINISHED_FAILED when a route refresh failed after all the retry attempts (whose number may differ depending on refresh mode: planned or on-demand). The state is triggered in case refresh of every route from routes failed.

Link copied to clipboard
const val REFRESH_STATE_FINISHED_SUCCESS: String

The state becomes REFRESH_STATE_FINISHED_SUCCESS when the route is successfully refreshed. The state is triggered in case if at least one route is refreshed successfully.

Link copied to clipboard
const val REFRESH_STATE_STARTED: String

The state becomes REFRESH_STATE_STARTED when route refresh round is started.