davinci/com.pingidentity.davinci.collector/MetadataCollector

MetadataCollector

class MetadataCollector : FieldCollector<JsonObject> , Submittable, Closeable(source)

Collector for a DaVinci form field of type METADATA.

When a DaVinci flow reaches an SDK Integrator connector node, the server pauses and returns a form field of type METADATA carrying an arbitrary JSON payload. The integrating app reads metadata, performs on-device work, then calls either setResult (success path) or setError (failure path) before calling com.pingidentity.orchestrate.ContinueNode.next.

The collector is considered ready to submit once either setResult or setError has been called — validate returns a Required error until then.

Constructors

MetadataCollector

constructor()

Properties

var metadata: JsonObject

The metadata payload sent by the server — arbitrary JSON the SDK must process.

Functions

open override fun close()

Clears the result, returning the collector to its initial unset state.

open override fun eventType(): String

Always "action" — required by the SDK Integrator connector resume contract.

open override fun init(input: JsonObject): MetadataCollector

Function to initialize the field collector.

open override fun payload(): JsonObject?

Returns the resume payload, or null if neither setResult nor setError has been called.

fun setError(errorCode: String, message: String)

Signals the connector's client-error branch.

fun setResult(result: JsonObject)

Sets the result to POST back to DaVinci on the success path.

open override fun validate(): List<ValidationError>

Returns Required until setResult or setError has been called, regardless of the field's required flag.