ConfirmationCallback

@objc(FRConfirmationCallback)
public class ConfirmationCallback : Callback

ConfirmationCallback is a representation of ConfirmationCallback in OpenAM to ask user for YES/NO, OK/CANCEL, YES/NO/CANCEL or other similar confirmations.

Property

  • An array of string for available option(s)

    Declaration

    Swift

    @objc
public var options: [String]?

  • Default option

    Declaration

    Swift

    @objc
public var defaultOption: Int

  • Confirmation Option enum; defaulted to .unknown when the value is not provided

    Declaration

    Swift

    @objc
public var option: Option

  • Confirmation OptionType enum; defaulted to .unknown when the value is not provided

    Declaration

    Swift

    @objc
public var optionType: OptionType

  • Confirmation MessageType enum; defaulted to .unknown when the value is not provided

    Declaration

    Swift

    @objc
public var messageType: MessageType

  • String value of inputName attribute in Callback response

    Declaration

    Swift

    @objc
public var inputName: String?

  • 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?

  • A value provided from user interaction for this particular callback; the value can be any type

    Declaration

    Swift

    @objc
public var value: Any?
  • _id

    Unique identifier for this particular callback in Node

    Declaration

    Swift

    public var _id: Int?

Build

  • Builds JSON request payload for the Callback

    Declaration

    Swift

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

    Return Value

    JSON request payload for the Callback