com.linecorp.linesdk

Class LineApiResponse<R>

java.lang.Object

com.linecorp.linesdk.LineApiResponse<R>

public class LineApiResponse<R>
extends java.lang.Object

Represents a response from the Social API.

Method Summary

Modifier and Type	Method and Description
static <T> LineApiResponse<T>	createAsError(LineApiResponseCode responseCode, LineApiError errorData)
static <T> LineApiResponse<T>	createAsSuccess(T responseData)
boolean	equals(java.lang.Object o)
LineApiError	getErrorData() Gets information about an API error occurred.
LineApiResponseCode	getResponseCode() Gets the response code that is returned.
R	getResponseData() Gets data that is associated with the response if it exists.
int	hashCode()
boolean	isNetworkError() Checks if the API call fails with a network error.
boolean	isServerError() Checks if the API call fails with a server error.
boolean	isSuccess() Checks if the API call is successful.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

createAsSuccess

@NonNull
public static <T> LineApiResponse<T> createAsSuccess(@Nullable
                                                              T responseData)

Parameters:

responseData - The response data to construct the LineApiResponse with.

Returns:

The LineApiResponse with LineApiResponseCode.SUCCESS response code, the given responseData, and the LineApiError.DEFAULT error data.

createAsError

@NonNull
public static <T> LineApiResponse<T> createAsError(@NonNull
                                                            LineApiResponseCode responseCode,
                                                            @NonNull
                                                            LineApiError errorData)

Parameters:

responseCode - The response code to construct the LineApiResponse with.

errorData - The error data to construct the LineApiResponse with.

Returns:

The LineApiResponse with the given responseCode, the null response data, and the given errorData.

Throws:

java.lang.AssertionError - If the given responseCode is LineApiResponseCode.SUCCESS and the current build is debug build.

isSuccess

public boolean isSuccess()

Checks if the API call is successful.

Returns:

True if the API call is successful; false otherwise.

isNetworkError

public boolean isNetworkError()

Checks if the API call fails with a network error.

Returns:

True if the API call fails with a network error; false otherwise.

isServerError

public boolean isServerError()

Checks if the API call fails with a server error.

Returns:

True if the API call fails with a server error; false otherwise.

getResponseCode

@NonNull
public LineApiResponseCode getResponseCode()

Gets the response code that is returned.

Returns:

The LineApiResponseCode object containing the HTTP status code which indicates if the API call is successful.

getResponseData

@NonNull
public R getResponseData()

Gets data that is associated with the response if it exists. If no data is associated with the response, it throws NoSuchElementException. You must check if the response succeeded by using the isSuccess() method before calling this method.

Returns:

The response data in the same format as the generic type associated with the LineApiResponse class.

Throws:

java.util.NoSuchElementException - if the response data is null.

getErrorData

@NonNull
public LineApiError getErrorData()

Gets information about an API error occurred. This method should only be called if an API call has failed.

Returns:

The LineApiError object that contains information about the error. If no error occurs, the LineApiError object will not contain any useful information.

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