0.0.0

davinci/com.pingidentity.davinci.collector/ReadOnlyTextCollector

ReadOnlyTextCollector

class ReadOnlyTextCollector : Collector<Nothing>

Class representing a READ_ONLY_TEXT type collector.

This class handles the response from a DaVinci form field of type READ_ONLY_TEXT (inputType). It displays read-only text content such as agreement/terms-of-service text.

Example JSON:

{
  "type": "AGREEMENT",
  "inputType": "READ_ONLY_TEXT",
  "key": "agreement",
  "content": "This is example agreement text...",
  "titleEnabled": true,
  "title": "Terms of Service Agreement",
  "agreement": {
    "id": "6ff30c9e-cd98-4fe5-85ca-01111ca20702",
    "useDynamicAgreement": false
  },
  "enabled": true
}

Constructors

ReadOnlyTextCollector

constructor()

Creates a new ReadOnlyTextCollector.

Properties

var agreementId: String

The unique ID of the agreement definition.

var content: String

The text content to display to the user.

var enabled: Boolean

Whether this collector is enabled.

var key: String

The key identifier for this collector, used as the form field key during submission.

var title: String

The title (shown when titleEnabled is true).

var titleEnabled: Boolean

Whether to display the title above the content.

var type: String

The type of this collector (e.g., "AGREEMENT").

useDynamicAgreement

var useDynamicAgreement: Boolean

Whether the agreement content is loaded dynamically.

Functions

open override fun id(): String

open override fun init(input: JsonObject): ReadOnlyTextCollector