mirror of
https://github.com/vector-im/element-ios.git
synced 2024-09-29 07:42:40 +00:00
c65ead8e58
Hide the back button at the same time. Disable custom server entry when picking a different use case.
61 lines
2.8 KiB
Swift
61 lines
2.8 KiB
Swift
// File created from ScreenTemplate
|
|
// $ createScreen.sh Onboarding Authentication
|
|
/*
|
|
Copyright 2021 New Vector Ltd
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import Foundation
|
|
|
|
struct AuthenticationCoordinatorParameters {
|
|
let navigationRouter: NavigationRouterType
|
|
/// Whether or not the coordinator should show the loading spinner, key verification etc.
|
|
let canPresentAdditionalScreens: Bool
|
|
}
|
|
|
|
enum AuthenticationCoordinatorResult {
|
|
/// The user has authenticated but key verification is yet to happen. The session value is
|
|
/// for a fresh session that still needs to load, sync etc before being ready.
|
|
case didLogin(session: MXSession, authenticationType: MXKAuthenticationType)
|
|
/// All of the required authentication steps including key verification is complete.
|
|
case didComplete
|
|
}
|
|
|
|
/// `AuthenticationCoordinatorProtocol` is a protocol describing a Coordinator that handle's the authentication navigation flow.
|
|
protocol AuthenticationCoordinatorProtocol: Coordinator, Presentable {
|
|
var completion: ((AuthenticationCoordinatorResult) -> Void)? { get set }
|
|
|
|
/// Whether the custom homeserver checkbox is enabled for the user to enter a homeserver URL.
|
|
var customServerFieldsVisible: Bool { get set }
|
|
|
|
/// Update the screen to display registration or login.
|
|
func update(authenticationType: MXKAuthenticationType)
|
|
|
|
/// Force a registration process based on a predefined set of parameters from a server provisioning link.
|
|
/// For more information see `AuthenticationViewController.externalRegistrationParameters`.
|
|
func update(externalRegistrationParameters: [AnyHashable: Any])
|
|
|
|
/// Update the screen to use any credentials to use after a soft logout has taken place.
|
|
func update(softLogoutCredentials: MXCredentials)
|
|
|
|
/// Set up the authentication screen with the specified homeserver and/or identity server.
|
|
func updateHomeserver(_ homeserver: String?, andIdentityServer identityServer: String?)
|
|
|
|
/// When SSO login succeeded, when SFSafariViewController is used, continue login with success parameters.
|
|
func continueSSOLogin(withToken loginToken: String, transactionID: String) -> Bool
|
|
|
|
/// Indicates to the coordinator to display any pending screens if it was created with
|
|
/// the `canPresentAdditionalScreens` parameter set to `false`
|
|
func presentPendingScreensIfNecessary()
|
|
}
|