Represents a Trip.
Package
@googlemaps/fleetengineConstructors
(constructor)(properties)
constructor(properties?: maps.fleetengine.v1.ITrip);Constructs a new Trip.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITrip
Properties to set |
Properties
actualDropoffPoint
public actualDropoffPoint?: (maps.fleetengine.v1.IStopLocation|null);Trip actualDropoffPoint.
actualIntermediateDestinationArrivalPoints
public actualIntermediateDestinationArrivalPoints: maps.fleetengine.v1.IStopLocation[];Trip actualIntermediateDestinationArrivalPoints.
actualIntermediateDestinations
public actualIntermediateDestinations: maps.fleetengine.v1.IStopLocation[];Trip actualIntermediateDestinations.
actualPickupArrivalPoint
public actualPickupArrivalPoint?: (maps.fleetengine.v1.IStopLocation|null);Trip actualPickupArrivalPoint.
actualPickupPoint
public actualPickupPoint?: (maps.fleetengine.v1.IStopLocation|null);Trip actualPickupPoint.
currentRouteSegment
public currentRouteSegment: string;Trip currentRouteSegment.
currentRouteSegmentEndPoint
public currentRouteSegmentEndPoint?: (maps.fleetengine.v1.ITripWaypoint|null);Trip currentRouteSegmentEndPoint.
currentRouteSegmentTraffic
public currentRouteSegmentTraffic?: (maps.fleetengine.v1.IConsumableTrafficPolyline|null);Trip currentRouteSegmentTraffic.
currentRouteSegmentTrafficVersion
public currentRouteSegmentTrafficVersion?: (google.protobuf.ITimestamp|null);Trip currentRouteSegmentTrafficVersion.
currentRouteSegmentVersion
public currentRouteSegmentVersion?: (google.protobuf.ITimestamp|null);Trip currentRouteSegmentVersion.
dropoffPoint
public dropoffPoint?: (maps.fleetengine.v1.ITerminalLocation|null);Trip dropoffPoint.
dropoffTime
public dropoffTime?: (google.protobuf.ITimestamp|null);Trip dropoffTime.
etaToFirstWaypoint
public etaToFirstWaypoint?: (google.protobuf.ITimestamp|null);Trip etaToFirstWaypoint.
intermediateDestinationIndex
public intermediateDestinationIndex: number;Trip intermediateDestinationIndex.
intermediateDestinations
public intermediateDestinations: maps.fleetengine.v1.ITerminalLocation[];Trip intermediateDestinations.
intermediateDestinationsVersion
public intermediateDestinationsVersion?: (google.protobuf.ITimestamp|null);Trip intermediateDestinationsVersion.
lastLocation
public lastLocation?: (maps.fleetengine.v1.IVehicleLocation|null);Trip lastLocation.
lastLocationSnappable
public lastLocationSnappable: boolean;Trip lastLocationSnappable.
name
public name: string;Trip name.
numberOfPassengers
public numberOfPassengers: number;Trip numberOfPassengers.
pickupPoint
public pickupPoint?: (maps.fleetengine.v1.ITerminalLocation|null);Trip pickupPoint.
pickupTime
public pickupTime?: (google.protobuf.ITimestamp|null);Trip pickupTime.
remainingDistanceMeters
public remainingDistanceMeters?: (google.protobuf.IInt32Value|null);Trip remainingDistanceMeters.
remainingTimeToFirstWaypoint
public remainingTimeToFirstWaypoint?: (google.protobuf.IDuration|null);Trip remainingTimeToFirstWaypoint.
remainingWaypoints
public remainingWaypoints: maps.fleetengine.v1.ITripWaypoint[];Trip remainingWaypoints.
remainingWaypointsRouteVersion
public remainingWaypointsRouteVersion?: (google.protobuf.ITimestamp|null);Trip remainingWaypointsRouteVersion.
remainingWaypointsVersion
public remainingWaypointsVersion?: (google.protobuf.ITimestamp|null);Trip remainingWaypointsVersion.
route
public route: google.type.ILatLng[];Trip route.
tripStatus
public tripStatus: (maps.fleetengine.v1.TripStatus|keyof typeof maps.fleetengine.v1.TripStatus);Trip tripStatus.
tripType
public tripType: (maps.fleetengine.v1.TripType|keyof typeof maps.fleetengine.v1.TripType);Trip tripType.
vehicleId
public vehicleId: string;Trip vehicleId.
vehicleWaypoints
public vehicleWaypoints: maps.fleetengine.v1.ITripWaypoint[];Trip vehicleWaypoints.
view
public view: (maps.fleetengine.v1.TripView|keyof typeof maps.fleetengine.v1.TripView);Trip view.
Methods
create(properties)
public static create(properties?: maps.fleetengine.v1.ITrip): maps.fleetengine.v1.Trip;Creates a new Trip instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITrip
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Trip |
Trip instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.v1.Trip;Decodes a Trip 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 |
Trip |
Trip |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.v1.Trip;Decodes a Trip message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Trip |
Trip |
encode(message, writer)
public static encode(message: maps.fleetengine.v1.ITrip, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Trip message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITrip
Trip 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.ITrip, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Trip message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITrip
Trip 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.Trip;Creates a Trip 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 |
Trip |
Trip |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Trip
| 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 Trip to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: maps.fleetengine.v1.Trip, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Trip message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Trip
Trip |
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 Trip message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|