Android SDKリファレンス

インターフェイス

インターフェイスLineApiClient

Social APIにアクセスするために使用されるインターフェイスです。

パッケージ com.linecorp.linesdk.api

メソッド

getCurrentAccessToken()
LineApiResponse<LineAccessToken> getCurrentAccessToken()

SDKで使用されている、ユーザーのアクセストークンを取得します。

戻り値

APIコールが成功した場合は、LineAccessTokenにアクセストークンを含むLineApiResponseオブジェクトです。APIコールが失敗した場合は、LineApiResponseのペイロードはnullです。

getProfile()
LineApiResponse<LineProfile> getProfile()

ユーザーのプロフィール情報を取得します。

戻り値

APIコールが成功した場合は、LineProfileにユーザーのプロフィール情報を含むLineApiResponseオブジェクトです。APIコールが失敗した場合は、LineApiResponseのペイロードはnullです。

logout()
LineApiResponse<?> logout()

ユーザーのアクセストークンを取り消します。

戻り値

応答情報を含むLineApiResponseオブジェクトです。

refreshAccessToken()
LineApiResponse<LineAccessToken> refreshAccessToken()

SDKで使用されている、ユーザーのアクセストークンを更新します。

戻り値

LineAccessTokenに新しいアクセストークンを含むLineApiResponseオブジェクトです。APIコールが失敗した場合は、LineApiResponseのペイロードはnullです。

verifyToken()
LineApiResponse<LineCredential> verifyToken()

SDKで使用されている、ユーザーのアクセストークンが有効かどうかを確認します。

戻り値

トークンが有効な場合は、成功した応答を含むLineApiResponseオブジェクトと、アクセストークンを含むLineCredentialオブジェクトです。ユーザーのアクセストークンが無効な場合は、失敗の応答が返されます。

クラス

クラスLineApiError

Social APIによりスローされるエラーを表します。

パッケージ com.linecorp.linesdk
継承クラス Object
実装インターフェイス Parcelable

メソッド

getHttpResponseCode()
public int getHttpResponseCode()

APIエラーに関連付けられている応答コードを取得します。

戻り値

HTTP応答コードです。

getMessage()
public String getMessage()

APIエラーに関連付けられているエラーメッセージを取得します。

戻り値

APIエラーに関連付けられているエラーメッセージです。

クラスLineAccessToken

Social APIを呼び出すために使うユーザーのアクセストークンを表します。

パッケージ com.linecorp.linesdk
継承クラス Object
実装インターフェイス Parcelable

メソッド

getAccessToken()
public String getAccessToken()

ユーザーのアクセストークンを表現する文字列を取得します。

戻り値

ユーザーのアクセストークンです。

getEstimatedExpirationTimeMillis()
public long getEstimatedExpirationTimeMillis()

ユーザーのアクセストークンの有効期限が切れると予測されるUNIXタイムを取得します。クライアントにキャッシュされている日時を使って計算されるため、返される有効期限は正確ではありません。

戻り値

ユーザーのアクセストークンの有効期限が切れると予測されるUNIXタイムです。

getExpiresInMillis()
public long getExpiresInMillis()

ユーザーのアクセストークンの有効期限が切れるまでの時間を返します。単位はミリ秒です。

戻り値

ユーザーのアクセストークンの有効期限が切れるまでの時間です。単位はミリ秒です。

getIssuedClientTimeMillis()
public long getIssuedClientTimeMillis()

ユーザーのアクセストークンの情報が最後に更新された時刻をUNIXタイムで返します。この値は、ログイン、トークンの更新、およびトークンの検証時に更新されます。

戻り値

ユーザーのアクセストークンの情報が最後に更新された時刻のUNIXタイムです。

クラスLineApiClientBuilder

必要な設定と共にLineApiClientを作成するために使用されるクラスです。

パッケージ com.linecorp.linesdk.api
継承クラス なし
実装インターフェイス なし

コンストラクタ

public LineApiClientBuilder(@NonNull Context context, int channelId) 
パラメータ
パラメータ 説明
context Androidコンテキスト
channelId チャネルID

メソッド

build()
public LineApiClient build()

LineApiClientのインスタンスを作成して返します。

戻り値

LineApiClientのインスタンスです。

disableTokenAutoRefresh()
public LineApiClientBuilder disableTokenAutoRefresh()

アクセストークンを自動的に更新するSDKの機能を無効にします。

戻り値

LineApiClientBuilderの現在のインスタンスです。

クラスLineApiResponse

Social APIからの応答を表します。

パッケージ com.linecorp.linesdk
継承クラス Object
実装インターフェイス なし

メソッド

getErrorData()
public LineApiError getErrorData()

発生したAPIエラーについての情報を取得します。APIコールが失敗した場合にのみ呼び出してください。

戻り値

エラー情報を含むLineApiErrorオブジェクトです。エラーが発生していない場合は、LineApiErrorオブジェクトに有用な情報は含まれません。

getResponseCode()
public LineApiResponseCode getResponseCode()

返された応答コードを取得します。

戻り値

HTTPステータスコードを含むLineApiResponseCodeです。このコードから、APIコールが成功したかどうかがわかります。

getResponseData()
public R getResponseData()

応答が存在する場合は、応答に関連付けられたデータを取得します。応答に関連付けられたデータがない場合は、NoSuchElementExceptionがスローされます。このAPIを呼び出す前に、isSuccess()メソッドを使って応答が成功したかどうかを確認する必要があります。

戻り値

LineApiResponseに関連付けられた汎用タイプと同じフォーマットの応答データです。

isNetworkError()
public boolean isNetworkError()

ネットワークエラーのためにAPIコールが失敗したかどうかを確認します。

戻り値

ネットワークエラーのためにAPIコールが失敗した場合はtrueです。そうでなければfalseです。

isServerError()
public boolean isServerError()

サーバーエラーのためにAPIコールが失敗したかどうかを確認します。

戻り値

サーバーエラーのためにAPIコールが失敗した場合はtrueです。そうでなければfalseです。

isSuccess()
public boolean isSuccess()

APIコールが成功したかどうかを確認します。

戻り値

APIコールが成功した場合はtrueです。そうでなければfalseです。

クラスLineCredential

Social APIへのアクセス権を付与するために使用される資格情報を表します。

パッケージ com.linecorp.linesdk
継承クラス Object
実装インターフェイス Parcelable

メソッド

getAccessToken()
public LineAccessToken getAccessToken()

アクセストークンを取得します。

戻り値

アクセストークンを含むLineAccessTokenオブジェクトです。

getPermission()
public List<String> getPermission()

アクセストークンが保持する権限のリストを取得します。

戻り値

アクセス トークンに関連付けられている権限コードの文字列リストです。

権限コード

権限コードのリストです。

権限コード 説明
P トークンを使ってユーザーのプロフィール情報を取得できます。

クラスLineLoginApi

このクラスを使用して、LINEログインの実行に使用できるインテントをセットアップして取得します。

パッケージ com.linecorp.linesdk.auth
継承クラス なし
実装インターフェイス なし

メソッド

getLoginIntent()
public static Intent getLoginIntent(Context context, int channelId)

LINEログインの実行に使用するインテントを取得します。LINEアプリがインストール済みの場合は、LINEアプリを介してアプリ連携認証が実行されます。LINEアプリがインストールされていない場合は、ブラウザを使用してログインを実行します。

パラメータ
パラメータ 説明
context Androidコンテキスト
channelId チャネルID
戻り値

ログインインテントです。デフォルトではLINE自動ログインが使用されます。

getLoginIntentWithoutLineAppAuth()
public static Intent getLoginIntentWithoutLineAppAuth(Context context, int channelId)

ブラウザログインのみを使用するログインインテントを取得します。

パラメータ
パラメータ 説明
context Androidコンテキスト
channelId チャネルID
戻り値

ブラウザログインのみを使用するログインインテントです。

クラスLineLoginResult

LINEプラットフォームから返されるログイン結果を表します。

パッケージ com.linecorp.linesdk.auth
継承クラス Object
実装インターフェイス Parcelable

メソッド

isSuccess()

ログインが成功したかどうかを確認します。

public boolean isSuccess() 
戻り値

ログインが成功した場合はtrueです。そうでなければfalseです。

getResponseCode()
public LineApiResponseCode getResponseCode()

ログインにより返された応答コードを取得します。

戻り値

ログインが成功したかどうかを示す応答コードを含むLineApiResponseCodeオブジェクトです。

getLineProfile()
public LineProfile getLineProfile() 

ユーザーのプロフィール情報を取得します。

戻り値

ユーザーのLINEプロフィールを含むLineProfileオブジェクトです。

getLineCredential()
public LineCredential getLineCredential() 

ユーザーの資格情報を取得します。

戻り値

ユーザーの認証資格情報を含むLineCredentialオブジェクトです。

getErrorData()
public getErrorData()

発生したログインエラーについての情報を取得します。ログインが失敗した場合にのみ呼び出してください。

戻り値

ログインエラーが発生した場合は、エラー情報を含むLineApiErrorオブジェクトです。エラーが発生していない場合は、0応答およびnull文字列です。

クラスLineProfile

Social APIでのユーザーのLINEプロフィールを表します。

パッケージ com.linecorp.linesdk
継承クラス Object
実装インターフェイス Parcelable

メソッド

getDisplayName()
public String getDisplayName()

ユーザーの表示名を取得します。

戻り値

ユーザーの表示名です。

getPictureUrl()
public Uri getPictureUrl()

ユーザープロフィールの画像URLを取得します。

戻り値

ユーザープロフィールの画像URLです。

ユーザープロフィールの画像サイズは、URLにサフィックスを付加することによって変更できます。

画像サイズ サフィックス
200 x 200 /large
51 x 51 /small
getStatusMessage()
public String getStatusMessage()

ユーザーのステータスメッセージを取得します。

戻り値

ユーザーのステータスメッセージです。

getUserId()
public String getUserId()

ユーザーIDを取得します。

戻り値

ユーザーIDです。