Android SDK クイックスタート

このドキュメントは、Android SDK を使用して一般的な操作を実行するためのクイックスタートガイドを提供します。 SDK のインストール方法、アクセス認証情報の設定方法、最新のアップグレード情報の取得などの基本操作の実行方法を学びます。

注意事項

• Android SDK を使用してリクエストを行うには、Client インスタンスを初期化する必要があります。このドキュメントでは、デフォルトの設定をロードすることで Client を作成します。クライアントの詳細な設定オプションについては、クライアントの設定を参照してください。

前提条件

• UpgradeLink アカウントを既に登録している。
• AccessKey と AccessSecret を取得している。
• URL アプリケーションのアップグレード戦略を設定している。

認証情報の取得

SDK のインストール

• Gradle プロジェクトに依存関係を追加する（推奨方法）

Maven リポジトリアドレスを追加します：

pluginManagement {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

Gradle プロジェクトで SDK を使用するには、build.gradle に対応する依存関係を追加するだけです。dependencies にバージョン 2.3.0 の依存関係を追加する例：

implementation 'com.github.toolsetlink:upgradelink-api-android:2.3.0'

クイック使用

以下のサンプルプログラムは、Client を初期化して URL アプリケーションの最新アップグレード情報を取得する方法を示しています。

URL アプリケーションの最新アップグレード情報の取得 - 同期呼び出し

package com.toolsetlink.upgradelink.api;

import com.toolsetlink.upgradelink.api.models.*;
import org.junit.*;
import java.io.IOException;
import java.util.concurrent.*;

public class SimpleClientTest {

    private Client client;

    @Before
    public void setUp() {
        Config config = new Config();
        config.accessKey = "mui2W50H1j-OC4xD6PgQag";
        config.secretKey = "PEbdHFGC0uO_Pch7XWBQTMsFRxKPQAM2565eP8LJ3gc";
        client = new Client(config);
    }

    @Test
    public void getUrlUpgrade_shouldCallCallbackOnSuccess() throws Exception {
        UrlUpgradeRequest request = new UrlUpgradeRequest(
                "uJ47NPeT7qjLa1gL3sVHqw",
                1,
                0,
                "",
                ""
        );

        try {
            UrlUpgradeResponse response = client.getUrlUpgrade(request);
            System.out.println("getUrlUpgrade request response: " + response.toString());
        } catch (Exception e) {
            // Print exception stack trace
            e.printStackTrace();
            // Let the test fail and give an error message
            Assert.fail("getUrlUpgrade request failed: " + e.getClass().getSimpleName() + ": " + e.getMessage());
        }
    }

}

URL アプリケーションの最新アップグレード情報の取得 - 非同期呼び出し

package com.toolsetlink.upgradelink.api;

import com.toolsetlink.upgradelink.api.models.*;
import org.junit.*;
import java.io.IOException;
import java.util.concurrent.*;

public class SimpleClientTest {

    private Client client;

    @Before
    public void setUp() {
        Config config = new Config();
        config.accessKey = "mui2W50H1j-OC4xD6PgQag";
        config.secretKey = "PEbdHFGC0uO_Pch7XWBQTMsFRxKPQAM2565eP8LJ3gc";
        client = new Client(config);
    }

    @Test
    public void getUrlUpgradeAsync_shouldCallCallbackOnSuccess() throws Exception {
        UrlUpgradeRequest request = new UrlUpgradeRequest(
                "uJ47NPeT7qjLa1gL3sVHqw",
                1,
                0,
                "",
                ""
        );
        CountDownLatch latch = new CountDownLatch(1);

        Client.Callback<UrlUpgradeResponse> callback = new Client.Callback<>() {
            @Override
            public void onSuccess(UrlUpgradeResponse response) {
                System.out.println("getUrlUpgrade request response: " + response.toString());
                latch.countDown();
            }

            @Override
            public void onFailure(Throwable t) {
                t.printStackTrace();
                Assert.fail("getUrlUpgrade request failed: " + t.getClass().getSimpleName() + ": " + t.getMessage());
                latch.countDown();
            }
        };

        client.getUrlUpgradeAsync(request, callback);
        Assert.assertTrue("Test timed out", latch.await(15, TimeUnit.SECONDS));
    }

}