mosaic-server/dev.catbit.mosaic.server.builder.event.builders.image/GetImageFromGallery

GetImageFromGallery

fun EventSchemaBuilderScope.GetImageFromGallery(id: String = randomId(), trigger: EventTrigger, compression: CompressionScheme? = null, resize: ImageResizeOptions? = null, outputType: GetImageFromGalleryEventSchema.OutputType = galleryArrayOfBytes(), events: EventSchemaBuilderScope.() -> Unit = {})

Opens the platform picker restricted to images and emits the chosen image downstream, on the IO dispatcher. When compression is set the bytes are re-encoded to WebP through byQuality/byTargetSize, with resize applied in the same pass (the compressor's own defaults are used when resize is null); when compression is null the original bytes are emitted untouched and resize has no effect. Does not consume incomingData. Dispatches onSuccess (carrying the image, shaped by outputType) when an image was picked and processed; onCancelled (no data) when the user dismisses the picker without choosing an image; onFailure (carrying the thrown exception) when reading or compressing throws.

Parameters

Unique identifier of this event. Defaults to a random id.

trigger

Trigger that fires this event, built via EventTriggers.

compression

Re-encoding applied to the picked image, built with byQuality or byTargetSize. Defaults to none (original bytes, resize has no effect).

resize

Resize applied alongside compression; only takes effect when compression is non-null. Defaults to none (compressor's own defaults).

outputType

Shape of the image delivered as incomingData — galleryArrayOfBytes or galleryBase64. Defaults to raw bytes.

events

Child events chained after this one, wired to its triggers (onSuccess, onCancelled, onFailure).