ping-identity
    Preparing search index...

    Type Alias QRCodeCollector

    Display-only QR code collector — renders a scannable code for out-of-band authentication (e.g. push registration, cross-device sign-in).

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

    Does not participate in form submission — native payload() always returns nil/null on both platforms.

    key is empty ("") when the server omits it. Requires native SDK 2.2.0 or later on Android; earlier Android versions do not parse key and emit "".

    type QRCodeCollector = {
        content: string;
        fallbackText: string;
        key: string;
        raw?: Record<string, unknown>;
        type: "QR_CODE";
    }
    Index

    Properties

    content: string

    Full data URI of the QR code image (e.g. "data:image/png;base64,...").

    Both platforms return the data URI exactly as received from the server, including its MIME type. Requires native SDK 2.2.0 or later on iOS; earlier iOS versions stripped the "data:...base64," prefix.

    fallbackText: string

    Alternative text to display when the QR code cannot be rendered or scanned.

    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.

    type: "QR_CODE"