Android SDK for NIFCLOUD mobile backend

ダウンロード

Githubリリースページの NCMB.x.x.x.zip ボタンからダウンロードしてください。

jarの作成

リリースページからダウンロードせずにjarを作成する場合は、
以下のコマンドをプロジェクトのルートディレクトリで実行してください。

./gradlew clean makeJar

ncmb-core/releaseにNCMB.jarが作成されます。

Android Studioから作成する場合は、
Gradle projectsタブの ncmb-core > Tasks > other > makejar を実行することで作成されます。

依存ライブラリ

このSDKでは、以下のライブラリを使用しています。

• Gson

プッシュ通知機能を利用する場合には以下のライブラリを設定する必要があります。
事前にSDK Managerでのインストールが必要です。

• Android Support Library
• Google Play Services SDK

動作環境

本SDKは、Android 7.x ～ 10.x, Android Studio 4.0.x にて動作確認を行っております。 (※2020年8月時点)

テクニカルサポート窓口対応バージョン

テクニカルサポート窓口では、1年半以内にリリースされたSDKに対してのみサポート対応させていただきます。
定期的なバージョンのアップデートにご協力ください。
※なお、mobile backend にて大規模な改修が行われた際は、1年半以内のSDKであっても対応出来ない場合がございます。
その際はinformationブログにてお知らせいたします。予めご了承ください。

• v3.0.0 ～ (※2020年2月時点)

インストール

Android Studioでプロジェクトを開き、以下の手順でSDKをインストールしてください。

1. app/libsフォルダにNCMB.jarをコピーします
2. app/build.gradleファイルに以下を追加します

dependencies {
    implementation 'com.google.code.gson:gson:2.3.1'
    api files('libs/NCMB.jar')
}

クイックスタート

• AndroidManifest.xmlの編集

<application>タグの直前に以下のpermissionを追加します。

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

• 初期化

ActivityのonCreateメソッド内に以下を記載します。

NCMB.initialize(this,"APP_KEY","CLIENT_KEY");

• オブジェクトの保存

NCMB.initializeの下に以下を記載します。

NCMBObject obj = new NCMBObject("TestObject");
obj.put("message", "Hello, NCMB!");
obj.saveInBackground(new DoneCallback() {
    @Override
    public void done(NCMBException e) {
        if(e == null){
            //保存成功
        }else {
            //保存失敗
        }
    }
});

ライセンス

本SDKのライセンスについては、LICENSEファイルをご覧ください。

参考URL集

• ニフクラ mobile backend
• ドキュメント
• ユーザーコミュニティ