UniWebViewAuthenticationFlowTwitter

Summary

A predefined authentication flow for Twitter.

This implementation follows the flow described here.

See the OAuth 2.0 Support for a more detailed guide of authentication in UniWebView.

To allow the Twitter flow working, at least you need these steps:

1. Setting Client Id, Redirect Uri in the UniWebViewAuthenticationFlowTwitter inspector.
2. Setting Scope and at least contains users.read in the UniWebViewAuthenticationFlowTwitter inspector.
3. Setting the Auth Callbacks Urls to contain the Redirect Uri in the UniWebView preference panel.

Properties Summary

string clientId { get; set; }	The client ID of your Twitter application.
string redirectUri { get; set; }	The redirect URI of your Twitter application.
string scope { get; set; }	The scope string of all your required scopes.
UniWebViewAuthenticationFlowTwitterOptional optional { get; set; }	Optional to control this flow's behaviour.
UniWebViewAuthenticationPKCE optional.PKCESupport { get; set; }	Whether to enable PKCE when performing authentication.
bool optional.enableState { get; set; }	Whether to enable the state verification.
string optional.additionalAuthenticationUriQuery { get; set; }	The additional query arguments that are used to construct the query string of the authentication request.

Events Summary

UnityEvent<UniWebViewAuthenticationTwitterToken> OnAuthenticationFinished	Called when the authentication flow succeeds and a valid token is generated.
UnityEvent<long, string> OnAuthenticationErrored	Called when any error (including user cancellation) happens during the authentication flow.
UnityEvent<UniWebViewAuthenticationTwitterToken> OnRefreshTokenFinished	Called when the access token refresh request finishes and a valid refreshed token is generated.
UnityEvent<long, string> OnRefreshTokenErrored	Called when any error (including user cancellation) happens during the authentication flow.

Methods Summary

void StartAuthenticationFlow()	Starts the authentication flow with the standard OAuth 2.
void StartRefreshTokenFlow(string refreshToken)	Starts the refresh flow with the standard OAuth 2.

Properties

string clientId { get; set; }

The client ID of your Twitter application.

string redirectUri { get; set; }

The redirect URI of your Twitter application.

string scope { get; set; }

The scope string of all your required scopes.

UniWebViewAuthenticationFlowTwitterOptional optional { get; set; }

Optional to control this flow's behaviour.

UniWebViewAuthenticationPKCE optional.PKCESupport { get; set; }

Whether to enable PKCE when performing authentication.This has to be enabled as S256, otherwise, Twitter will reject the authentication request.

bool optional.enableState { get; set; }

Whether to enable the state verification. If enabled, the state will be generated and verified in the authentication callback. This has to be true, otherwise, Twitter will reject the authentication request.

string optional.additionalAuthenticationUriQuery { get; set; }

The additional query arguments that are used to construct the query string of the authentication request.

This is useful when you want to add some custom parameters to the authentication request. This string will be appended to the query string that constructed from GetAuthenticationUriArguments.

For example, if you set the value to prompt=consent&ui_locales=en, it will be contained in the final authentication query.

Events

UnityEvent<UniWebViewAuthenticationTwitterToken> OnAuthenticationFinished

Called when the authentication flow succeeds and a valid token is generated.

Example

twitterFlow.OnAuthenticationFinished.AddListener(OnTwitterTokenReceived)

void OnTwitterTokenReceived(UniWebViewAuthenticationTwitterToken token) {
  Debug.Log("Twitter Access Token: " + token.AccessToken);
}

UnityEvent<long, string> OnAuthenticationErrored

Called when any error (including user cancellation) happens during the authentication flow.

Example

twitterFlow.OnAuthenticationErrored.AddListener(OnTwitterAuthError);

void OnTwitterAuthError(long error, string message) {
  Debug.Log("Error code: " + error + " Message: " + message);
}

UnityEvent<UniWebViewAuthenticationTwitterToken> OnRefreshTokenFinished

Called when the access token refresh request finishes and a valid refreshed token is generated.

Example

twitterFlow.OnRefreshTokenFinished.AddListener(OnRefreshTokenReceived)

void OnRefreshTokenReceived(UniWebViewAuthenticationTwitterToken token) {
  Debug.Log("Access Token: " + token.AccessToken);
}

UnityEvent<long, string> OnRefreshTokenErrored

Called when any error (including user cancellation) happens during the authentication flow.

Example

twitterFlow.OnRefreshTokenErrored.AddListener(OnRefreshTokenError);

void OnRefreshTokenError(long error, string message) {
  Debug.Log("Error code: " + error + " Message: " + message);
}

Methods

void StartAuthenticationFlow()

Starts the authentication flow with the standard OAuth 2.0. This implements the abstract method in UniWebViewAuthenticationCommonFlow.

void StartRefreshTokenFlow(string refreshToken)

Starts the refresh flow with the standard OAuth 2.0. This implements the abstract method in UniWebViewAuthenticationCommonFlow.