Class protos.maps.fleetengine.delivery.v1.Task.JourneySharingInfo (0.1.0)

Represents a JourneySharingInfo.

Package

@googlemaps/fleetengine-delivery

Constructors

(constructor)(properties)

constructor(properties?: maps.fleetengine.delivery.v1.Task.IJourneySharingInfo);

Constructs a new JourneySharingInfo.

Parameter
Name Description
properties IJourneySharingInfo

Properties to set

Properties

lastLocation

public lastLocation?: (maps.fleetengine.delivery.v1.IDeliveryVehicleLocation|null);

JourneySharingInfo lastLocation.

lastLocationSnappable

public lastLocationSnappable: boolean;

JourneySharingInfo lastLocationSnappable.

remainingVehicleJourneySegments

public remainingVehicleJourneySegments: maps.fleetengine.delivery.v1.IVehicleJourneySegment[];

JourneySharingInfo remainingVehicleJourneySegments.

Methods

create(properties)

public static create(properties?: maps.fleetengine.delivery.v1.Task.IJourneySharingInfo): maps.fleetengine.delivery.v1.Task.JourneySharingInfo;

Creates a new JourneySharingInfo instance using the specified properties.

Parameter
Name Description
properties IJourneySharingInfo

Properties to set

Returns
Type Description
JourneySharingInfo

JourneySharingInfo instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): maps.fleetengine.delivery.v1.Task.JourneySharingInfo;

Decodes a JourneySharingInfo 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
JourneySharingInfo

JourneySharingInfo

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): maps.fleetengine.delivery.v1.Task.JourneySharingInfo;

Decodes a JourneySharingInfo message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
JourneySharingInfo

JourneySharingInfo

encode(message, writer)

public static encode(message: maps.fleetengine.delivery.v1.Task.IJourneySharingInfo, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified JourneySharingInfo message. Does not implicitly messages.

Parameters
Name Description
message IJourneySharingInfo

JourneySharingInfo 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.Task.IJourneySharingInfo, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified JourneySharingInfo message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IJourneySharingInfo

JourneySharingInfo 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.Task.JourneySharingInfo;

Creates a JourneySharingInfo 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
JourneySharingInfo

JourneySharingInfo

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for JourneySharingInfo

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 JourneySharingInfo to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: maps.fleetengine.delivery.v1.Task.JourneySharingInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a JourneySharingInfo message. Also converts values to other types if specified.

Parameters
Name Description
message JourneySharingInfo

JourneySharingInfo

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 JourneySharingInfo message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not