v0.2.6-alpha.3

Kotlin: Retry an attachment

attachmentRetry(reference) forgives a permanently failed attachment's transfer budget: the row returns to queued with its attempt count cleared, so the next drive claims it again.

Examples#

Basic#

// app/src/main/kotlin/com/example/todo/TodoScreen.kt (excerpt)
val retried = kizunasync.attachmentRetry(reference)

Offer retry only on a permanent failure#

// app/src/main/kotlin/com/example/todo/TodoScreen.kt (excerpt)
val status = kizunasync.getStatus(reference)
if (status?.permanent == true) {
    kizunasync.attachmentRetry(reference)
}

Parameters#

Name	Type	Required	Description
`reference`	`String`	Yes	The value stored in the row's attachment column, as Attach a file produced it.

Returns#

Boolean. true when a row carried the reference, false when none did.

Errors#

Code	Condition
`STORE`	The row could not be written.
`ENGINE_UNAVAILABLE`	The bridge answered with an envelope carrying no code, which is not a gradeable failure.
`ENGINE_UNAVAILABLE`	The client has no engine because Initializing has not run.

Notes#

Retrying clears every trace of the spent budget: state returns to queued, permanent to false, and the attempt count to zero, so the row reads exactly like one that has never been driven. It does nothing to a row that is merely failed and still retryable; the next scheduled drive already claims that one on its own. Reach for this only after the budget is spent, which Get attachment status reports as permanent: true; that budget is attachmentAttempts in Initializing, five attempts by default.

This method reaches the kernel through the same JSON-RPC call every typed method uses underneath; it behaves like any other client method and raises the same KizunaSyncError.Engine.

← Watch an attachment Cancel an attachment →

Found a problem? Edit this page on GitHub