STRUCT
EncapClientOperationStep
Contents
- Properties
actionModelmetadatatypeactionslinksmessagespropertiesurlToLaunchcontinueActionserrorActions
- Methods
init(from:)encode(to:)==(_:_:)
public struct EncapClientOperationStep: ClientOperationStep, Equatable
A step that instructs a client that it should use the Encap non-interactive device activation flow.
This can only be used when the client requesting authentication also implements the Encap client using the Encap SDK. For more information, refer to the HAAPI Data Model documentation
Properties
actionModel
public let actionModel: EncapAutoActivationClientOperationActionModel
The Encap action details.
metadata
public let metadata: Metadata?
type
public let type: RepresentationType
actions
public let actions: [Action]
An array of Action that contains possible actions a user or the client may choose to take to continue the flow.
links
public let links: [Link]
messages
public let messages: [UserMessage]
properties
public let properties: Properties?
urlToLaunch
public var urlToLaunch: URL?
Returns the URL that should be used to open the Encap application.
continueActions
public var continueActions: [Action]
Returns the actions that should be displayed when uriToLaunch was used successfully.
errorActions
public var errorActions: [Action]
Returns the actions that should be displayed when uriToLaunch failed to launch.
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: EncapClientOperationStep, rhs: EncapClientOperationStep) -> Bool
Parameters
| Name | Description |
|---|---|
| lhs | A value to compare. |
| rhs | Another value to compare. |