Описание методов Android-фреймворка

Метод auth выполняет аутентификацию пользователя по логину и паролю.

Примечание. Перед выполнением метода убедитесь, что в проекте добавлены учётные данные для источника данных.

hyperHive.authAPI.auth(login, password, updateResources)

Входные параметры:

Пример:

private static final String userName = "user";
private static final String password = "password";
 
public void authentication() {
    boolean status = hyperHive.authAPI.auth(userName, password, true).execute().isOk();
    showStatus(status);
}

После выполнения примера будет получен токен пользователя и результат выполнения аутентификации.

Метод auth выполняет аутентификацию пользователя со сменой пароля. Выполнение метода возвращает новый токен пользователя.

HyperHive.AuthAPI.authWithChangePassword(login, password, updateResources)

Входные параметры:

Пример:

BaseStatus status = hyperHive.authAPI.authWithChangePassword(
        login,
        password
        new_password,
        confirm_password,
        true,
null
).execute();

После выполнения примера будет получен токен пользователя и результат выполнения аутентификации.

Метод unAuth отменяет выполненную аутентификацию пользователя и возвращает экземпляр класса Call.

hyperHive.authAPI.unAuth()

Метод isAuthorized проверяет выполнение аутентификации пользователя и возвращает значение:

• True. Пользователь успешно выполнил аутентификацию;

• False. Пользователь не выполнил аутентификацию.

hyperHive.authAPI.isAuthorized()

Метод openDefaultBase открывает базу данных по умолчанию.

public boolean openDefaultBase(java.lang.String key);

Аргументы:

• key. Ключ к базе данных.

Метод возвращает значение True, если открытие базы данных по умолчанию выполнено успешно, иначе False.

Пример запроса:

openDefaultBase("12345");

Метод openBase открывает или создает базу данных с указанным ключом.

public boolean openBase(java.lang.String pathBase, java.lang.String key);

Аргументы:

• pathBase. Путь к базе данных;

• key. Ключ базы данных.

Если база еще не существует, то будет создана и открыта для работы новая база с использованием указанного ключа для шифрования.

Если база уже существует, то будет выполнена попытка открыть базу с указанным ключом.

Метод возвращает значение True, если открытие или создание базы данных выполнено успешно, иначе False.

Пример запроса:

openBase("my_database", "12345");

Метод служит для получения схемы доступных ресурсов и автоматического создания в базе данных соответствующих таблиц. Метод возвращает экземпляр класса Call. Метод обязательно выполняется после успешной аутентификации.

Если используемая база данных должна быть зашифрована, необходимо перед вызовом этого метода открыть базу данных с ключом шифрования:

resources(final String database, final Map<String, String> headers)

Метод query выполняет SQL-запрос к указанной базе данных.

Возможно несколько вариантов использования метода:

1. Запрос:

public com.mobrun.plugin.api.Call<java.lang.String>
query(@NonNull java.lang.String query);

Аргументы:

• query. Запрос SQLite к указанной базе данных.

Метод возвращает экземпляр класса Call с результатом в строке.

Пример запроса:

query("SELECT * FROM my_table);

Ответ:

BaseStatusV08{status=OK, httpStatus=HttpStatus{status=200, ... }

2. Запрос:

public <T extends com.mobrun.plugin.models.BaseStatus>
com.mobrun.plugin.api.Call<T>
query(@NonNull java.lang.String query, java.lang.Class<T> tClass);

Аргументы:

• query. Запрос SQLite к указанной базе данных;

• tClass. Ожидаемый класс для разбора.

Метод возвращает экземпляр класса Call с результатом в BaseStatus.

Пример запроса:

query("SELECT * FROM my_table, MyClass.class);

3. Запрос:

public com.mobrun.plugin.api.Call<java.lang.String>
query(@NonNull java.lang.String databasePath,
      @NonNull java.lang.String query);

Аргументы:

• databasePath. Путь к базе данных;

• query. Запрос SQLite к указанной базе данных.

Метод возвращает экземпляр класса Call с результатом в строке.

Пример запроса:

query("my_database", "SELECT * FROM my_table);

Ответ:

BaseStatusV08{status=OK, httpStatus=HttpStatus{status=200, ... }

4. Запрос:

public <T extends com.mobrun.plugin.models.BaseStatus>
com.mobrun.plugin.api.Call<T>
query(@NonNull java.lang.String databasePath,
      @NonNull java.lang.String query, java.lang.Class<T> tClass);

Аргументы:

• databasePath. Путь к базе данных;

• query. Запрос SQLite к указанной базе данных;

• tClass. Ожидаемый класс для разбора.

Метод возвращает экземпляр класса Call с результатом в BaseStatus.

Пример запроса:

query("my_database", "SELECT * FROM my_table, MyClass.class);

Метод getTablesName возвращает наименование таблицы.

Возможно несколько вариантов использования метода:

1. Запрос:

public com.mobrun.plugin.api.Call<java.lang.String>
getTablesName(@NonNull java.lang.String resourceName,
              @NonNull java.lang.String params);

Аргументы:

• resourceName. Путь к базе данных;

• params. Передаваемые параметры.

Метод возвращает экземпляр класса Call с результатом в строке.

Пример запроса:

getTablesName("postgres_fruits", "{\"upsert_rows\": [[\"10001\", \"fruits10001\"]], \"delete_ids\": null}");

Ответ:

BaseStatusV08{status=OK, httpStatus=HttpStatus{status=200, ... }

2. Запрос:

public <T extends com.mobrun.plugin.models.BaseStatus>
com.mobrun.plugin.api.Call<T>
getTablesName(@NonNull java.lang.String resourceName,
              @NonNull java.lang.String params, java.lang.Class<T> tClass);

Тип класса <T>.

Аргументы:

• resourceName. Путь к базе данных;

• params. Передаваемые параметры;

• tClass. Ожидаемый класс для разбора.

Метод возвращает экземпляр класса Call с результатом в BaseStatus.

Пример запроса:

getTablesName("postgres_fruits", "{\"upsert_rows\": [[\"10001\", \"fruits10001\"]], \"delete_ids\": null}", BaseStatus.class);

Ответ:

BaseStatusV08{status=OK, httpStatus=HttpStatus{status=200, ... }

3. Запрос:

public com.mobrun.plugin.api.Call<java.lang.String>
getTablesName(@NonNull java.lang.String databasePath,
              @NonNull java.lang.String resourceName,
              @NonNull java.lang.String params);

Аргументы:

• databasePath. Путь к базе данных;

• resourceName. Имя ресурса;

• params. Передаваемые параметры.

Метод возвращает экземпляр класса Call с результатом в строке.

Пример запроса:

getTablesName("my_database", "postgres_fruits", "{\"upsert_rows\": [[\"10001\", \"fruits10001\"]], \"delete_ids\": null}");

Ответ:

BaseStatusV08{status=OK, httpStatus=HttpStatus{status=200, ... }

4. Запрос:

public <T extends com.mobrun.plugin.models.BaseStatus>
com.mobrun.plugin.api.Call<T>
getTablesName(@NonNull java.lang.String databasePath,
              @NonNull java.lang.String resourceName,
              @NonNull java.lang.String params, java.lang.Class<T> tClass);

Тип класса <T>.

Аргументы:

• databasePath. Путь к базе данных;

• resourceName. Имя ресурса;

• params. Передаваемые параметры;

• tClass. Ожидаемый класс для разбора.

Метод возвращает экземпляр класса Call с результатом в BaseStatus.

Пример запроса:

getTablesName("my_database", "postgres_fruits", "{\"upsert_rows\": [[\"10001\", \"fruits10001\"]], \"delete_ids\": null}", BaseStatus.class);

Ответ:

BaseStatusV08{status=OK, httpStatus=HttpStatus{status=200, ... }

Метод dropCache удаляет таблицы из базы данных.

Возможно несколько вариантов использования метода:

1. Запрос:

public com.mobrun.plugin.api.Call<java.lang.String>
dropCache(@NonNull java.lang.String resourceName,
          @NonNull java.lang.String params);

Аргументы:

• resourceName. Имя ресурса;

• params. Передаваемые параметры.

Метод возвращает экземпляр класса Call с результатом в строке.

Пример запроса:

dropCache("postgres_fruits", "{\"upsert_rows\": [[\"10001\", \"fruits10001\"]], \"delete_ids\": null}");

Ответ:

BaseStatusV08{status=OK, httpStatus=HttpStatus{status=200, ... }

2. Запрос:

public <T extends com.mobrun.plugin.models.BaseStatus>
com.mobrun.plugin.api.Call<T>
dropCache(@NonNull java.lang.String resourceName,
          @NonNull java.lang.String params, java.lang.Class<T> tClass);

Тип класса <T>.

Аргументы:

• resourceName. Имя ресурса;

• params. Передаваемые параметры;

• tClass. Ожидаемый класс для разбора.

Метод возвращает экземпляр класса Call с результатом в BaseStatus.

Пример запроса:

dropCache("postgres_fruits", "{\"upsert_rows\": [[\"10001\", \"fruits10001\"]], \"delete_ids\": null}", BaseStatus.class);

Ответ:

BaseStatusV08{status=OK, httpStatus=HttpStatus{status=200, ... }

3. Запрос:

public com.mobrun.plugin.api.Call<java.lang.String>
dropCache(@NonNull java.lang.String databasePath,
          @NonNull java.lang.String resourceName,
          @NonNull java.lang.String params);

Аргументы:

• databasePath. Путь к базе данных.

• resourceName. Имя ресурса;

• params. Передаваемые параметры.

Метод возвращает экземпляр класса Call с результатом в строке.

Пример запроса:

dropCache("my_database", "postgres_fruits", "{\"upsert_rows\": [[\"10001\", \"fruits10001\"]], \"delete_ids\": null}");

Ответ:

BaseStatusV08{status=OK, httpStatus=HttpStatus{status=200, ... }

4. Запрос:

public <T extends com.mobrun.plugin.models.BaseStatus>
com.mobrun.plugin.api.Call<T>
dropCache(@NonNull java.lang.String databasePath,
          @NonNull java.lang.String resourceName,
          @NonNull java.lang.String params, java.lang.Class<T> tClass);

Тип класса <T>.

Аргументы:

• databasePath. Путь к базе данных.

• resourceName. Имя ресурса;

• params. Передаваемые параметры;

• tClass. Ожидаемый класс для разбора.

Метод возвращает экземпляр класса Call с результатом в BaseStatus.

Пример запроса:

dropCache("my_database", "postgres_fruits", "{\"upsert_rows\": [[\"10001\", \"fruits10001\"]], \"delete_ids\": null}", BaseStatus.class);

Ответ:

BaseStatusV08{status=OK, httpStatus=HttpStatus{status=200, ... }

Метод closeDefaultBase закрывает базу данных по умолчанию.

public boolean closeDefaultBase();

Метод возвращает значение True, если закрытие базы данных по умолчанию выполнено успешно, иначе False.

Метод closeBase закрывает базу данных.

public boolean closeBase(java.lang.String pathBase);

Аргументы:

• pathBase. Путь к базе данных.

Метод возвращает значение True, если закрытие базы данных выполнено успешно, иначе False.

Пример запроса:

closeBase("my_database");

Метод setArgs добавляет параметры запроса.

public void setArgs(java.util.Map<java.lang.String,java.lang.String> args);

Аргументы:

• args. Принимает «Map» с параметрами ключ-значение.

Пример:

• аргументы:

HashMap hashMap = new HashMap<>();
hashMap.put("hh_limit", "5");

• запрос:

http://10.30.300.30/...?...&hh_limit=5&...

Метод служит для выполнения универсального запроса к ресурсу с произвольными параметрами. Доступные параметры указаны в классе RequestCallParams. Метод возвращает экземпляр класса Call.

request(@NonNull final String resourceName, final RequestCallParams requestCallParams, final Class<T> tClass)

Метод служит для выполнения запроса к WEB-ресурсу с произвольными параметрами. Доступные параметры указаны в классе WebCallParams. Метод возвращает экземпляр класса Call.

Вызывать метод необходимо при наличии схемы доступных ресурсов, полученной методом Resources после успешной аутентификации.

web(@NonNull final String resourceName, WebCallParams webCallParams, final Class<T> tClass)

Метод служит для обновления и актуализации ресурса с помощью delta-stream в локальной базе данных. Доступные параметры указаны в классе DeltaStreamCallParams. Метод возвращает экземпляр класса Call.

Вызывать метод необходимо при наличии схемы доступных ресурсов, полученной методом Resources после успешной аутентификации.

deltaStream(String resource, DeltaStreamCallParams deltaStreamCallParams, Class<T> tClass)

Метод служит для обновления и актуализации некэшируемого ресурса с помощью delta-stream в локальной базе данных. Доступные параметры указаны в классе DeltaStreamCallParams. Метод возвращает экземпляр класса Call.

Вызывать метод необходимо при наличии схемы доступных ресурсов, полученной методом Resources после успешной аутентификации.

tableStream(String resource, TableStreamCallParams deltaStreamCallParams, Class<T> tClass)

Метод служит для получения табличных данных ресурса. Доступные параметры указаны в классе TableCallParams. Метод возвращает экземпляр класса Call.

table(String resource, TableCallParams tableCallParams, Class<T> tClass)

При получении данных из кэшируемого источника есть возможность ограничить набор возвращаемых данных по условиям, переданным в аргументах.

Аргументы для выборки можно задать в tableCallParams с помощью метода setArgs(Map<String, String> args).

Аргументы для пагинации:

• hh_order. Задает имя столбца для упорядочивания строк и порядка сортировки. Примеры: {hh_order, name+asc}, {hh_order, name+desc};

• hh_skip. Задает число строк таблицы, которые нужно пропустить при формировании ответа;

• hh_limit. Задает число строк таблицы, которые нужно вернуть в ответе.

Аргумент для фильтрации по значению «col_id=value» – аргумент имеет название вида «col_<column_name>». Например: «col_id=123», вернет только данные, где в столбце id установлено значение 123.

Метод устанавливает RequestErrorListener для перехвата обработки любых ошибок, возникающих при выполнении запросов в RequestAPI. Для отписки можно выполнить метод setRequestErrorListener(null):

void setRequestErrorListener(RequestErrorListener requestErrorListener)

Метод возвращает список токенов, привязанных к пользователю на сервере.

getTokens()

Метод служит для отправки токена на сервер.

addToken(@NonNull final String token)

Метод служит для удаления переданных токенов с сервера.

removeTokens(@NonNull final List<String> tokens)

Метод возвращает список тем сообщений с дополнительной информацией, доступных для пользователя.

getTopics()

Метод служит для подписки на сообщения сервера с соответствующими топиками (темами). Метод возвращает экземпляр класса Call.

subscribe(final List<String> topics)

Метод служит для отписки от сообщений сервера с соответствующими топиками (темами).

unsubscribe(@NonNull final List<String> topics)

Метод служит для инициации автоматической отправки логов по расписанию, полученному от сервера. Если инициирование выполнено успешно, возвращает значение true, иначе - false. Метод необходимо запускать после успешной аутентификации.

Метод необходимо запускать после успешной аутентификации. Если база данных должна быть зашифрована, перед вызовом метода нужно открыть базу данных с ключом шифрования.

initLogging()

Метод служит для установки минимального уровня логирования:

setLogLevel(int level)

Аргумент level принимает значения:

• 4. LOG_INFO;

• 5. LOG_WARNING;

• 6. LOG_ERROR.

Каждый из методов сохраняет сообщение в журнале логов с указанием текущего времени и уровня логирования.

logTrace(@NonNull String message),
logWarning(@NonNull String message),
logFatal(@NonNull String message)

Метод служит для сохранения текущего состояния (авторизационные данные и схема ресурсов) в базу данных. Метод возвращает значение true, если сохранение выполнено успешно, и false в ином случае.

saveStateToDB(String dbPath)

Метод служит для восстановления состояния (авторизационные данные и схема ресурсов) из базы данных. Метод возвращает значение true, если восстановление выполнено успешно, и false в ином случае.

После восстановления состояния все открытые базы данных закрываются. При необходимости работы с зашифрованной базой данных после восстановления, её необходимо открыть с ключом шифрования, иначе все последующие запросы к этой базе данных будут безуспешны.

restoreStateFromDb(String dbPath)

Метод служит для выдачи информации о версии используемого ядра:

getVersionCoreAPI(int depth)

Аргумент depth влияет на формат информации:

• 1. Самый краткий формат;

• 4. Самый подробный формат.

Метод служит для выдачи информации о версии используемого плагина:

getVersionPlugin()

Метод служит для сохранения в таблицу с именем «hhivePreference», для указанной базы данных dbPath, значение «value» с ключом «key». Метод возвращает значение true, если сохранение выполнено успешно, и false в ином случае.

boolean saveParamToDB(String dbPath, String key, String value)

Метод служит для получения значения параметра с ключом «key» из таблицы с именем «hhivePreference», для указанной базы данных dbPath. Метод возвращает значение параметра, если он есть в таблице, и «null» в ином случае.

String getParamFromDB(String dbPath, String key)