Package 

Class MetadataCallback

  • All Implemented Interfaces:
    java.io.Serializable , org.forgerock.android.auth.callback.Callback , org.forgerock.android.auth.callback.DerivableCallback 
    
public class MetadataCallback
extends AbstractCallback implements 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"
                    }
                }
            ]
        }
    ]
}

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      JSONObject getValue()
      String getType() Return the type of the Callback, the type name should align with the Callback type returned from AM
      Class<out Callback> getDerivedCallback() Retrieve the derived callback class, return null if no derive callback found.

      • Methods inherited from class org.forgerock.android.auth.callback.AbstractCallback

        getContent, getInputValue, getInputValue, get_id

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MetadataCallback

        MetadataCallback()

      • MetadataCallback

        MetadataCallback(JSONObject jsonObject, int index)