UniWebViewAuthenticationFlowLine

Summary

A predefined authentication flow for LINE.

This implementation follows the flow described here.

LINE authentication flow is a bit different from the other standard authentication flows. Please read the link above carefully to understand it.

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

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

1. Setting Client Id (Channel Id), iOS Bundle Id and Android Package Name in the UniWebViewAuthenticationFlowLine inspector.
2. Setting Scope and at least contains profile in the UniWebViewAuthenticationFlowLine inspector.
3. Check the "Support LINE Login" option in the UniWebView preference panel.

Properties Summary

string clientId { get; set; }	The client ID (Channel ID) of your LINE Login application.
string iOSBundleId { get; set; }	The iOS bundle Id you set in LINE developer console.
string androidPackageName { get; set; }	The Android package name you set in LINE developer console.
string scope { get; set; }	The scope of your LINE application.
UniWebViewAuthenticationFlowLineOptional optional { get; set; }	Optional to control this flow's behaviour.
UniWebViewAuthenticationPKCE optional.PKCESupport { get; set; }	Whether to enable PKCE when performing authentication.
string optional.additionalAuthenticationUriQuery { get; set; }	The additional query arguments that are used to construct the query string of the authentication request.

Events Summary

UnityEvent<UniWebViewAuthenticationLineToken> 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<UniWebViewAuthenticationLineToken> 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 (Channel ID) of your LINE Login application.

string iOSBundleId { get; set; }

The iOS bundle Id you set in LINE developer console.

string androidPackageName { get; set; }

The Android package name you set in LINE developer console.

string scope { get; set; }

The scope of your LINE application.

UniWebViewAuthenticationFlowLineOptional optional { get; set; }

Optional to control this flow's behaviour.

UniWebViewAuthenticationPKCE optional.PKCESupport { get; set; }

Whether to enable PKCE when performing authentication. Default is S256.

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<UniWebViewAuthenticationLineToken> OnAuthenticationFinished

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

Example

lineFlow.OnAuthenticationFinished.AddListener(OnLineTokenReceived)

void OnLineTokenReceived(UniWebViewAuthenticationLineToken token) {
  Debug.Log("Line Access Token: " + token.AccessToken);
}

UnityEvent<long, string> OnAuthenticationErrored

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

Example

lineFlow.OnAuthenticationErrored.AddListener(OnLineAuthError);

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

UnityEvent<UniWebViewAuthenticationLineToken> OnRefreshTokenFinished

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

Example

lineFlow.OnRefreshTokenFinished.AddListener(OnRefreshTokenReceived)

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

UnityEvent<long, string> OnRefreshTokenErrored

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

Example

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