Route
public enum Route
Route to a specific screen in the identity UI flow. A route is typically constructed in order to handle a universal (i.e. deep) link URL so that the identity process can then be presented by going directly to the screen corresponding to the URL.
-
Route to the initial login screen.
Declaration
Swift
case login
-
Route to the screen where the user can enter her password. The user’s email should have previously been saved by calling
IdentityUI.Route.storePersistentMetadata(for:)
, so it’s made available again as an associated value when constructing the route from a URL.Declaration
Swift
case enterPassword(for: EmailAddress, scopes: [String])
-
Route to validate an authcode
Declaration
Swift
case validateAuthCode(code: String, shouldPersistUser: Bool?)
-
Initializes a new route from the given universal (i.e. deep) link URL and configuration. The initializer returns
nil
in case the given URL isn’t recognized as part of an identity process (so that you can possibly handle it in a different way in case you have universal links other than the ones coming from the identity process).Declaration
Swift
public init?(url: URL, configuration: ClientConfiguration)
Parameters
url
The given URL.
configuration
The given configuration.
-
Initializes a new route from the given
ClientConfiguration.RedirectPayload
object. The initializer returnsnil
in case nothing can be done with the given payloadDeclaration
Swift
public init?(payload: ClientConfiguration.RedirectPayload)
Parameters
payload
The given redirect payload.