Reference documentation and code samples for the Google Maps FleetEngine Delivery V1 Client class VisibilityOption.
The option message that defines when a data element should be visible to the end users.
Generated from protobuf message maps.fleetengine.delivery.v1.TaskTrackingViewConfig.VisibilityOption
Namespace
Google \ Maps \ FleetEngine \ Delivery \ V1 \ TaskTrackingViewConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ remaining_stop_count_threshold |
int
This data element is visible to the end users if the remaining stop count <= remaining_stop_count_threshold. |
↳ duration_until_estimated_arrival_time_threshold |
Google\Protobuf\Duration
This data element is visible to the end users if the ETA to the stop <= duration_until_estimated_arrival_time_threshold. |
↳ remaining_driving_distance_meters_threshold |
int
This data element is visible to the end users if the remaining driving distance in meters <= remaining_driving_distance_meters_threshold. |
↳ always |
bool
If set to true, this data element is always visible to the end users with no thresholds. This field cannot be set to false. |
↳ never |
bool
If set to true, this data element is always hidden from the end users with no thresholds. This field cannot be set to false. |
getRemainingStopCountThreshold
This data element is visible to the end users if the remaining stop count <= remaining_stop_count_threshold.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasRemainingStopCountThreshold
setRemainingStopCountThreshold
This data element is visible to the end users if the remaining stop count <= remaining_stop_count_threshold.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDurationUntilEstimatedArrivalTimeThreshold
This data element is visible to the end users if the ETA to the stop <= duration_until_estimated_arrival_time_threshold.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasDurationUntilEstimatedArrivalTimeThreshold
setDurationUntilEstimatedArrivalTimeThreshold
This data element is visible to the end users if the ETA to the stop <= duration_until_estimated_arrival_time_threshold.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRemainingDrivingDistanceMetersThreshold
This data element is visible to the end users if the remaining driving distance in meters <= remaining_driving_distance_meters_threshold.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasRemainingDrivingDistanceMetersThreshold
setRemainingDrivingDistanceMetersThreshold
This data element is visible to the end users if the remaining driving distance in meters <= remaining_driving_distance_meters_threshold.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAlways
If set to true, this data element is always visible to the end users with no thresholds. This field cannot be set to false.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasAlways
setAlways
If set to true, this data element is always visible to the end users with no thresholds. This field cannot be set to false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNever
If set to true, this data element is always hidden from the end users with no thresholds. This field cannot be set to false.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasNever
setNever
If set to true, this data element is always hidden from the end users with no thresholds. This field cannot be set to false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVisibilityOption
| Returns | |
|---|---|
| Type | Description |
string |
|