GMTSTask Class Reference

GMTSTask Class Reference

Overview

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

Inherits GMTSImmutableData.

Inherited by GMTDDeliveryTask.

Public Member Functions

(instancetype) - initWithTaskID:providerID:taskType:taskState:taskOutcome:taskOutcomeTimestamp:taskOutcomeWaypoint:taskOutcomeLocationSource:trackingID:vehicleID:plannedWaypoint:taskDuration:
 Instantiates an instance of this class.

Properties

GMTSFleetEngineIDStringtaskID
 The ID of the task.
NSString * providerID
 The ID associated with the provider.
GMTSTaskType taskType
 The type of current task.
GMTSTaskState taskState
 The current execution state of the task.
GMTSTaskOutcome taskOutcome
 The outcome of the task.
NSTimeInterval taskOutcomeTimestamp
 The timestamp of when the task's outcome was updated (from server).
GMSNavigationWaypoint * taskOutcomeWaypoint
 Waypoint where the task's outcome was set.
GMTSTaskOutcomeLocationSource taskOutcomeLocationSource
 Indicates the source of the location information in the taskOutcomeWaypoint.
GMTSFleetEngineIDStringtrackingID
 Lets you store an ID so that the customer can avoid unnecessary or complicated mapping.
GMTSFleetEngineIDStringvehicleID
 The ID of the vehicle performing this task.
GMSNavigationWaypoint * plannedWaypoint
 The waypoint where the task is to be completed.
NSTimeInterval taskDuration
 Additional time to perform an action at this location.

Member Function Documentation

- (instancetype) initWithTaskID: (nullable GMTSFleetEngineIDString *)  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 GMTSFleetEngineIDString *)  trackingID
vehicleID: (nullable GMTSFleetEngineIDString *)  vehicleID
plannedWaypoint: (nullable GMSNavigationWaypoint *)  plannedWaypoint
taskDuration: (NSTimeInterval)  taskDuration 

Instantiates an instance of this class.

Parameters:
taskIDThe ID of a task.
providerIDThe ID associated with the provider.
taskTypeThe type of task.
taskStateThe current execution state of the task.
taskOutcomeThe outcome of the task.
taskOutcomeTimestampThe time when the task's outcome was set.
taskOutcomeWaypointWaypoint where the task's outcome was set.
taskOutcomeLocationSourceIndicates whether the value of the task_outcome_location came from unnecessary or complicated mapping.
trackingIDLets you store an ID so that the customer can avoid an unnecessary or complicated mapping.
vehicleIDThe ID of the vehicle performing this Task.
plannedWaypointThe waypoint where the task will be completed.
taskDurationAdditional time to perform an action at this location.

Property Documentation

- (GMTSFleetEngineIDString*) taskID [read, assign]

The ID of the task.

- (NSString*) providerID [read, assign]

The ID associated with the provider.

- (GMTSTaskType) taskType [read, assign]

The type of current task.

- (GMTSTaskState) taskState [read, assign]

The current execution state of the task.

- (GMTSTaskOutcome) taskOutcome [read, assign]

The outcome of the task.

- (NSTimeInterval) taskOutcomeTimestamp [read, assign]

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

- (GMSNavigationWaypoint*) taskOutcomeWaypoint [read, assign]

Waypoint where the task's outcome was set.

Indicates the source of the location information in the taskOutcomeWaypoint.

- (GMTSFleetEngineIDString*) trackingID [read, assign]

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

- (GMTSFleetEngineIDString*) vehicleID [read, assign]

The ID of the vehicle performing this task.

- (GMSNavigationWaypoint*) plannedWaypoint [read, assign]

The waypoint where the task is to be completed.

- (NSTimeInterval) taskDuration [read, assign]

Additional time to perform an action at this location.