BaaS@rakuza ドキュメント

クイックスタート(Android)

このページでは、BaaS@rakuza SDK for Androidを利⽤するための手順を説明します。

インストール

最新のSDKはGitHubにて配布しています。リリース一覧open in new windowにアクセスして最新のバージョンをダウンロードしてください。

プロジェクトに追加

プロジェクトのlibsフォルダにダウンロードしたjarファイル(BaaSAtRakuzaSDK_for_Android.jar)をコピーします。

ヒント

build.gradleにlibsフォルダのjarを読み込む設定がない場合、以下を追記してください。

dependencies {
    // ...
    implementation fileTree(include: ['*.jar'], dir: 'libs')
    // ...
}

AndroidManifest.xmlに権限の追加

作成したプロジェクト内にあるAndroidManifest.xmlに以下のパーミッションを追加します。

<uses-permission android:name="android.permission.INTERNET" />

ProGuard

アプリケーションにProGuardを適用する場合は、以下のルールを指定してください。

-keep class jp.co.pscsrv.android.baasatrakuza.** { *; }

認証情報の設定

BaaS@rakuzaの認証情報をbuild.gradleに設定してください。

android {
    // ...
    defaultConfig {
        // ...
        buildConfigField 'String', 'AuthorizationUsername', '"<配布したアプリ認証ID>"'
        buildConfigField 'String', 'AuthorizationPassword', '"<配布したアプリ認証パスワード>"'
    }
}

初期化処理

BaaS＠rakuzaを利用する際には、RKZClientクラスのシングルトンインスタンスを利用します。以下の処理をアプリ起動時に⾏うことで、BaaS@rakuzaのAPIを利⽤することが出来るようになります。

SDKを初期化する

ここでは、BaaS＠rakuza SDK for Androidを使用する上で重要なRKZClientクラスの初期化を説明します。 BaaS@rakuza SDK for AndroidではRKZClientクラスの初期化は最初に呼び出されるActivityで初期化する事を推奨していますが、どの場所で初期化を行っても構いません。

対象のActivityクラスを開き、onCreateメソッドに以下のコードを追加します。

RKZClient.getInstance().initialize(this, "<配布したテナントキー>") { isSuccess, rkzResponseStatus ->
    // 初期化に成功した場合
    if (isSuccess) {
        // client変数を用いてSDKの機能を使用できます。
        Log.d(TAG, "RKZClientクラスの初期化に成功しました。")
    }
}

RKZClient.getInstance().initialize(this, "<配布したテナントキー>" , new OnInitializeListener() {
    @Override
    public void onInitialize(boolean isSuccess, RKZResponseStatus rkzResponseStatus) {
        // 初期化に成功した場合
        if (isSuccess) {
            // client変数を用いてSDKの機能を使用できます。
            Log.d(TAG, "RKZClientクラスの初期化に成功しました。");
        }
    }
});



以上でBaaS@rakuza SDK for Androidを利⽤する準備が完了しました。