Builder
class Builder
kotlin.Any | |
↳ | androidx.car.cluster.navigation.NavigationState.Builder |
Builder for creating a NavigationState
Summary
Public constructors |
|
---|---|
<init>() Builder for creating a |
Public methods |
|
---|---|
NavigationState.Builder |
addDestination(@NonNull : Destination) Add a destination or intermediate stop in the navigation. |
NavigationState.Builder |
Add a navigation step. |
NavigationState |
build() Returns a |
NavigationState.Builder |
setCurrentSegment(@Nullable : Segment?) Sets the current segment being driven, or null if the segment being driven is unknown. |
NavigationState.Builder |
setServiceStatus(@NonNull : NavigationState.ServiceStatus, @NonNull vararg : NavigationState.ServiceStatus!) Sets the service status (e.g.: normal operation, re-routing in progress, etc.) |
Public constructors
Public methods
addDestination
@NonNull fun addDestination(@NonNull : Destination): NavigationState.Builder
Add a destination or intermediate stop in the navigation. Destinations should be provided from nearest to furthest.
Return | |
---|---|
NavigationState.Builder: this object for chaining |
addStep
@NonNull fun addStep(@NonNull : Step): NavigationState.Builder
Add a navigation step. Steps should be provided in order of execution. It is up to the producer to decide how many steps in advance will be provided.
Return | |
---|---|
NavigationState.Builder: this object for chaining |
build
@NonNull fun build(): NavigationState
Returns a NavigationState
built with the provided information.
setCurrentSegment
@NonNull fun setCurrentSegment(@Nullable : Segment?): NavigationState.Builder
Sets the current segment being driven, or null if the segment being driven is unknown.
setServiceStatus
@NonNull fun setServiceStatus(@NonNull : NavigationState.ServiceStatus, @NonNull vararg : NavigationState.ServiceStatus!): NavigationState.Builder
Sets the service status (e.g.: normal operation, re-routing in progress, etc.)
Parameters | |
---|---|
serviceStatus |
NavigationState.ServiceStatus: current service status |
fallbackServiceStatuses |
NavigationState.ServiceStatus: variations of the current service status (ordered from specific to generic), in case the main one is not understood by the consumer of this API. In such scenario, consumers will receive the first value in this list that they can deserialize. |
Return | |
---|---|
NavigationState.Builder: this object for chaining |