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. | |
| (instancetype) | - initWithTaskID:providerID:taskType:taskState:taskOutcome:taskOutcomeTimestamp:taskOutcomeLocation:taskOutcomeLocationSource:trackingID:vehicleID:plannedLocation:taskDuration: |
| Instantiates an instance of this class. | |
Properties | |
| GMTSFleetEngineIDString * | taskID |
| 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. | |
| GMTSLocationInfo * | taskOutcomeLocation |
| Location where the task's outcome was set. | |
| GMTSTaskOutcomeLocationSource | taskOutcomeLocationSource |
| Indicates the source of the location information in the taskOutcomeWaypoint. | |
| GMTSFleetEngineIDString * | trackingID |
| Lets you store an ID so that the customer can avoid unnecessary or complicated mapping. | |
| GMTSFleetEngineIDString * | vehicleID |
| The ID of the vehicle performing this task. | |
| GMSNavigationWaypoint * | plannedWaypoint |
| The waypoint where the task is to be completed. | |
| GMTSLocationInfo * | plannedLocation |
| The location 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:
-
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.
| - (instancetype) initWithTaskID: | (nullable GMTSFleetEngineIDString *) | taskID | |
| providerID: | (nullable NSString *) | providerID | |
| taskType: | (GMTSTaskType) | taskType | |
| taskState: | (GMTSTaskState) | taskState | |
| taskOutcome: | (GMTSTaskOutcome) | taskOutcome | |
| taskOutcomeTimestamp: | (NSTimeInterval) | taskOutcomeTimestamp | |
| taskOutcomeLocation: | (nullable GMTSLocationInfo *) | taskOutcomeLocation | |
| taskOutcomeLocationSource: | (GMTSTaskOutcomeLocationSource) | taskOutcomeLocationSource | |
| trackingID: | (nullable GMTSFleetEngineIDString *) | trackingID | |
| vehicleID: | (nullable GMTSFleetEngineIDString *) | vehicleID | |
| plannedLocation: | (nullable GMTSLocationInfo *) | plannedLocation | |
| taskDuration: | (NSTimeInterval) | taskDuration | |
Instantiates an instance of this class.
- Parameters:
-
taskID The ID of a task. providerID The ID associated with the provider. taskType The type of a task. taskState The current execution state of the task. taskOutcome The outcome of the task. taskOutcomeTimestamp The timestamp of when the task's outcome was set (from provider). taskOutcomeLocation Location 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 unnecessary or complicated mapping. vehicleID The ID of the vehicle performing this Task. plannedLocation The location where the task is to be completed. taskDuration Additional time to perform an action at this location.
- Note:
- This method is obsolete and will be removed in a future release. Use the designated initializer instead.
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.
- (GMTSLocationInfo*) taskOutcomeLocation [read, assign] |
Location where the task's outcome was set.
- Note:
- This property is obsolete and will be removed in a future release. Use the taskOutcomeWaypoint property instead.
- (GMTSTaskOutcomeLocationSource) taskOutcomeLocationSource [read, assign] |
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.
- (GMTSLocationInfo*) plannedLocation [read, assign] |
The location where the task is to be completed.
- Note:
- This property is obsolete and will be removed in a future release. Use the plannedWaypoint property instead.
- (NSTimeInterval) taskDuration [read, assign] |
Additional time to perform an action at this location.