Быстрый старт с Android SDK

В этом документе представлено руководство быстрого старта по выполнению обычных операций с использованием Android SDK. Вы узнаете, как установить SDK, настроить учетные данные доступа и выполнить базовые операции, такие как получение последней информации об обновлении.

Примечания

• Чтобы делать запросы с помощью Android SDK, вам нужно инициализировать экземпляр Client. В этом документе создается Client путем загрузки стандартных конфигураций. Для получения дополнительных вариантов конфигурации клиента обратитесь к разделу Настройка клиента.

Предварительные требования

• Уже зарегистрирована учетная запись UpgradeLink.
• Получены AccessKey и AccessSecret.
• Настроена стратегия обновления URL-приложения.

Получение учетных данных

Установка SDK

• Добавление зависимостей в Gradle-проект (рекомендуемый метод)

Добавьте адрес Maven-репозитория:

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

Чтобы использовать SDK в Gradle-проекте, просто добавьте соответствующую зависимость в build.gradle. В качестве примера добавления зависимости для версии 2.3.0 в dependencies:

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) {
            // Вывод стека исключения
            e.printStackTrace();
            // Сделать тест неудачным и выдать сообщение об ошибке
            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));
    }

}