davinci/com.pingidentity.davinci.collector/ImageCollector

ImageCollector

class ImageCollector : Collector<Nothing> (source)

A display-only Collector that surfaces an image in a DaVinci authentication flow. It carries no user input — id returns key and the collector never contributes a value to the form submission.

{
    "type": "IMAGE",
    "key": "heroImage",
    "description": "Alt text",
    "imageUrl": "https://cdn.example.com/image.png",
    "hyperlinkUrl": "https://example.com/install"
}

Constructors

constructor()

Properties

var description: String

Accessibility / alt text for the image.

var hyperlinkUrl: String?

Optional URL to open when the image is tapped. null when not provided.

var imageUrl: String

URL of the image to display.

var key: String

Unique field identifier within the form.

Functions

open override fun id(): String

open override fun init(input: JsonObject): ImageCollector

fun JsonObject.stringOrNull(field: String): String?

Helper function to safely extract a string from a JsonObject by key, returning null if the key is absent or not a string.