ping-identity
    Preparing search index...

    Type Alias ReadOnlyTextCollector

    Read-only text / agreement collector.

    Corresponds to the native READ_ONLY_TEXT inputType. The server type field may vary (e.g. "AGREEMENT") — the bridge normalizes it to 'READ_ONLY_TEXT' for a stable discriminant.

    Does not extend BaseCollector — ReadOnlyTextCollector does not implement FieldCollector in the native SDK and therefore has no label, required, or value. Has no mutable value and contributes no payload to form submission.

    type ReadOnlyTextCollector = {
        agreementId: string;
        content: string;
        enabled: boolean;
        key: string;
        raw?: Record<string, unknown>;
        title: string;
        titleEnabled: boolean;
        type: "READ_ONLY_TEXT";
        useDynamicAgreement: boolean;
    }
    Index

    Properties

    agreementId content enabled key raw? title titleEnabled type useDynamicAgreement

    Properties

    agreementId: string

    UUID of the agreement definition.

    content

    content: string

    The text content to display to the user.

    enabled: boolean

    Whether this collector is active.

    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.

    title: string

    Title shown when titleEnabled is true.

    titleEnabled: boolean

    Whether to display the title above the content.

    type: "READ_ONLY_TEXT"

    Normalized type discriminant — always 'READ_ONLY_TEXT' regardless of server type.

    useDynamicAgreement: boolean

    Whether the agreement content is loaded dynamically.

    Settings

    Member Visibility

    On This Page

    Properties