ENUM

HaapiModel.PropertiesFactory

Contents

• Methods
  • generic(rawJsonString:)
  • polling(rawJsonString:recipientOfCommunication:status:)
  • oAuthAuthorizationResponse(rawJsonString:scope:state:code:idToken:rawJson:)
  • formAction(authenticatorType:rawJsonString:)
  • selectorAction(rawJsonString:)
  • clientOperation(rawJsonString:)

enum PropertiesFactory

Provides functionality to build instances of Properties.

Methods

generic(rawJsonString:)

public static func generic(rawJsonString: String) -> GenericProperties

Creates an instance of GenericProperties model.

• Parameters:

  • rawJsonString: The raw properties from the representation.

• Returns: A built instance of GenericProperties.

Parameters

polling(rawJsonString:recipientOfCommunication:status:)

public static func polling(rawJsonString: String,
                           recipientOfCommunication: String?,
                           status: PollingStatus) -> PollingProperties

Creates an instance of PollingProperties model.

• Parameters:

  • rawJsonString: The raw properties from the representation.
  • recipientOfCommunication: The subject who is expected to perform some actions while the client polls waiting for such action.
  • status: The current status of the polling process.

• Returns: A built instance of PollingProperties.

Parameters

oAuthAuthorizationResponse(rawJsonString:scope:state:code:idToken:rawJson:)

public static func oAuthAuthorizationResponse(rawJsonString: String,
                                              scope: String?,
                                              state: String?,
                                              code: String?,
                                              idToken: String?,
                                              rawJson: [String: String]) -> OAuthAuthorizationResponseProperties // swiftlint:disable:this line_length

Creates an instance of OAuthAuthorizationResponseProperties model.

• Parameters:

  • rawJsonString: The raw properties from the representation.
  • scope: The resulting scope.
  • state: The state parameter provided by the client.
  • code: The authorization code.
  • idToken: The ID token.
  • rawJson: The original JSON value of OAuth Authorization Response itself.

• Returns: A built instance of OAuthAuthorizationResponseProperties.

Parameters

formAction(authenticatorType:rawJsonString:)

public static func formAction(authenticatorType: String, rawJsonString: String) -> FormAction.Properties

Creates an instance of FormAction.Properties model.

• Parameters:

  • authenticatorType: The type of the authenticator to which this action is related.
  • rawJsonString: The raw properties from the representation.

• Returns: A built instance of FormAction.Properties.

Parameters

selectorAction(rawJsonString:)

public static func selectorAction(rawJsonString: String) -> SelectorAction.Properties

Creates an instance of SelectorAction.Properties model.

• Parameters:

  • rawJsonString: The raw properties from the representation.

• Returns: A built instance of SelectorAction.Properties.

Parameters

clientOperation(rawJsonString:)

public static func clientOperation(rawJsonString: String) -> ClientOperationAction.Properties

Creates an instance of ClientOperationAction.Properties model.

• Parameters:

  • rawJsonString: The raw properties from the representation.

• Returns: A built instance of ClientOperationAction.Properties.

Parameters