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

Для разработки мобильного приложения в запросах к серверу мобильной платформы используются методы Android-фреймворка основного класса HyperHive.

Примечание. Перед выполнением методов выполните аутентификацию на сервере мобильной платформы с помощью метода аутентификации auth или authWithChangePassword.

Методы аутентификации

Методы аутентификации реализованы в модуле AuthAPI, экземпляр которого доступен в классе HyperHive (hyperHive.authAPI).

Аутентификация пользователя по логину и паролю (auth)

Аутентификация пользователя со сменой пароля (authWithChangePassword)

Отмена аутентификации (unAuth)

Проверка аутентификации пользователя (isAuthorized)

Использование методов приведено в примерах «Примеры аутентификации на сервере мобильной платформы».

Метод проверки доступности сервера

Проверка доступности сервера мобильной платформы (connectionStatus)

Использование метода приведено в примере «Пример проверки доступности сервера мобильной платформы».

Методы работы с локальной базой данных

Методы данной области реализованы в модуле DatabaseAPI, экземпляр которого доступен в классе HyperHive (hyperHive.databaseAPI).

Открытие базы данных по умолчанию (openDefaultBase)

Смена ключа шифрования базы данных (reKeyBase)

Открытие или создание базы данных (openBase)

Загрузка схемы ресурсов (resources)

SQL-запрос к базе данных (query)

Получение наименования таблицы (getTablesName)

Удаление таблиц из базы данных (dropCache)

Закрытие базы данных по умолчанию (closeDefaultBase)

Закрытие базы данных (closeBase)

Использование методов приведено в разделе «Примеры работы с ресурсами».

Методы работы с ресурсами

Методы данной области реализованы в модуле RequestAPI, экземпляр которого доступен в классе HyperHive (hyperHive.requestAPI).

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

Добавление параметров запроса (setArgs)

Запрос к ресурсу без загрузки в базу данных (request)

Запрос к WEB-ресурсу (web)

Загрузка дельты в базу данных (deltaStream)

Загрузка табличных данных в базу данных (tableStream)

Получение табличных данных ресурса без загрузки в базу данных (table)

Установка глобального обработчика ошибок (setRequestErrorListener)

Возобновление загрузки ресурса (setUseDownload)

Установка пути к папке с файлами текущего состояния загрузки ресурса (setDownloadPath)

Использование методов приведено в разделе «Примеры работы с ресурсами».

Методы работы с рush-уведомлениями

Методы данной области реализованы в модуле PushAPI, экземпляр которого доступен в классе HyperHive (hyperHive.pushAPI).

Получение списка активных токенов (getTokens)

Отправка токена на сервер (addToken)

Удаление токенов с сервера (removeTokens)

Получение списка тем сообщений (getTopics)

Подписка на сообщения (subscribe)

Отписка от сообщений (unsubscribe)

Использование методов приведено в разделе «Пример работы с push-уведомлениями».

Методы работы с файлами

Скачивание файла с сервера (fileGet)

Загрузка файла на сервер (filePut)

Расшифровка файла в новый файл или в буфер памяти (fileDecrypt)

Использование методов приведено в разделе «Пример работы с файлами».

Методы работы с логами

Методы данной области реализованы в модуле LoggingAPI, экземпляр которого доступен в классе HyperHive (hyperHive.loggingAPI).

Логирование (initLogging())

Установка уровня логирования (setLogLevel)

Вывод лога работы фреймворка в консоль (setLogEnabled)

Создание логов (logTrace, logWarning, logFatal)

Методы работы с состояниями

Методы данной области реализованы в модуле StateAPI, экземпляр которого доступен в классе HyperHive (hyperHive.stateAPI).

Сохранение состояния в базу данных (saveStateToDB())

Восстановление состояния из базы данных (restoreStateFromDB())

Версия ядра (getVersionCoreAPI)

Версия плагина (getVersionPlugin)

Сохранение произвольного параметра в базу данных (saveParamToDB())

Получение значения параметра из базы данных (getParamFromDB())

Для инициализации и настройки Android обратитесь к разделу «Инициализация Android-фреймворка».

Для просмотра примеров использования Android-фреймворка обратитесь к разделу «Примеры использования Android-фреймворка».

См. также:

Фреймворк Android | Инициализация Android-фреймворка | Примеры использования Android-фреймворка