MultipleValuesCallback

@objc(FRMultipleValuesCallback)
open class MultipleValuesCallback : Callback

MultipleValuesCallback is a base Callback implementation that has one or more user input values. Any Callback that accepts multiple values from user interaction without OpenAM’s validation with policies may inherit from this class.

Property

  • An array of inputName values

    Declaration

    Swift

    @objc
    public var inputNames: [String]
  • An array of input values

    Declaration

    Swift

    @objc
    public var inputValues: [String : Any]
  • String value of prompt attribute in Callback response; prompt is usually human readable text that can be displayed in UI

    Declaration

    Swift

    @objc
    public var prompt: String?
  • _id

    Unique identifier for this particular callback in Node

    Declaration

    Swift

    public var _id: Int?

Init

  • Designated initialization method for MultipleValuesCallback

    Note

    Any Callback inherits from this class may override init method to define any additional instance property value.

    Throws

    AuthError.invalidCallbackResponse for invalid callback response

    Declaration

    Swift

    public required init(json: [String : Any]) throws

    Parameters

    json

    JSON object of MultipleValuesCallback

Build

  • Builds JSON request payload for the Callback

    Note

    Any Callback inherits from this class may override buildResponse() method to construct the payload with any additional input value.

    Declaration

    Swift

    open override func buildResponse() -> [String : Any]

    Return Value

    JSON request payload for the Callback