つくる、をつなぐProject Linking

LinkingコアライブラリAPI仕様書 for Android

ver 1.0.0
目次

ライブラリの利用登録

サービスアプリから本ライブラリを使用する際にはアプリケーション登録(registerApplication)を行ってください。アプリケーション登録完了(onAppRegistered)後、サービスアプリの動作に必要なAPIを使用してください。

Linking Library

Linkingライブラリを利用するアプリケーションを管理するクラス

パッケージ

com.example.projectlinking.android.LinkingLibrary

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 registerApplication アプリケーション登録
2 unregisterApplication アプリケーション登録削除
3 getVersion ライブラリバージョン取得

メソッド詳細

registerApplication
int registerApplication(Context context, LinkingLibrary Callback callback)
Linkingライブラリを使用するアプリケーションを登録します。
登録する際にPermissionの確認(※)を行い、必要なPermissionが定義されていない場合は、Permission定義NGを返却します。
※Permission定義の確認処理は、APIレベル23(Android M)以上が対象となります。
その為、APIレベル23未満の場合には、Permissionの未定義があるとExceptionが発生します。
引数
Contextcontextアプリケーションのコンテキスト
LinkingLibrary Callbackcallbackコールバック
戻り値
実行結果(REGISTER_SUCCESS:成功/
     REGISTER_PARAM_NG:設定パラメータNG /
     REGISTER_PERMISSION_NG:パーミッションNG)
unregisterApplication
boolean unregisterApplication(Context context)
Linkingライブラリを使用したアプリケーションの登録を削除します。
引数
Contextcontextアプリケーションのコンテキスト
戻り値
実行結果(true:成功/ false:失敗)
getVersion
String getVersion()
Linkingライブラリのバージョンを取得します。
引数
なし
戻り値
ライブラリのバージョン

LinkingLibrary Callback

Linkingライブラリコールバック

パッケージ

com.example.projectlinking.android.LinkingLibrary

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 onAppRegistered アプリケーション登録通知

メソッド詳細

onAppRegistered
void onAppRegistered(int result)
アプリケーション登録通知
引数
intresultアプリケーション登録結果
戻り値
なし

Linking Constants

結果コード一覧

パッケージ

com.example.projectlinking.android.LinkingLibrary

フィールド一覧

NO フィールド名 概要
1 DEVICE_STATE_CONNECTED デバイス接続状態
2 DEVICE_STATE_DISCONNECTED デバイス切断状態
3 RESULT_CANCEL ユーザによるキャンセル
4 RESULT_CONFLICT 接続要求が競合した
5 RESULT_CONNECT_FAILURE デバイスとの接続に失敗した。
6 RESULT_CONTEXT_NG コンテキスト指定エラー
7 RESULT_OK 正常に取得開始依頼を行った
8 RESULT_OTHER_ERROR その他エラー(Linkingの内部エラー発生時など)
9 RESULT_PARAM_ERROR パラメータエラー
10 RESULT_UNSUPPORTED_VERSION Linkingが未対応バージョン
11 REGISTER_SUCCESS ライブラリ使用OK
12 REGISTER_PARAM_NG ライブラリ使用設定NG
13 REGISTER_PERMISSION_NG パーミッション未達