STRUCT
RedirectionStep
Contents
- Properties
redirectActionmetadataactionspropertieslinksmessagestype
- Methods
init(from:)encode(to:)==(_:_:)
public struct RedirectionStep: HaapiRepresentation, Equatable
A Redirection Step is used to inform the client it should automatically redirect the user.
The step contains a single action requiring no user interaction.
- Note:
HaapiManagercan be configured to automatically follow redirection steps, in which case a client won't get instances of this class.
Properties
redirectAction
public let redirectAction: FormAction
The redirect action.
metadata
public let metadata: Metadata?
actions
public let actions: [Action]
Possible actions a user or the client may choose to take to continue the flow.
properties
public let properties: Properties?
links
public let links: [Link] = []
messages
public let messages: [UserMessage] = []
type
public let type: RepresentationType = .redirectionStep
Methods
init(from:)
public init(from decoder: Decoder) throws
Parameters
| Name | Description |
|---|---|
| decoder | The decoder to read data from. |
encode(to:)
public func encode(to encoder: Encoder) throws
Parameters
| Name | Description |
|---|---|
| encoder | The encoder to write data to. |
==(::)
public static func == (lhs: RedirectionStep, rhs: RedirectionStep) -> Bool
Parameters
| Name | Description |
|---|---|
| lhs | A value to compare. |
| rhs | Another value to compare. |