GMTDCreateDeliveryTaskRequest Class Reference

GMTDCreateDeliveryTaskRequest Class Reference

Overview

An immutable object representing a request to create a delivery task.

Inherits GMTSImmutableData.

Public Member Functions

(instancetype) - initWithTaskID:trackingID:taskType:taskState:taskDuration:plannedWaypoint:
 Initializes and returns a GMTDCreateDeliveryTaskRequest object using the provided attributes.

Properties

GMTDFleetEngineIDStringtaskID
 Use initWithTaskID:trackingID:taskType:taskState:taskDuration:plannedWaypoint: instead.
GMTDFleetEngineIDStringtrackingID
 The tracking ID for the task.
NSString * parentID
 The tracking ID for the task.
GMTSTaskType taskType
 The type of the task.
GMTSTaskState taskState
 The state of the task.
NSTimeInterval taskDuration
 The expected duration of the task in seconds.
GMSNavigationWaypoint * plannedWaypoint
 Optional waypoint where the task will be performed.

Member Function Documentation

- (instancetype) initWithTaskID: (GMTDFleetEngineIDString *)  taskID
trackingID: (nullable GMTDFleetEngineIDString *)  trackingID
taskType: (GMTSTaskType taskType
taskState: (GMTSTaskState taskState
taskDuration: (NSTimeInterval)  taskDuration
plannedWaypoint: (nullable GMSNavigationWaypoint *)  plannedWaypoint 

Initializes and returns a GMTDCreateDeliveryTaskRequest object using the provided attributes.

Parameters:
taskIDThe ID of the task.
trackingIDAn abitrary ID the client may find useful in tracking the task.
taskTypeThe type of this task.
taskStateThe state of this task.
taskDurationThe expected duration of this task in seconds.
plannedWaypointThe location where this task will be performed.

Property Documentation

- (GMTDFleetEngineIDString*) taskID [read, assign]

Use initWithTaskID:trackingID:taskType:taskState:taskDuration:plannedWaypoint: instead.

The ID of the task.

- (GMTDFleetEngineIDString*) trackingID [read, assign]

The tracking ID for the task.

- (NSString*) parentID [read, assign]

The tracking ID for the task.

Note:
This property is obsolete and will be removed in a future release. Use the trackingID property instead.
- (GMTSTaskType) taskType [read, assign]

The type of the task.

- (GMTSTaskState) taskState [read, assign]

The state of the task.

- (NSTimeInterval) taskDuration [read, assign]

The expected duration of the task in seconds.

- (GMSNavigationWaypoint*) plannedWaypoint [read, assign]

Optional waypoint where the task will be performed.