ping-identity
    Preparing search index...

    Type Alias ImageCollector

    Display-only image collector — surfaces an image in a DaVinci form.

    Does not extend BaseCollector — like QRCodeCollector, the native ImageCollector (Android: Collector<Nothing>; iOS: Collector) does not implement FieldCollector and therefore has no label, required, or mutable value.

    Does not participate in form submission — native payload() always returns nil/null on both platforms, and the submit helper excludes it via its output_only execution mode.

    Field names, optionality, and defaults mirror the native 2.2 ImageCollector exactly (iOS Davinci/Davinci/collector/ImageCollector.swift, Android davinci/src/main/kotlin/com/pingidentity/davinci/collector/ImageCollector.kt): key, imageUrl, and description default to "" when the server omits them; hyperlinkUrl is absent when the server omits it. The SDK never downloads, caches, renders, or opens these URLs — the app renders the image and handles the hyperlink itself.

    type ImageCollector = {
        description: string;
        hyperlinkUrl?: string;
        imageUrl: string;
        key: string;
        raw?: Record<string, unknown>;
        type: "IMAGE";
    }
    Index

    Properties

    description hyperlinkUrl? imageUrl key raw? type

    Properties

    description: string

    Description / alt text for the image.

    hyperlinkUrl?: string

    Optional hyperlink URL associated with the image.

    Omitted from the bridge payload when the server does not send hyperlinkUrl (native default nil/null).

    imageUrl: string

    URL of the image to display (surfaced as received, no transformation).

    key: string

    Unique collector key identifying this field in the form.

    raw?: Record<string, unknown>

    Raw server-side field JSON from node.input.form.components.fields[].

    Populated by the native mapper via the shared raw lookup (both platforms' native ImageCollector.id returns the stable key).

    type: "IMAGE"

    Settings

    Member Visibility

    On This Page

    Properties