GMTDDeliveryVehicleReporter クラス リファレンス

パブリック メンバー関数 | 保護された型 | 保護された属性 | プロパティ
GMTDDeliveryVehicleReporter クラス リファレンス

概要

Fleet Engine バックエンドに情報を送信するためのオブジェクト。

配送に使用されます。

GMTDVehicleReporter を継承します。

パブリック メンバー関数

(void) - setVehicleStops:completion:
 車両の残りの VehicleStops を更新します。
(void) - reportEnrouteToNextStopWithComplete:
 remainingVehicleStops の最初の GMTDVehicleStop の状態を GMTDVehicleStopStateEnroute に更新します。
(void) - reportArrivedAtStopWithComplete:
 remainingVehicleStops の最初の GMTDVehicleStop の状態を GMTDVehicleStopStateArrived に更新します。
(void) - reportCompletedStopWithComplete:
 remainingVehicleStops の最初の GMTDVehicleStop を削除します。
(void) - getRemainingVehicleStopsWithComplete:
 車両がアクセスする必要のある残りの GMTDVehicleStop オブジェクトを取得します。
(void) - updateVehicleState:
 車両の状態を更新します。
(void) - addListener:
 リスナーを追加します。
(void) - removeListener:
 リスナーを削除します。

保護された型

typedef void(^ GMTDVehicleReporterStopCompletionHandler )(NSArray< GMTDVehicleStop * > *_Nullable 停車場所、NSError *_Nullable エラー)
 更新ハンドラは GMTDDeliveryVehicleReporter を介して停止します。

保護された属性

 __pad0__: NSObject <GMSNavigatorListener

プロパティ

GMSRoadSnappedLocationProviderListener
BOOL		locationTrackingEnabled
 このクラスには公開イニシャライザがありません。このオブジェクトは、GMTDDeliveryDriverAPI または GMTDRidesharingDriverAPI オブジェクトの vehicleReporter プロパティから取得します。
NSTimeInterval locationReportingInterval
 位置情報レポートが Fleet Engine に配信される最小間隔を指定します。

メンバー関数のドキュメント

- (void) setVehicleStops: （NSArray< GMTDVehicleStop * > *） vehicleStops
補完: （GMTDVehicleReporterStopCompletionHandler） completion（完了）

車両の残りの VehicleStops を更新します。

結果は remainingVehicleStops に非同期で反映されます。車両は、配列と同じ順序で各停車地に到着することが想定されています。

パラメータ:
vehicleStops車両がアクセスする GMTDVehicleStop オブジェクトの順序付き配列。これは nil でなく、最初の停車地以外のすべての停車地の状態が GMTDVehicleStopStateNew であることが必要です。
完了停車地が更新された後に実行するブロック。
-（void）reportEnrouteToNextStopWithComplete: （GMTDVehicleReporterStopCompletionHandler） completion

remainingVehicleStops の最初の GMTDVehicleStop の状態を GMTDVehicleStopStateEnroute に更新します。

この関数を呼び出すときは、remainingVehicleStops に 1 つ以上の停車地を含める必要があります。

パラメータ:
完了停車地が更新された後に実行するブロック。
- (void) reportArrivedAtStopWithComplete: （GMTDVehicleReporterStopCompletionHandler） completion

remainingVehicleStops の最初の GMTDVehicleStop の状態を GMTDVehicleStopStateArrived に更新します。

この関数を呼び出すときは、remainingVehicleStops に 1 つ以上の停車地を含める必要があります。

パラメータ:
完了停車地が更新された後に実行するブロック。
- (void) reportCompletedStopWithCompleted: （GMTDVehicleReporterStopCompletionHandler） completion

remainingVehicleStops の最初の GMTDVehicleStop を削除します。

この関数を呼び出すときは、remainingVehicleStops に 1 つ以上の停車地を含める必要があります。

パラメータ:
完了停車地が更新された後に実行するブロック。
- （void）getRemainingVehicleStopsWithCompleted: （GMTDVehicleReporterStopCompletionHandler） completion

車両がアクセスする必要のある残りの GMTDVehicleStop オブジェクトを取得します。

パラメータ:
完了取得した GMTDVehicleStop オブジェクトで実行する完了。完了はメインスレッドで非同期に実行されます。
-（void）updateVehicleState: （GMTDVehicleState） vehicleState

車両の状態を更新します。

ライドシェアリングにのみ使用されます。

locationTrackingEnabled が NO に設定されている場合、状態を GMTDVehicleStateOnline に設定すると失敗します。

別の状態を設定すると、Fleet Engine バックエンドに 1 回限りのリクエストが送信されます。

このメソッドはサーバー側の状態を更新します。クライアント アプリは fleetEngine:didSucceedVehicleUpdate: と fleetEngine:didFailVehicleUpdate:withError: をモニタリングして成功または失敗を確認する必要があります。locationTrackingEnabled が YES に設定されている場合、失敗は自動的に再試行されます。

パラメータ:
vehicleState望ましい車両の状態。
-（void）addListener: （id< GMTDVehicleReporterListener >） リスナー

リスナーを追加します。

リスナーが弱い参照で保持されている。

パラメータ:
リスナーGMTDVehicleReporterListener プロトコルに準拠したオブジェクト。
-（void）removeListener: （id< GMTDVehicleReporterListener >） リスナー

リスナーを削除します。

パラメータ:
リスナーGMTDVehicleReporterListener プロトコルに準拠したオブジェクト。

メンバーデータに関するドキュメント

- GMTDVehicleReporter: [protected, inherited]

プロパティのドキュメント

-（GMSRoadSnappedLocationProviderListener BOOL）locationTrackingEnabled [read, write, assign, inherited]

このクラスには公開イニシャライザがありません。このオブジェクトは、GMTDDeliveryDriverAPI または GMTDRidesharingDriverAPI オブジェクトの vehicleReporter プロパティから取得します。

位置情報の追跡が有効かどうかを示します。

YES に設定すると、locationUpdateInterval に設定された値に基づいて、ルートと車両の更新情報が Fleet Engine バックエンドに定期的に送信されます。

NO に設定すると、更新は停止し、1 回限りの車両更新リクエストが Fleet Engine バックエンドに送信され、車両ステータスが GMTDVehicleStateOffline に設定されます。locationTrackingEnabled が NO に設定されている場合の失敗処理に関する特別な考慮事項については、updateVehicleState をご覧ください。

-（NSTimeInterval）locationReportingInterval [read, write, assign, inherited]

位置情報レポートが Fleet Engine に配信される最小間隔を指定します。

注:
デフォルトのレポート間隔は 10 秒です。サポートされる最大値は 60 秒、サポートされる最小値は 5 秒です。この範囲外の値を使用すると、リクエストされた値がその範囲に固定されます。