GMTDDeliveryDriverAPI Class Reference

GMTDDeliveryDriverAPI Class Reference

Overview

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

Inherits GMTDDriverAPI.

Public Member Functions

(nullable instancetype) - initWithDriverContext:
 Initializes the API.

Static Public Member Functions

(NSString *) + SDKVersion
 Returns the version for this release of the Google On Demand Rides and Deliveries Driver SDK for iOS.
(NSString *) + SDKLongVersion
 Returns the long formatted version string.
(void) + setAbnormalTerminationReportingEnabled:
 Enables reporting of abnormal SDK terminations such as when the app crashes while the SDK is still running.

Properties

GMTDDeliveryVehicleReportervehicleReporter
 The vehicle reporter used to send updates to the Fleet Engine backend.
GMTDDeliveryTaskManagerdeliveryTaskManager
 The task manager used to create or update delivery tasks.
GMTDDeliveryVehicleManagerdeliveryVehicleManager
 The vehicle manager used to create or get delivery vehicles.

Member Function Documentation

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

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.

Parameters:
driverContextAn object containing the necessary information for initialization.
Returns:
An instance of the API.
+ (NSString *) SDKVersion

Returns the version for this release of the Google On Demand Rides and Deliveries Driver SDK for iOS.

For example, "0.4.4". The version is in the SDK's resource bundle.

+ (NSString *) SDKLongVersion

Returns the long formatted version string.

It includes the version string and bundle version in format "<SHORT VERSION> (<BUNDLE VERSION>)". For example, "0.4.4 (234.2)".

+ (void) setAbnormalTerminationReportingEnabled: (BOOL)  abnormalTerminationReportingEnabled

Enables reporting of abnormal SDK terminations such as when the app crashes while the SDK is still running.

This allows Google to improve SDK stability when applicable. The default is YES and value must be updated before the `initWithDriverContext` is called.

This property must be set from the main thread.


Property Documentation

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

The task manager used to create or update delivery tasks.

The vehicle manager used to create or get delivery vehicles.