← Dynamic content

Content.cancelUpload

luastra/content
Content.cancelUpload(requestId: number): number

Requests cancellation of one active host upload by its request ID. The cancellation request and the original transfer each complete through resolve, so both results remain explicitly correlated.

Before you use it

Add luastra/content to this module's dependencies in luastra.json, then import it with require("luastra/content"). Declare content.pick for browser selection and content.upload for transfer. Upload requires a server-created intent from an authenticated declared backend function. Application code must never construct a provider URL, file path, data URL, blob URL, bucket path, or upload handle.

How it fits

Image construction and decoders are synchronous. Selection, release, upload, and cancellation return request IDs and complete through application/app resolve; progress enters application/app handle as content_progress.

When to use it

Use Content.cancelUpload while the matching upload is active when the user leaves or presses Cancel, then handle the original request's CANCELLED failure without treating it as a server commit.

Parameters

ParameterType / valuesDescription
requestIdnumberActive Content.upload request identifier.

Returns

number — the exact number value declared by the SDK contract.

What happens next

A bounded image lifecycle that keeps local files and provider credentials outside Luau while reusing UI.Image.

Failures and fixes

Cancellation, malformed or expired handles, unsupported media types, excessive bytes or dimensions, offline transfer, authorization denial, and decode failure remain explicit branches. Release previews, request fresh display grants after UI.Image.onError, and never persist or log upload/content handles.

Availability

Private source foundation after 0.5.0-alpha; browser PNG/JPEG selection and upload are automated, while camera and native picker certification remain later evidence gates.

Focused example

local cancelRequestId = Content.cancelUpload(uploadRequestId)

Complete inventory

View all pages in Dynamic content
← Previous: Content.uploadNext: Content.decodeUpload →