GoogleRidesharingDriver Framework Reference

GMTSTask

@interface GMTSTask : GMTSImmutableData

An immutable object representing a unit of work that is completed at a vehicle stop.

• taskID

  The ID of the task.

  Declaration

  Swift

  var taskID: String? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) GMTDFleetEngineIDString *taskID;

• providerID

  The ID associated with the provider.

  Declaration

  Swift

  var providerID: String? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) NSString *providerID;

• taskType

  The type of current task.

  Declaration

  Swift

  var taskType: GMTSTaskType { get }

  Objective-C

  @property (nonatomic, readonly) GMTSTaskType taskType;

• taskState

  The current execution state of the task.

  Declaration

  Swift

  var taskState: GMTSTaskState { get }

  Objective-C

  @property (nonatomic, readonly) GMTSTaskState taskState;

• taskOutcome

  The outcome of the task.

  Declaration

  Swift

  var taskOutcome: GMTSTaskOutcome { get }

  Objective-C

  @property (nonatomic, readonly) GMTSTaskOutcome taskOutcome;

• taskOutcomeTimestamp

  The timestamp of when the task’s outcome was updated (from server).

  Declaration

  Swift

  var taskOutcomeTimestamp: TimeInterval { get }

  Objective-C

  @property (nonatomic, readonly) NSTimeInterval taskOutcomeTimestamp;

• taskOutcomeWaypoint

  Waypoint where the task’s outcome was set.

  Declaration

  Swift

  var taskOutcomeWaypoint: GMSNavigationWaypoint? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) GMSNavigationWaypoint *taskOutcomeWaypoint;

• taskOutcomeLocationSource

  Indicates the source of the location information in the taskOutcomeWaypoint.

  Declaration

  Swift

  var taskOutcomeLocationSource: GMTSTaskOutcomeLocationSource { get }

  Objective-C

  @property (nonatomic, readonly) GMTSTaskOutcomeLocationSource taskOutcomeLocationSource;

• trackingID

  Lets you store an ID so that the customer can avoid unnecessary or complicated mapping.

  Declaration

  Swift

  var trackingID: String? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) GMTDFleetEngineIDString *trackingID;

• vehicleID

  The ID of the vehicle performing this task.

  Declaration

  Swift

  var vehicleID: String? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) GMTDFleetEngineIDString *vehicleID;

• plannedWaypoint

  The waypoint where the task is to be completed.

  Declaration

  Swift

  var plannedWaypoint: GMSNavigationWaypoint? { get }

  Objective-C

  @property (nonatomic, readonly, nullable) GMSNavigationWaypoint *plannedWaypoint;

• taskDuration

  Additional time to perform an action at this location.

  Declaration

  Swift

  var taskDuration: TimeInterval { get }

  Objective-C

  @property (nonatomic, readonly) NSTimeInterval taskDuration;

• -initWithTaskID:providerID:taskType:taskState:taskOutcome:taskOutcomeTimestamp:taskOutcomeWaypoint:taskOutcomeLocationSource:trackingID:vehicleID:plannedWaypoint:taskDuration:

  Instantiates an instance of this class.

  Declaration

  Swift

  init(taskID: String?, providerID: String?, taskType: GMTSTaskType, taskState: GMTSTaskState, taskOutcome: GMTSTaskOutcome, taskOutcomeTimestamp: TimeInterval, taskOutcomeWaypoint: GMSNavigationWaypoint?, taskOutcomeLocationSource: GMTSTaskOutcomeLocationSource, trackingID: String?, vehicleID: String?, plannedWaypoint: GMSNavigationWaypoint?, taskDuration: TimeInterval)

  Objective-C

  - (nonnull instancetype)
                 initWithTaskID:(nullable GMTDFleetEngineIDString *)taskID
                     providerID:(nullable NSString *)providerID
                       taskType:(GMTSTaskType)taskType
                      taskState:(GMTSTaskState)taskState
                    taskOutcome:(GMTSTaskOutcome)taskOutcome
           taskOutcomeTimestamp:(NSTimeInterval)taskOutcomeTimestamp
            taskOutcomeWaypoint:
                (nullable GMSNavigationWaypoint *)taskOutcomeWaypoint
      taskOutcomeLocationSource:
          (GMTSTaskOutcomeLocationSource)taskOutcomeLocationSource
                     trackingID:(nullable GMTDFleetEngineIDString *)trackingID
                      vehicleID:(nullable GMTDFleetEngineIDString *)vehicleID
                plannedWaypoint:(nullable GMSNavigationWaypoint *)plannedWaypoint
                   taskDuration:(NSTimeInterval)taskDuration;

  Parameters

  taskID	The ID of a task.
  providerID	The ID associated with the provider.
  taskType	The type of task.
  taskState	The current execution state of the task.
  taskOutcome	The outcome of the task.
  taskOutcomeTimestamp	The time when the task’s outcome was set.
  taskOutcomeWaypoint	Waypoint where the task’s outcome was set.
  taskOutcomeLocationSource	Indicates whether the value of the task_outcome_location came from unnecessary or complicated mapping.
  trackingID	Lets you store an ID so that the customer can avoid an unnecessary or complicated mapping.
  vehicleID	The ID of the vehicle performing this Task.
  plannedWaypoint	The waypoint where the task will be completed.
  taskDuration	Additional time to perform an action at this location.

• -init

  Unavailable

  Use the designated initializer instead.

  Declaration

  Objective-C

  - (nonnull instancetype)init;