com.linecorp.linesdk.auth

Class LineLoginResult

java.lang.Object

com.linecorp.linesdk.auth.LineLoginResult

public class LineLoginResult
extends java.lang.Object

Represents a login result that is returned from the LINE Platform.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LineLoginResult.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR

Method Summary

Modifier and Type	Method and Description
static LineLoginResult	authenticationAgentError(LineApiError errorData)
static LineLoginResult	canceledError()
int	describeContents()
boolean	equals(java.lang.Object o)
static LineLoginResult	error(LineApiResponse<?> apiResponse)
static LineLoginResult	error(LineApiResponseCode resultCode, LineApiError errorData)
LineApiError	getErrorData() Gets information about a login error that has occurred.
java.lang.Boolean	getFriendshipStatusChanged() Gets the friendship status of the user and the bot linked to your LINE Login channel.
LineCredential	getLineCredential() Gets the user's credentials.
LineIdToken	getLineIdToken() Gets the ID token that contains the user's information.
LineProfile	getLineProfile() Gets the user's profile information.
java.lang.String	getNonce() Gets the `nonce` value used for performing login in LINE.
LineApiResponseCode	getResponseCode() Gets the response code that the login returned.
int	hashCode()
static LineLoginResult	internalError(java.lang.Exception e)
static LineLoginResult	internalError(LineApiError errorData)
static LineLoginResult	internalError(java.lang.String errorMessage)
boolean	isSuccess() Checks whether the login was successful.
java.lang.String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final <any> CREATOR

Method Detail

error

public static LineLoginResult error(@NonNull
                                    LineApiResponseCode resultCode,
                                    @NonNull
                                    LineApiError errorData)

error

public static LineLoginResult error(@NonNull
                                    LineApiResponse<?> apiResponse)

internalError

public static LineLoginResult internalError(@NonNull
                                            LineApiError errorData)

internalError

public static LineLoginResult internalError(@NonNull
                                            java.lang.String errorMessage)

internalError

public static LineLoginResult internalError(@NonNull
                                            java.lang.Exception e)

authenticationAgentError

public static LineLoginResult authenticationAgentError(@NonNull
                                                       LineApiError errorData)

canceledError

public static LineLoginResult canceledError()

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

isSuccess

public boolean isSuccess()

Checks whether the login was successful.

Returns:

True if the login is successful; false otherwise.

getResponseCode

@NonNull
public LineApiResponseCode getResponseCode()

Gets the response code that the login returned.

Returns:

A LineApiResponseCode object with the response code that indicates whether the login was successful or not.

getNonce

@Nullable
public java.lang.String getNonce()

Gets the `nonce` value used for performing login in LINE.

Returns:

The `nonce` value used for performing login in LINE.

getLineProfile

@Nullable
public LineProfile getLineProfile()

Gets the user's profile information.

Returns:

A LineProfile object with the user's LINE profile.

getLineIdToken

@Nullable
public LineIdToken getLineIdToken()

Gets the ID token that contains the user's information.

Returns:

A LineIdToken object with the user's information.

getFriendshipStatusChanged

@NonNull
public java.lang.Boolean getFriendshipStatusChanged()

Gets the friendship status of the user and the bot linked to your LINE Login channel.

Returns:

True if the user has added the bot as a friend and has not blocked the bot; false otherwise.

getLineCredential

@Nullable
public LineCredential getLineCredential()

Gets the user's credentials.

Returns:

A LineCredential object with the user's authentication credentials.

getErrorData

@NonNull
public LineApiError getErrorData()

Gets information about a login error that has occurred. This method should only be called if the login has failed.

Returns:

A LineApiError object that contains information about the error if a login error has occurred. Contains a response of 0 and a null string if no error occurs.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object