CloseJobOptions Class

Definition

Request payload for closing jobs.

public class CloseJobOptions
public class CloseJobOptions : System.ClientModel.Primitives.IJsonModel<Azure.Communication.JobRouter.CloseJobOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.Communication.JobRouter.CloseJobOptions>
type CloseJobOptions = class
type CloseJobOptions = class
    interface IJsonModel<CloseJobOptions>
    interface IPersistableModel<CloseJobOptions>
Public Class CloseJobOptions
Public Class CloseJobOptions
Implements IJsonModel(Of CloseJobOptions), IPersistableModel(Of CloseJobOptions)
Inheritance
CloseJobOptions
Implements

Constructors

CloseJobOptions(String, String)

Public constructor.

Properties

AssignmentId

Id of a job assignment.

CloseAt

If not provided, worker capacity is released immediately along with a JobClosedEvent notification. If provided, worker capacity is released along with a JobClosedEvent notification at a future time in UTC.

DispositionCode

Indicates the outcome of a job, populate this field with your own custom values.

JobId

Id of a job.

Note

A note that will be appended to a job's Notes collection with the current timestamp.

Explicit Interface Implementations

IJsonModel<CloseJobOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CloseJobOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CloseJobOptions>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CloseJobOptions>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CloseJobOptions>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to