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

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.

Constructors

Link copied to clipboard
constructor(suspendId: String, kind: TaskSuspensionKind, reasonCode: String, allowedActions: List<String>, schemaVersion: Int, expiresAt: String? = null, uiHints: JsonObject = JsonObject(emptyMap()), interaction: JsonObject = JsonObject(emptyMap()))

Properties

Link copied to clipboard
val allowedActions: List<String>

List of action types the user can submit to resume.

Link copied to clipboard
val expiresAt: String?

Optional ISO 8601 timestamp when this suspension expires.

Link copied to clipboard
val interaction: JsonObject

Data required for the specific interaction.

Link copied to clipboard
val kind: TaskSuspensionKind

The category of interaction required (e.g., "form", "approval").

Link copied to clipboard
val reasonCode: String

Machine-readable code explaining why the task suspended.

Link copied to clipboard
val schemaVersion: Int

Version of the payload/interaction schema.

Link copied to clipboard
val suspendId: String

Unique ID for this suspension instance.

Link copied to clipboard
val uiHints: JsonObject

Hints for the UI layer on how to render this suspension.

Generated by Dokka
© 2026 Copyright