UniWebViewAuthenticationCommonFlow

Summary

Abstract class and general control for other authentication flows. This class determines the global behaviors of the authentication flow, such as whether to start authentication as soon as the script Starts, and whether to use private mode to authenticate the user.

This is a super and abstract class for all concrete auth flow. You are not expected to use this class directly. Instead, to start a customized auth flow, you can use the UniWebViewAuthenticationFlowCustomize class.

Properties Summary

bool authorizeOnStart { get; set; }	Whether to start authentication as soon as the script Starts.
bool privateMode { get; set; }	Whether to use private mode to authenticate the user.

Methods Summary

abstract void StartAuthenticationFlow()	Subclass should override this method to start the authentication flow.
abstract void StartRefreshTokenFlow(string refreshToken)	Subclass should override this method to start the authentication flow.
string GenerateAndStoreState()	Child classes are expected to call this method to request a state (and store it for later check) if the state verification is enabled.
string GenerateCodeChallengeAndStoreCodeVerify(UniWebViewAuthenticationPKCE method)	Child classes are expected to call this method to request a code_challenge.
void VerifyState(VerifyState(Dictionary<string, string> parameters, string key)	Perform verifying for state.

Properties

bool authorizeOnStart { get; set; }

Whether to start authentication as soon as the script Starts.

bool privateMode { get; set; }

Whether to use private mode to authenticate the user. If true and the device supports, the authentication will begin under the incognito mode.

On iOS, this works on iOS 13 and later.

On Android, it depends on the Chrome version and might require users to enable the incognito mode (and support for third-party use) in Chrome's settings. Check settings with chrome://flags/#cct-incognito and chrome://flags/#cct-incognito-available-to-third-party in Chrome to see the current status.

Methods

abstract void StartAuthenticationFlow()

Subclass should override this method to start the authentication flow. Usually it starts a UniWebViewAuthenticationFlow. But you can also choose whatever you need to do.

abstract void StartRefreshTokenFlow(string refreshToken)

Subclass should override this method to start the authentication flow. Usually it starts a Unity Web Request against the authentication flow's token entry point to refresh the token.

string GenerateAndStoreState()

Child classes are expected to call this method to request a state (and store it for later check) if the state verification is enabled.

string GenerateCodeChallengeAndStoreCodeVerify(UniWebViewAuthenticationPKCE method)

Child classes are expected to call this method to request a code_challenge. Later when exchanging the access token, the code_verifier will be used to verify the code_challenge. Subclass can read it from CodeVerify.

void VerifyState(VerifyState(Dictionary<string, string> parameters, string key)

Perform verifying for state. Child classes are expected to call this method to verify the state. If the state is invalid, the authentication flow will be stopped and an AuthenticationResponseException.InvalidState thrown.