Represents a DeliveryVehicle.
Package
@googlemaps/fleetengine-deliveryConstructors
(constructor)(properties)
constructor(properties?: maps.fleetengine.delivery.v1.IDeliveryVehicle);Constructs a new DeliveryVehicle.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDeliveryVehicle
Properties to set |
Properties
attributes
public attributes: maps.fleetengine.delivery.v1.IDeliveryVehicleAttribute[];DeliveryVehicle attributes.
currentRouteSegment
public currentRouteSegment: (Uint8Array|string);DeliveryVehicle currentRouteSegment.
currentRouteSegmentEndPoint
public currentRouteSegmentEndPoint?: (google.type.ILatLng|null);DeliveryVehicle currentRouteSegmentEndPoint.
lastLocation
public lastLocation?: (maps.fleetengine.delivery.v1.IDeliveryVehicleLocation|null);DeliveryVehicle lastLocation.
name
public name: string;DeliveryVehicle name.
navigationStatus
public navigationStatus: (maps.fleetengine.delivery.v1.DeliveryVehicleNavigationStatus|keyof typeof maps.fleetengine.delivery.v1.DeliveryVehicleNavigationStatus);DeliveryVehicle navigationStatus.
remainingDistanceMeters
public remainingDistanceMeters?: (google.protobuf.IInt32Value|null);DeliveryVehicle remainingDistanceMeters.
remainingDuration
public remainingDuration?: (google.protobuf.IDuration|null);DeliveryVehicle remainingDuration.
remainingVehicleJourneySegments
public remainingVehicleJourneySegments: maps.fleetengine.delivery.v1.IVehicleJourneySegment[];DeliveryVehicle remainingVehicleJourneySegments.
type
public type: (maps.fleetengine.delivery.v1.DeliveryVehicle.DeliveryVehicleType|keyof typeof maps.fleetengine.delivery.v1.DeliveryVehicle.DeliveryVehicleType);DeliveryVehicle type.
Methods
create(properties)
public static create(properties?: maps.fleetengine.delivery.v1.IDeliveryVehicle): maps.fleetengine.delivery.v1.DeliveryVehicle;Creates a new DeliveryVehicle instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDeliveryVehicle
Properties to set |
| Returns | |
|---|---|
| Type | Description |
DeliveryVehicle |
DeliveryVehicle instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.delivery.v1.DeliveryVehicle;Decodes a DeliveryVehicle message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
DeliveryVehicle |
DeliveryVehicle |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.delivery.v1.DeliveryVehicle;Decodes a DeliveryVehicle message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
DeliveryVehicle |
DeliveryVehicle |
encode(message, writer)
public static encode(message: maps.fleetengine.delivery.v1.IDeliveryVehicle, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DeliveryVehicle message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDeliveryVehicle
DeliveryVehicle message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: maps.fleetengine.delivery.v1.IDeliveryVehicle, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DeliveryVehicle message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDeliveryVehicle
DeliveryVehicle message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): maps.fleetengine.delivery.v1.DeliveryVehicle;Creates a DeliveryVehicle message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
DeliveryVehicle |
DeliveryVehicle |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DeliveryVehicle
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this DeliveryVehicle to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: maps.fleetengine.delivery.v1.DeliveryVehicle, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a DeliveryVehicle message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
DeliveryVehicle
DeliveryVehicle |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a DeliveryVehicle message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|