STRUCT
GenericRepresentationStep
Contents
- Properties
actions
messages
metadata
links
properties
rawJsonString
type
- Methods
init(from:)
encode(to:)
==(_:_:)
public struct GenericRepresentationStep: HaapiRepresentation
A generic step occurs when the HAAPI representation did not match any of the modelled steps.
With this step, the client is free to use the content defined by HaapiRepresentation
to move forward or interrupt the flow.
Properties
actions
public let actions: [Action]
Possible actions a user or the client may choose to take to continue the flow.
messages
public let messages: [UserMessage]
metadata
public let metadata: Metadata?
links
public let links: [Link]
properties
public let properties: (any Properties)?
rawJsonString
public let rawJsonString: String?
type
public let type: RepresentationType
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: GenericRepresentationStep, rhs: GenericRepresentationStep) -> Bool
Parameters
Name | Description |
---|---|
lhs | A value to compare. |
rhs | Another value to compare. |