STRUCT

EncapClientOperationStep

Contents

• Properties
  • actionModel
  • actions
  • metadata
  • messages
  • links
  • properties
  • rawJsonString
  • type
  • urlToLaunch
  • continueActions
  • errorActions
• Methods
  • init(from:)
  • encode(to:)
  • ==(_:_:)

public struct EncapClientOperationStep: ClientOperationStep

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.

actions

public let actions: [any Action]

An array of Action that contains possible actions a user or the client may choose to take to continue the flow.

metadata

public let metadata: Metadata?

messages

public let messages: [UserMessage]

links

public let links: [Link]

properties

public let properties: (any Properties)?

rawJsonString

public let rawJsonString: String?

type

public let type: RepresentationType

urlToLaunch

public var urlToLaunch: URL?

Returns the URL that should be used to open the Encap application.

continueActions

public var continueActions: [any Action]

Returns the actions that should be displayed when uriToLaunch was used successfully.

errorActions

public var errorActions: [any Action]

Returns the actions that should be displayed when uriToLaunch failed to launch.

Methods

init(from:)

public init(from decoder: Decoder) throws

Parameters

encode(to:)

public func encode(to encoder: Encoder) throws

Parameters

==(::)

public static func == (lhs: EncapClientOperationStep, rhs: EncapClientOperationStep) -> Bool

Parameters