GoogleRidesharingDriver Framework Reference

  • GMTDDeliveryDriverAPI serves as the primary entry point for the Delivery vertical, providing access to its core components.

  • The vehicleReporter property enables sending updates to the Fleet Engine backend.

  • The deliveryTaskManager property allows for the creation and updating of delivery tasks.

  • The deliveryVehicleManager property facilitates the creation and retrieval of delivery vehicles.

  • The initWithDriverContext: method is the designated initializer for the API, requiring a driverContext object and ensuring that only one vertical is used in an SDK session to avoid unexpected behavior.

GMTDDeliveryDriverAPI

@interface GMTDDeliveryDriverAPI : GMTDDriverAPI

A class that provides access to all the core components and serves as the entry point for the Delivery vertical.

  • The vehicle reporter used to send updates to the Fleet Engine backend.

    Declaration

    Swift

    var vehicleReporter: GMTDDeliveryVehicleReporter { get }

    Objective-C

    @property (nonatomic, readonly) GMTDDeliveryVehicleReporter *_Nonnull vehicleReporter;
  • The task manager used to create or update delivery tasks.

    Declaration

    Swift

    var deliveryTaskManager: GMTDDeliveryTaskManager? { get }

    Objective-C

    @property (nonatomic, readonly, nullable) GMTDDeliveryTaskManager *deliveryTaskManager;
  • The vehicle manager used to create or get delivery vehicles.

    Declaration

    Swift

    var deliveryVehicleManager: GMTDDeliveryVehicleManager? { get }

    Objective-C

    @property (nonatomic, readonly, nullable) GMTDDeliveryVehicleManager *deliveryVehicleManager;
  • Initializes the API.

    After initialization, driver APIs from different verticals should not be used until this instance has been deallocated. Using driver API instances from multiple verticals in the same SDK session can lead to unexpected behavior.

    Declaration

    Swift

    init?(driverContext: GMTDDriverContext)

    Objective-C

    - (nullable instancetype)initWithDriverContext:
        (nonnull GMTDDriverContext *)driverContext;

    Parameters

    driverContext

    An object containing the necessary information for initialization.

    Return Value

    An instance of the API.

  • Unavailable

    Declaration

    Objective-C

    - (null_unspecified instancetype)init;