com.linecorp.linesdk.widget

Class LoginButton

java.lang.Object

com.linecorp.linesdk.widget.LoginButton

public class LoginButton
extends java.lang.Object

A button widget that simplifies the login flow. Before you add login listeners to this login button through the addLoginListener(LoginListener) method, set your channel ID through the setChannelId(String) method and login delegate through the setLoginDelegate(LoginDelegate) method. Otherwise, a RuntimeException is thrown. Also, use the provided LoginDelegate.Factory#create() method to create a LoginDelegate instance and set it to this button through the setLoginDelegate(LoginDelegate) method.

By default, this button performs the login process using LINE with the Scope.PROFILE scope only. You can create your own LineAuthenticationParams instance using the provided LineAuthenticationParams.Builder method and set the authentication parameters to this button through the setAuthenticationParams(LineAuthenticationParams) method. You can also control whether the user logs in with LINE or with the browser through the enableLineAppAuthentication(boolean) method.

Finally, call the LoginDelegate.onActivityResult(int, int, Intent) method using the intent that you created with the Activity#onActivityResult(int, int, Intent) method. If you use this button in a Fragment or an Fragment instance, set the fragment to this button through the setFragment(Fragment) method or the #setFragment(android.support.v4.app.Fragment) method. By doing so, you can call the onActivityResult callback in your fragment after the login process is complete.

The following example shows how to set up the login button with the desired parameters.

 int loginButtonResId = ...;
 String channelId = ...;
 LoginDelegate loginDelegate = LoginDelegate.Factory.create();
 LineAuthenticationParams params = LineAuthenticationParams.Builder()
                                         .scopes(...)
                                         .nonce(...)
                                         .botPrompt(...)
                                         .build();

 LoginButton loginButton = findViewById(loginButtonResId);
 loginButton.setChannelId(channelId);
 loginButton.setLoginDelegate(loginDelegate);
 loginButton.enableLineAppAuthentication(true);
 loginButton.setAuthenticationParams(params);
 loginButton.addLoginListener(new LoginListener() {
     @Override
     public void onLoginSuccess(@NonNull LineLoginResult result) {
         ...
     }

     @Override
     public void onLoginFailure(@Nullable LineLoginResult result) {
     if (result != null) {
         ...
     } else {
         ...
     }
 });
 

The example below handles the login result intent in the onActivityResult method.

  @Override
 public void onActivityResult(int requestCode, int resultCode, Intent data) {
     super.onActivityResult(requestCode, resultCode, data);
     if (loginDelegate.onActivityResult(requestCode, resultCode, data)) {
         // login result intent is consumed.
         return;
     }
 }
 

Constructor Summary

Constructors

Constructor and Description
LoginButton(Context context)
LoginButton(Context context, AttributeSet attrs)
LoginButton(Context context, AttributeSet attrs, int defStyleAttr)

Method Summary

Modifier and Type	Method and Description
void	addLoginListener(LoginListener loginListener) Sets the given loginListener to listen to the login result.
void	enableLineAppAuthentication(boolean isEnabled) Sets whether the user logs in with LINE or with the browser according to the given isEnabled parameter.
void	removeLoginListener(LoginListener loginListener) Removes the given loginListener and stops it from listening to the login result.
void	setAuthenticationParams(LineAuthenticationParams params) Sets the authentication parameters that you want your application to use when it performs a login.
void	setChannelId(java.lang.String channelId) Sets the channel ID of the channel that your application your application will use to log in.
void	setFragment(Fragment fragment) Specifies the fragment that contains this button so that its Fragment#onActivityResult(int, int, Intent) method is properly called.
void	setLoginDelegate(LoginDelegate loginDelegate) Sets the login delegate.
void	setOnClickListener(OnClickListener externalListener) Registers a callback to be invoked when this button is tapped.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoginButton

public LoginButton(Context context)

LoginButton

public LoginButton(Context context,
                   AttributeSet attrs)

LoginButton

public LoginButton(Context context,
                   AttributeSet attrs,
                   int defStyleAttr)

Method Detail

setOnClickListener

public void setOnClickListener(@Nullable
                               OnClickListener externalListener)

Registers a callback to be invoked when this button is tapped.

Parameters:

externalListener - The callback to be invoked. This value may be null.

setFragment

public void setFragment(@NonNull
                        Fragment fragment)

Specifies the fragment that contains this button so that its Fragment#onActivityResult(int, int, Intent) method is properly called.

Parameters:

fragment - The Fragment that contains this button.

setLoginDelegate

public void setLoginDelegate(@NonNull
                             LoginDelegate loginDelegate)

Sets the login delegate. This should be created using the LoginDelegate.Factory#create() method. If the delegate is not set, a RuntimeException is thrown. You also must call the LoginDelegate.onActivityResult(int, int, Intent) method of the given loginDelegate in the Activity or Fragment instance to handle the response intent.

addLoginListener

public void addLoginListener(@NonNull
                             LoginListener loginListener)

Sets the given loginListener to listen to the login result.

Parameters:

loginListener - The listener to set to listen to the login result.

removeLoginListener

public void removeLoginListener(@NonNull
                                LoginListener loginListener)

Removes the given loginListener and stops it from listening to the login result.

Parameters:

loginListener - The listener to be removed.

enableLineAppAuthentication

public void enableLineAppAuthentication(boolean isEnabled)

Sets whether the user logs in with LINE or with the browser according to the given isEnabled parameter.

Parameters:

isEnabled - True if you want the user to log in with LINE instead of the browser; false otherwise. The default value is true.

setChannelId

public void setChannelId(@NonNull
                         java.lang.String channelId)

Sets the channel ID of the channel that your application your application will use to log in.

Parameters:

channelId - The channel ID.

setAuthenticationParams

public void setAuthenticationParams(@NonNull
                                    LineAuthenticationParams params)

Sets the authentication parameters that you want your application to use when it performs a login.

Parameters:

params - The authentication parameters.