GoogleRidesharingDriver Framework Reference

AI-generated Key Takeaways

• GMTDDeliveryVehicleReporter is an object used to send delivery-related information to the Fleet Engine backend.

• The setVehicleStops method updates the remaining vehicle stops, requiring a non-nil, ordered array of GMTDVehicleStop objects, with all stops after the first one having a state of GMTDVehicleStopStateNew.

• Methods reportEnrouteToNextStopWithCompletion, reportArrivedAtStopWithCompletion, and reportCompletedStopWithCompletion update the state or remove the first GMTDVehicleStop in remainingVehicleStops, which must contain at least one stop when these are called.

• getRemainingVehicleStopsWithCompletion retrieves the GMTDVehicleStop objects that represent the vehicle's pending stops.

GMTDDeliveryVehicleReporter

@interface GMTDDeliveryVehicleReporter : GMTDVehicleReporter

Object for sending information to the Fleet Engine backend. Used for deliveries.

• -setVehicleStops:completion:

  Updates the remaining VehicleStops for the vehicle. Results are reflected asynchronously in remainingVehicleStops. The vehicle is expected to visit the stops in the same order as the array.

  Declaration

  Swift

  func setVehicleStops(_ vehicleStops: [GMTDVehicleStop]) async throws -> [GMTDVehicleStop]

  Objective-C

  - (void)setVehicleStops:(nonnull NSArray<GMTDVehicleStop *> *)vehicleStops
               completion:
                   (nonnull GMTDVehicleReporterStopCompletionHandler)completion;

  Parameters

  vehicleStops	The ordered array of GMTDVehicleStop objects the vehicle will visit. This must be non-nil and all stops other than the first stop must have a state of GMTDVehicleStopStateNew.
  completion	A block to run after the stops have been updated.

• -reportEnrouteToNextStopWithCompletion:

  Updates the state of the first GMTDVehicleStop in remainingVehicleStops to GMTDVehicleStopStateEnroute. remainingVehicleStops must contain at least one stop when this function is called.

  Declaration

  Swift

  func reportEnrouteToNextStop() async throws -> [GMTDVehicleStop]

  Objective-C

  - (void)reportEnrouteToNextStopWithCompletion:
      (nonnull GMTDVehicleReporterStopCompletionHandler)completion;

  Parameters

  completion

  A block to run after the stops have been updated.

• -reportArrivedAtStopWithCompletion:

  Updates the state of the first GMTDVehicleStop in remainingVehicleStops to GMTDVehicleStopStateArrived. remainingVehicleStops must contain at least one stop when this function is called.

  Declaration

  Swift

  func reportArrivedAtStop() async throws -> [GMTDVehicleStop]

  Objective-C

  - (void)reportArrivedAtStopWithCompletion:
      (nonnull GMTDVehicleReporterStopCompletionHandler)completion;

  Parameters

  completion

  A block to run after the stops have been updated.

• -reportCompletedStopWithCompletion:

  Removes the first GMTDVehicleStop in remainingVehicleStops. remainingVehicleStops must contain at least one stop when this function is called.

  Declaration

  Swift

  func reportCompletedStop() async throws -> [GMTDVehicleStop]

  Objective-C

  - (void)reportCompletedStopWithCompletion:
      (nonnull GMTDVehicleReporterStopCompletionHandler)completion;

  Parameters

  completion

  A block to run after the stops have been updated.

• -getRemainingVehicleStopsWithCompletion:

  Gets the remaining GMTDVehicleStop objects that the vehicle still needs to visit.

  Declaration

  Swift

  func remainingVehicleStops() async throws -> [GMTDVehicleStop]

  Objective-C

  - (void)getRemainingVehicleStopsWithCompletion:
      (nonnull GMTDVehicleReporterStopCompletionHandler)completion;

  Parameters

  completion

  A completion to run with the retrieved GMTDVehicleStop objects. The completion will be run asynchronously on the main thread.