Represents a VehicleLocation.
Package
@googlemaps/fleetengineConstructors
(constructor)(properties)
constructor(properties?: maps.fleetengine.v1.IVehicleLocation);Constructs a new VehicleLocation.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVehicleLocation
Properties to set |
Properties
altitude
public altitude?: (google.protobuf.IDoubleValue|null);VehicleLocation altitude.
altitudeAccuracy
public altitudeAccuracy?: (google.protobuf.IDoubleValue|null);VehicleLocation altitudeAccuracy.
bearingAccuracy
public bearingAccuracy?: (google.protobuf.IDoubleValue|null);VehicleLocation bearingAccuracy.
heading
public heading?: (google.protobuf.IInt32Value|null);VehicleLocation heading.
headingAccuracy
public headingAccuracy?: (google.protobuf.IDoubleValue|null);VehicleLocation headingAccuracy.
horizontalAccuracy
public horizontalAccuracy?: (google.protobuf.IDoubleValue|null);VehicleLocation horizontalAccuracy.
isGpsSensorEnabled
public isGpsSensorEnabled?: (google.protobuf.IBoolValue|null);VehicleLocation isGpsSensorEnabled.
isRoadSnapped
public isRoadSnapped?: (google.protobuf.IBoolValue|null);VehicleLocation isRoadSnapped.
latlngAccuracy
public latlngAccuracy?: (google.protobuf.IDoubleValue|null);VehicleLocation latlngAccuracy.
location
public location?: (google.type.ILatLng|null);VehicleLocation location.
locationSensor
public locationSensor: (maps.fleetengine.v1.LocationSensor|keyof typeof maps.fleetengine.v1.LocationSensor);VehicleLocation locationSensor.
numStaleUpdates
public numStaleUpdates?: (google.protobuf.IInt32Value|null);VehicleLocation numStaleUpdates.
rawLocation
public rawLocation?: (google.type.ILatLng|null);VehicleLocation rawLocation.
rawLocationAccuracy
public rawLocationAccuracy?: (google.protobuf.IDoubleValue|null);VehicleLocation rawLocationAccuracy.
rawLocationSensor
public rawLocationSensor: (maps.fleetengine.v1.LocationSensor|keyof typeof maps.fleetengine.v1.LocationSensor);VehicleLocation rawLocationSensor.
rawLocationTime
public rawLocationTime?: (google.protobuf.ITimestamp|null);VehicleLocation rawLocationTime.
roadSnapped
public roadSnapped: boolean;VehicleLocation roadSnapped.
serverTime
public serverTime?: (google.protobuf.ITimestamp|null);VehicleLocation serverTime.
speed
public speed?: (google.protobuf.IDoubleValue|null);VehicleLocation speed.
speedAccuracy
public speedAccuracy?: (google.protobuf.IDoubleValue|null);VehicleLocation speedAccuracy.
speedKmph
public speedKmph?: (google.protobuf.IInt32Value|null);VehicleLocation speedKmph.
supplementalLocation
public supplementalLocation?: (google.type.ILatLng|null);VehicleLocation supplementalLocation.
supplementalLocationAccuracy
public supplementalLocationAccuracy?: (google.protobuf.IDoubleValue|null);VehicleLocation supplementalLocationAccuracy.
supplementalLocationSensor
public supplementalLocationSensor: (maps.fleetengine.v1.LocationSensor|keyof typeof maps.fleetengine.v1.LocationSensor);VehicleLocation supplementalLocationSensor.
supplementalLocationTime
public supplementalLocationTime?: (google.protobuf.ITimestamp|null);VehicleLocation supplementalLocationTime.
timeSinceUpdate
public timeSinceUpdate?: (google.protobuf.IInt32Value|null);VehicleLocation timeSinceUpdate.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);VehicleLocation updateTime.
verticalAccuracy
public verticalAccuracy?: (google.protobuf.IDoubleValue|null);VehicleLocation verticalAccuracy.
Methods
create(properties)
public static create(properties?: maps.fleetengine.v1.IVehicleLocation): maps.fleetengine.v1.VehicleLocation;Creates a new VehicleLocation instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVehicleLocation
Properties to set |
| Returns | |
|---|---|
| Type | Description |
VehicleLocation |
VehicleLocation instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.v1.VehicleLocation;Decodes a VehicleLocation 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 |
VehicleLocation |
VehicleLocation |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.v1.VehicleLocation;Decodes a VehicleLocation message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
VehicleLocation |
VehicleLocation |
encode(message, writer)
public static encode(message: maps.fleetengine.v1.IVehicleLocation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified VehicleLocation message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVehicleLocation
VehicleLocation 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.v1.IVehicleLocation, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified VehicleLocation message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVehicleLocation
VehicleLocation 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.v1.VehicleLocation;Creates a VehicleLocation 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 |
VehicleLocation |
VehicleLocation |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for VehicleLocation
| 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 VehicleLocation to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: maps.fleetengine.v1.VehicleLocation, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a VehicleLocation message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
VehicleLocation
VehicleLocation |
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 VehicleLocation message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|