Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TaskAddResult

Package version

An interface representing TaskAddResult.

summary

Result for a single task added as part of an add task collection operation.

Hierarchy

  • TaskAddResult

Index

Properties

Optional eTag

eTag: undefined | string

The ETag of the task, if the task was successfully added. You can use this to detect whether the task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the job in the meantime.

Optional error

error: BatchError

The error encountered while attempting to add the task.

Optional lastModified

lastModified: Date

The last modified time of the task.

Optional location

location: undefined | string

The URL of the task, if the task was successfully added.

status

The status of the add task request. Possible values include: 'success', 'clientError', 'serverError'

taskId

taskId: string

The ID of the task for which this is the result.

Generated using TypeDoc