forgerock-auth

4.4.0

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

MetadataCallback

open class MetadataCallback : AbstractCallback, DerivableCallback

A callback that allows some extra metadata to be sent in the response.

When serialized as JSON in an authenticate response, the value object will be the value of a single data output value, so for a value of { "foo": "bar" }, this would be output as:


{
    "authId": "...",
    "callbacks": [
        // ...
        {
            "type": "MetadataCallback",
            "output": [
                {
                    "name": "data",
                    "value": {
                        "foo": "bar"
                    }
                }
            ]
        }
    ]
}

Inheritors

WebAuthnAuthenticationCallback

WebAuthnRegistrationCallback

Constructors

MetadataCallback

constructor()

constructor(jsonObject: JSONObject, index: Int)

Properties

protected open var _id: Int

protected open var content: String

protected val VALUE: String = "value"

private open var value: String

Functions

open fun get_id(): Int

Get the _id received from server

open fun getContent(): String

Get the callback content

getContentAsJson

protected open fun getContentAsJson(): JSONObject

getDerivedCallback

open fun getDerivedCallback(): Class<out Callback>

Retrieve the derived callback class, return null if no derive callback found.

open fun getInputValue(): Any

Get the first value for input

open fun getInputValue(index: Int): Any

Get the value for input

protected open fun getName(jsonObject: JSONObject): String

open fun getType(): String

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

open fun getValue(): JSONObject

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

protected open fun setContent(jsonObject: JSONObject)

Sets the value of the Callback

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.