GMTDDeliveryVehicleReporter 类参考

GMTDDeliveryVehicleReporter 类参考

概览

用于将信息发送到 Fleet Engine 后端的对象。

用于配送。

继承 GMTDVehicleReporter

公开成员函数

(void) - setVehicleStops:completion:
 更新车辆的剩余 VehicleStop。
(void) - reportEnrouteToNextStopWithCompletion
 remainingVehicleStops 中第一个 GMTDVehicleStop 的状态更新为 GMTDVehicleStopStateEnroute
(void) - reportArrivedAtStopWithCompletion
 remainingVehicleStops 中第一个 GMTDVehicleStop 的状态更新为 GMTDVehicleStopStateArrived
(void) - reportCompletedStopWithCompletion:
 移除 remainingVehicleStops 中的第一个 GMTDVehicleStop
(void) - getRemainingVehicleStopsWithCompletion
 获取车辆仍需要访问的其余 GMTDVehicleStop 对象。
(void) - updateVehicleState
 更新车辆状态。
(void) - addListener:
 添加监听器。
(void) - removeListener
 移除监听器。

受保护的类型

typedef void(^)GMTDVehicleReporterStopCompletionHandler )(NSArray< GMTDVehicleStop * > *_Nullable 停止、NSError *_Nullable 错误)
 用于通过 GMTDDeliveryVehicleReporter 更新车站的处理程序。

受保护的属性

 __pad0__:NSObject <GMSNavigatorListener

属性

GMSRoadSnappedLocationProviderListener
BOOL
locationTrackingEnabled
 此类没有公共初始化程序;请从 GMTDDeliveryDriverAPIGMTDRidesharingDriverAPI 对象的 vehicleReporter 属性中获取此对象。
NSTimeInterval locationReportingInterval
 指明将营业地点报告发送到 Fleet Engine 的最小时间间隔。

成员函数文档

- (void) setVehicleStops: (NSArray< GMTDVehicleStop * > *) vehicleStops
完成: (GMTDVehicleReporterStopCompletionHandler) 完成

更新车辆的剩余 VehicleStop。

结果会异步反映在 remainingVehicleStops 中。车辆预计会按照与数组相同的顺序到达车站。

参数:
vehicleStops车辆将访问的 GMTDVehicleStop 对象的有序数组。此值必须为非 nil,并且除第一个停靠点之外的所有停靠站都必须具有 GMTDVehicleStopStateNew 状态。
完成在停止站更新后要运行的块。

remainingVehicleStops 中第一个 GMTDVehicleStop 的状态更新为 GMTDVehicleStopStateEnroute

调用此函数时,remainingVehicleStops 必须包含至少一个经停点。

参数:
完成在停止站更新后要运行的块。

remainingVehicleStops 中第一个 GMTDVehicleStop 的状态更新为 GMTDVehicleStopStateArrived

调用此函数时,remainingVehicleStops 必须包含至少一个经停点。

参数:
完成在停止站更新后要运行的块。

移除 remainingVehicleStops 中的第一个 GMTDVehicleStop

调用此函数时,remainingVehicleStops 必须包含至少一个经停点。

参数:
完成在停止站更新后要运行的块。

获取车辆仍需要访问的其余 GMTDVehicleStop 对象。

参数:
完成使用检索到的 GMTDVehicleStop 对象运行的完成。补全将在主线程上异步运行。
- (void) updateVehicleState (GMTDVehicleState) vehicleState

更新车辆状态。

仅用于拼车。

如果 locationTrackingEnabled 设置为 NO,则将状态设置为 GMTDVehicleStateOnline 会失败。

设置其他状态会向 Fleet Engine 后端发送一次性请求。

此方法会更新服务器端状态,客户端应用应监控 fleetEngine:didSucceedVehicleUpdate:fleetEngine:didFailVehicleUpdate:withError: 以确认是成功还是失败。如果 locationTrackingEnabled 设置为“是”,系统会自动重试失败。

参数:
vehicleState所需的车辆状态。
- (void) addListener: (id< GMTDVehicleReporterListener >) 监听器

添加监听器。

监听器由弱引用保存。

参数:
监听器一个符合 GMTDVehicleReporterListener 协议的对象。
- (void) removeListener: (id< GMTDVehicleReporterListener >) 监听器

移除监听器。

参数:
监听器一个符合 GMTDVehicleReporterListener 协议的对象。

成员数据文档

- GMTDVehicleReporter: [protected, inherited]

属性说明

- (GMSRoadSnappedLocationProviderListener BOOL) locationTrackingEnabled [read, write, assign, inherited]

此类没有公共初始化程序;请从 GMTDDeliveryDriverAPIGMTDRidesharingDriverAPI 对象的 vehicleReporter 属性中获取此对象。

指明是否已启用位置跟踪。

如果此政策设为“是”,系统会根据为 locationUpdateInterval 设置的值定期将行程和车辆更新发送到 Fleet Engine 后端。

如果设为“否”,更新将停止,并且会向 Fleet Engine 后端发送一次性车辆更新请求,以将车辆状态设置为 GMTDVehicleStateOffline。如需了解在 locationTrackingEnabled 设置为 NO 时处理失败情况的特殊注意事项,请参阅 updateVehicleState

- (NSTimeInterval) locationReportingInterval [read, write, assign, inherited]

指明将营业地点报告发送到 Fleet Engine 的最小时间间隔。

注意:
默认报告间隔为 10 秒。支持的最大值为 60 秒,支持的最小值为 5 秒。如果使用了此范围之外的值,则请求的值将限制为该范围。