taskbridge-core/io.github.nikkiw.taskbridge.model

Package-level declarations

Types

@Serializable

data class ActionAcceptedPayload(val suspendId: String, val clientActionId: String, val actionType: String, val acceptedAt: String, val message: String? = null)

Details about an accepted user action.

CancelTaskBody

@Serializable

data class CancelTaskBody(val reason: String? = null)

Request body for cancelling a task.

CancelTaskResponse

@Serializable

data class CancelTaskResponse(val taskId: String, val status: CancelTaskStatus)

Response from a task cancellation request.

CancelTaskStatus

@Serializable

enum CancelTaskStatus : Enum<CancelTaskStatus>

Status of a cancellation request.

KnownTaskEvent

sealed interface KnownTaskEvent : TaskEvent

Interface for task events with a known TaskEventType.

PollEventsResponse

@Serializable

data class PollEventsResponse(val taskId: String, val events: List<RawTaskEventEnvelope>, val nextAfterEventId: String? = null, val hasMore: Boolean, var rawJson: String? = null)

Response from a long-polling event request.

RawTaskEventEnvelope

@Serializable

data class RawTaskEventEnvelope(val type: String, val taskId: String, val eventId: String, val createdAt: String, val payload: JsonObject = JsonObject(emptyMap()))

Raw JSON envelope for events as received from the server.

SubmitActionResponse

@Serializable

data class SubmitActionResponse(val taskId: String, val suspendId: String, val clientActionId: String, val status: SubmitActionStatus)

Response from an action submission request.

SubmitActionStatus

@Serializable

enum SubmitActionStatus : Enum<SubmitActionStatus>

Status of an action submission.

SuspensionPayload

@Serializable

data class SuspensionPayload(val suspendId: String, val kind: TaskSuspensionKind, val reasonCode: String, val allowedActions: List<String>, val schemaVersion: Int, val expiresAt: String? = null, val uiHints: JsonObject = JsonObject(emptyMap()), val interaction: JsonObject = JsonObject(emptyMap()))

Details about a task suspension waiting for user interaction.

TaskActionAcceptedEvent

data class TaskActionAcceptedEvent(val taskId: String, val eventId: String, val createdAt: String, val payload: JsonObject = JsonObject(emptyMap()), val accepted: ActionAcceptedPayload) : KnownTaskEvent

Emitted when a user action has been successfully processed.

TaskActionRequest

@Serializable

data class TaskActionRequest(val clientActionId: String, val suspendId: String, val actionType: String, val payload: JsonObject = JsonObject(emptyMap()), val metadata: JsonObject = JsonObject(emptyMap()))

Request to submit a user action for a suspended task.

TaskBridgeMultipartAttachment

data class TaskBridgeMultipartAttachment(val fieldName: String = "attachments", val fileName: String, val contentType: String = "application/octet-stream", val content: ByteArray)

Represents a file attachment for a multipart task creation request.

TaskCancelledEvent

data class TaskCancelledEvent(val taskId: String, val eventId: String, val createdAt: String, val payload: JsonObject = JsonObject(emptyMap())) : KnownTaskEvent

Emitted when the task is cancelled.

TaskCompletedEvent

data class TaskCompletedEvent(val taskId: String, val eventId: String, val createdAt: String, val payload: JsonObject = JsonObject(emptyMap())) : KnownTaskEvent

Emitted when the task completes successfully.

TaskCreatedResponse

@Serializable

data class TaskCreatedResponse(val taskId: String, val status: TaskStatus, val clientRequestId: String, val deduplicated: Boolean = false)

Response from the server after a task is created.

TaskCreateJsonRequest

@Serializable

data class TaskCreateJsonRequest(val clientRequestId: String, val taskType: String, val input: JsonObject = JsonObject(emptyMap()), val metadata: JsonObject = JsonObject(emptyMap()))

Request body for starting a new task with JSON input.

TaskEvent

sealed interface TaskEvent

Base interface for all task events.

TaskEventType

@Serializable

enum TaskEventType : Enum<TaskEventType>

Types of events that can be emitted during a task lifecycle.

TaskFailedEvent

data class TaskFailedEvent(val taskId: String, val eventId: String, val createdAt: String, val payload: JsonObject = JsonObject(emptyMap())) : KnownTaskEvent

Emitted when the task fails with an error.

TaskFailedPayload

@Serializable

data class TaskFailedPayload(val code: String, val message: String, val retryable: Boolean)

Structured payload for TASK_FAILED events.

TaskMessageEvent

data class TaskMessageEvent(val taskId: String, val eventId: String, val createdAt: String, val payload: JsonObject = JsonObject(emptyMap())) : KnownTaskEvent

Emitted for general information or logging.

TaskProgressEvent

data class TaskProgressEvent(val taskId: String, val eventId: String, val createdAt: String, val payload: JsonObject = JsonObject(emptyMap())) : KnownTaskEvent

Emitted to provide updates on task progress.

TaskProgressPayload

@Serializable

data class TaskProgressPayload(val progress: Float, val stage: String? = null, val message: String? = null)

Structured payload for TASK_PROGRESS events.

TaskStartedEvent

data class TaskStartedEvent(val taskId: String, val eventId: String, val createdAt: String, val payload: JsonObject = JsonObject(emptyMap())) : KnownTaskEvent

Emitted when the task starts execution.

TaskStatus

@Serializable

enum TaskStatus : Enum<TaskStatus>

Overall status of a task.

TaskSuspendedEvent

data class TaskSuspendedEvent(val taskId: String, val eventId: String, val createdAt: String, val payload: JsonObject = JsonObject(emptyMap()), val suspension: SuspensionPayload) : KnownTaskEvent

Emitted when the task enters a suspended state.

TaskSuspensionKind

@Serializable

enum TaskSuspensionKind : Enum<TaskSuspensionKind>

Categories of task suspensions as defined in the protocol.

UnknownTaskEvent

data class UnknownTaskEvent(val wireType: String, val taskId: String, val eventId: String, val createdAt: String, val payload: JsonObject = JsonObject(emptyMap())) : TaskEvent

Represents an event with an unknown or unmapped wireType.

Functions

asFailure

fun TaskEvent.asFailure(): TaskFailedPayload?

Tries to parse the payload as TaskFailedPayload if the event type matches.

asProgress

fun TaskEvent.asProgress(): TaskProgressPayload?

Tries to parse the payload as TaskProgressPayload if the event type matches.

isTerminal

fun TaskEvent.isTerminal(): Boolean

Returns true if this event indicates the final state of the task.

toTaskEvent

fun RawTaskEventEnvelope.toTaskEvent(): TaskEvent

Converts a RawTaskEventEnvelope to a typed TaskEvent.