Interface TaskStatusUpdateEvent

Sent by server during sendStream or subscribe requests

This interface was referenced by MySchema's JSON-Schema via the definition "TaskStatusUpdateEvent".

interface TaskStatusUpdateEvent {
    contextId: string;
    final: boolean;
    kind: "status-update";
    metadata?: {
        [k: string]: unknown;
    };
    status: TaskStatus1;
    taskId: string;
}

Properties

contextId final kind metadata? status taskId

Properties

contextId

contextId: string

The context the task is associated with

final

final: boolean

Indicates the end of the event stream

kind

kind: "status-update"

Event type

Optional metadata

metadata?: {
    [k: string]: unknown;
}

Extension metadata.

Type declaration

  • [k: string]: unknown

status

status: TaskStatus1

taskId

taskId: string

Task id

Settings

Member Visibility

Theme

On This Page

contextIdfinalkindmetadatastatustaskId