forgerock-auth

4.4.0

forgerock-auth/org.forgerock.android.auth.callback/AbstractValidatedCallback

AbstractValidatedCallback

abstract class AbstractValidatedCallback : AbstractCallback

Callbacks that accept user input often need to validate that input either on the client side, the server side or both. Such callbacks should extend this base class.

Inheritors

ValidatedPasswordCallback

ValidatedUsernameCallback

AttributeInputCallback

Constructors

AbstractValidatedCallback

constructor(jsonObject: JSONObject, index: Int)

Types

FailedPolicy

open class FailedPolicy : Serializable

Properties

_id

protected open var _id: Int

content

protected open var content: String

failedPolicies

private open var failedPolicies: List<AbstractValidatedCallback.FailedPolicy>

Return the list of failed policies for this callback.

policies

private open var policies: String

Return the validation policies that should be applied to the input collected by this callback.

validateOnly

private open var validateOnly: Boolean

VALUE

protected val VALUE: String = "value"

Functions

get_id

open fun get_id(): Int

Get the _id received from server

getContent

open fun getContent(): String

Get the callback content

getContentAsJson

protected open fun getContentAsJson(): JSONObject

getInputValue

open fun getInputValue(): Any

Get the first value for input

open fun getInputValue(index: Int): Any

Get the value for input

getName

protected open fun getName(jsonObject: JSONObject): String

getPolicies

open fun getPolicies(): JSONObject

getPrompt

abstract fun getPrompt(): String

getType

abstract fun getType(): String

Return the type of the Callback, the type name should align with the Callback type returned from AM

prepareFailedPolicy

private open fun prepareFailedPolicy(array: JSONArray)

setAttribute

protected open fun setAttribute(name: String, value: Any)

setContent

protected open fun setContent(jsonObject: JSONObject)

Sets the value of the Callback

setValidateOnly

open fun setValidateOnly(validateOnly: Boolean)

setValue

protected open fun setValue(value: Any)

Set the first value for input

protected open fun setValue(value: Any, index: Int)

Set the value for the input.