pingonemfa/com.pingidentity.pingonemfa.davinci/MobilePairingCollector/cancel

cancel

fun cancel(message: String = "User canceled the pairing flow")

Records a user-initiated cancellation and stores the corresponding error envelope so it can be posted back to DaVinci via payload.

Stores { "error": { "code": "USER_CANCELLED", "message": [message] } } under payload.

Note: this does not cancel any in-flight collect call — the native PingOne MFA SDK has no abort API. If collect is currently awaiting a pairing result, its outcome will be discarded when it resumes so the user-canceled payload is preserved.

Parameters

message

A human-readable description of the cancellation reason. Defaults to "User canceled the pairing flow".