class
ActivityTracker
val stopChannel
Active state of this flag indicates that the navigator needs to be stopped. If navigation stops in the Finished state, (the movement stops or its speed falls below the threshold) and this state persists for some time, the flag is set to true, otherwise it is set to false.
val stop
Active state of this flag indicates that the navigator needs to be stopped. If navigation stops in the Finished state, (the movement stops or its speed falls below the threshold) and this state persists for some time, the flag is set to true, otherwise it is set to false.
AddEventResult
Result of adding an event (event object or error).
fun match(event: Function1, error: Function1): T
fun toString(): String
fun hashCode(): Int
Address
Address as a set of separate components.
Address(
drillDown: List<AddressAdmDiv>,
components: List<AddressComponent>,
buildingName: String?,
buildingId: BuildingId?,
postCode: String?,
buildingCode: String?,
fiasCode: String?,
addressComment: String?
)
Address as a set of separate components.
drillDown
components
buildingName
buildingId
postCode
buildingCode
fiasCode
addressComment
val drillDown
Set of administrative division objects where the described object is located.
val components
Full address of an object may contain several separate address components.
val buildingName
Name of the building.
val buildingId
Unique identifier of the building.
val postCode
ZIP code.
val buildingCode
Unique ZIP code of the building.
val fiasCode
FIAS code of the building.
val addressComment
Comment on the address. Example: "office 301; 9th floor"
AddressAdmDiv
Object of administrative division.
AddressComponent
Address component: street, house number, or verbal description of location.
fun match(
streetAddress: Function1,
number: Function1,
location: Function1
): T
fun toString(): String
fun hashCode(): Int
AddressLocation
Used for components that are difficult to describe with a specific address.
AddressLocation(comment: String)
Used for components that are difficult to describe with a specific address.
comment
AddressNumber
House number used as a full address. In some settlements, only the house number is indicated, without the street (for example, Krasnoobsk).
AddressStreet
Regular address with a street name and a building number.
AddRoadEventButton
Button for adding a road event.
AddRoadEventButton(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Button for adding a road event.
fun attachToModel(model: AddRoadEventCardModel): Unit
AddRoadEventCard
Card for adding a road event.
AddRoadEventCard(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Card for adding a road event.
fun attachToModel(model: AddRoadEventCardModel): Unit
AddRoadEventCardModel
Model of the card for adding a road event.
AddRoadEventCardModel(roadEventManager: RoadEventManager, map: Map)
Model of the card for adding a road event.
fun onEventTypeClicked(type: RoadEventType): Unit
Action that occurs when the event type selection control is clicked.
fun onLaneClicked(lane: Lane): Unit
Action that occurs when the lane selection control is clicked.
fun onDescriptionEntered(description: String): Unit
Action that occurs when entering description.
fun close(): Unit
val eventTypeChannel
Selected event type.
val lanesChannel
Selected lanes.
val canSelectLanesChannel
Whether it is possible to set lanes.
val descriptionChannel
Entered description.
val markerPositionChannel
Marker position on the screen.
val canSendChannel
Whether it is possible to send an event.
val resultChannel
Result of sending the event.
AddRoadEventControl
Base class for controls for adding road events.
AddRoadEventControl(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Base class for controls for adding road events.
fun attachToModel(model: AddRoadEventCardModel): Unit
@CallSuper
fun detachFromModel(): Unit
fun onAttachedToWindow(): Unit
fun onDetachedFromWindow(): Unit
AddRoadEventControls
Set of controls for adding road events. Consists of a card with event parameters, a "Submit" button, and a marker indicating the location of adding an event on the map.
val cardHeightChannel
Height in pixels to which the card is expanded.
AddRoadEventMarker
Marker for adding a road event.
AddRoadEventMarker(
context: Context,
attrs: AttributeSet? = null,
defStyle: Int = 0
)
Marker for adding a road event.
fun attachToModel(model: AddRoadEventCardModel): Unit
fun detachFromModel(): Unit
Aggregate
EV charging station description.
val connectorsFree
Number of available connectors (in the Available status).
val connectorsTotal
Total number of connectors, except for connectors in the Unavailable status.
val isActive
Shows whether connectors are active. true if there is at least one available (in the Available status), reserved (Reserved), or busy (Charging) connector.
val isBusy
Shows whether connectors are busy. true if half or more of the connectors are busy (in the Charging status).
val power
The maximum power of the connector at the station.
AlternativeRouteSelector
AlternativeRoutesProviderSettings
Settings of searching for alternative routes and a better route.
var alternativeRoutesEnabled
Flag to enable/disable suggesting alternative routes. By default, this option is enabled.
var betterRouteEnabled
Flag to enable/disable suggesting a better route. By default, this option is enabled.
var routeSearchDelay
Delay before searching for alternative routes when starting a trip on a route or after switching to another route. Must be not less than 5 seconds. The default value is 20 seconds.
var betterRouteTimeCostThreshold
Minimum travel time difference between the original route and the alternative route for which the alternative route is considered a better route.
var betterRouteLengthThreshold
Minimum total length of route edges that differ between the original route and the alternative route at which the alternative route is considered a better route.
var routerType
Type of a search engine for finding alternative routes.
Anchor
Image anchor point. (0, 0) - upper-left corner, (1, 1) - lower-right corner.
AndroidAutoMapSession
Car App session that renders a map on the surface provided by the AppManager.
Supports both shift and scale gestures.
The map's visibility is tied to the session's Lifecycle:
- Map becomes visible during the onStart event.
- Map becomes hidden during the onStop event.
Action.PAN must be included in the Template. Otherwise, the surface won't be available.
Next permissions are already declared in the SDK:
- androidx.car.app.ACCESS_SURFACE
- androidx.car.app.NAVIGATION_TEMPLATES
AndroidAutoMapSession(mapOptions: MapOptions)
Car App session that renders a map on the surface provided by the AppManager.
Supports both shift and scale gestures.
The map's visibility is tied to the session's Lifecycle:
- Map becomes visible during the onStart event.
- Map becomes hidden during the onStop event.
Action.PAN must be included in the Template. Otherwise, the surface won't be available.
Next permissions are already declared in the SDK:
- androidx.car.app.ACCESS_SURFACE
- androidx.car.app.NAVIGATION_TEMPLATES
mapOptions
The configuration of the map. The following parameters are not utilized:
fun onSurfaceAvailable(
surface: Surface,
width: Int,
height: Int
): Unit
Provides a surface for rendering additional content on top of the map. This surface can be created and provided before the onMapReady callback is triggered.
fun onSurfaceDestroyed(surface: Surface): Unit
Indicates that the surface has been destroyed.
fun onSurfaceStableAreaChanged(stableArea: Rect): Unit
Forwards the SurfaceCallback.onStableAreaChanged event.
fun onSurfaceVisibleAreaChanged(visibleArea: Rect): Unit
Forwards the SurfaceCallback.onVisibleAreaChanged event.
fun onMapReady(map: Map): Unit
Provides a map when it is successfully initialized.
fun onMapReadyException(exception: Exception): Unit
Provides an exception in case of an error during initialization.
fun setTheme(theme: MapTheme): Unit
Applies the theme to the map.
This takes effect only after the map has been initialized (i.e., after onMapReady has been called). To set a theme before the map is initialized, use the mapOptions#mapTheme.
fun setCopyrightPosition(position: CopyrightPosition): Unit
Sets the position of the copyright icon on the screen.
Important: This method must be called only after the onCreate state of Lifecycle.
AnimationSettings
Settings of map object animations. Applied to style layers with a model source specified. For example, layers of the "3D model" and "Directional model" type.