UniWebViewAuthenticationFlowGitHub

Summary

A predefined authentication flow for GitHub.

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 GitHub flow working, at least you need these steps:

1. Setting Client Id, Client Secret, Callback Url in the UniWebViewAuthenticationFlowGitHub inspector.
2. Setting the Auth Callbacks Urls containing the Callback Url in the UniWebView preference panel.

Properties Summary

string clientId { get; set; }	The client ID of your GitHub application.
string clientSecret { get; set; }	The client secret of your GitHub application.
string callbackUrl { get; set; }	The callback URL of your GitHub application.
UniWebViewAuthenticationFlowGitHubOptional optional { get; set; }	Optional to control this flow's behaviour.
string optional.redirectUri { get; set; }	The redirect URI should be used in exchange token request.
string optional.login { get; set; }	Suggests a specific account to use for signing in and authorizing the app.
string optional.scope { get; set; }	The scope string of all your required scopes.
bool optional.enableState { get; set; }	Whether to enable the state verification.
bool optional.allowSignup { get; set; }	Whether or not unauthenticated users will be offered an option to sign up for GitHub during the OAuth flow.

Events Summary

UnityEvent<UniWebViewAuthenticationGitHubToken> 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<UniWebViewAuthenticationGitHubToken> 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 GitHub application.

Example

At the day of writing, the client Id from GitHub is something like:

githubFlow.clientId = "lv1.1234567890abcdef1234";

string clientSecret { get; set; }

The client secret of your GitHub application.

string callbackUrl { get; set; }

The callback URL of your GitHub application.

Example

githubFlow.callbackUrl = "authhub://auth";

UniWebViewAuthenticationFlowGitHubOptional optional { get; set; }

Optional to control this flow's behaviour.

string optional.redirectUri { get; set; }

The redirect URI should be used in exchange token request.

string optional.login { get; set; }

Suggests a specific account to use for signing in and authorizing the app.

string optional.scope { get; set; }

The scope string of all your required scopes.

bool optional.enableState { get; set; }

Whether to enable the state verification. If enabled, the state will be generated and verified in the authentication callback.

Default is false.

bool optional.allowSignup { get; set; }

Whether or not unauthenticated users will be offered an option to sign up for GitHub during the OAuth flow.

Default is true.

Events

UnityEvent<UniWebViewAuthenticationGitHubToken> OnAuthenticationFinished

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

Example

githubFlow.OnAuthenticationFinished.AddListener(OnGitHubTokenReceived)

void OnGitHubTokenReceived(UniWebViewAuthenticationGitHubToken token) {
  Debug.Log("Github Access Token: " + token.AccessToken);
}

UnityEvent<long, string> OnAuthenticationErrored

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

Example

github.OnAuthenticationErrored.AddListener(OnGitHubAuthError);

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

UnityEvent<UniWebViewAuthenticationGitHubToken> OnRefreshTokenFinished

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

Example

githubFlow.OnRefreshTokenFinished.AddListener(OnRefreshTokenReceived)

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

UnityEvent<long, string> OnRefreshTokenErrored

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

Example

githubFlow.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.