Документация содержит описание продукта HyperHive версии 2.0.12 (стр. 16 )

- (void)getResourceDeltaFromURL:(NSString * _Nonnull)sBaseURL

  resourceName:(NSString * _Nonnull)sResourceName

  parameters:(NSString * _Nullable)sParams

  completionHandler:(HHFWCompletionHandler _Nullable)handler;

Логирование

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

- (bool)performLogging:(NSString * _Nullable)dbName;

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

Метод устанавливает минимальный уровень логирования. nLogLevel может принимать следующие значения:
4 - LOG_INFO
5 - LOG_WARNING
6 - LOG_ERROR

- (void)setLogLevel:(int)nLogLevel;

Создание логов

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

- (void)logTrace:(NSString * _Nullable)msg;

- (void)logWarning:(NSString * _Nullable)msg;

- (void)logFatal:(NSString * _Nullable)msg;

Чтение sessionId (readCookie)

Метод служит для получения sessionId после авторизации. Метод принимает блок “handler”(

- (void)readCookie:(HHFWCompletionHandler _Nullable)handler;

Запрос к локальной базе

Метод служит для создания запросов к локальной базе SQLite. Содержит параметры:

base - путь к базе;

query - SQL запрос;

- (NSDictionary *)queryWithBaseName:(NSString*)base query:(NSString*)query;

Режим проверки сертификата (setSslChecks)

Метод устанавливает режим проверки сертификата защищенного соединения.

Для отключения проверки сертификата нужно передать в параметр enable значение "false". Для включения - "true".

По умолчанию проверка сертификата включена.

- (void)setSLLChecks:(BOOL)bEnabled;

5.6 Фреймворк WinCE

Данный раздел содержит материалы, относящиеся к мобильному фреймворку WinCe.

5.6.1 Подключение WinCE-фреймворка в проект

Для подключения Windows CE фреймворка в проект разработки мобильного приложения необходимо выполнить следующие шаги:

1) Загрузить архив с WinCE-фреймворком

2) Разархивировать файл hhive-fmwk-wince. zip в папку с проектом.

3) Используя Visual Studio 2008, добавить ссылку на библиотеку HyperHive. dll, для этого необходимо:

a) Нажать в окне Solution Explorer правой кнопкой мыши на пункт References и выбрать меню Add reference…

b) Выбрать вкладку Browse и найти в папке проекта файл HyperHive. dll.

c) Нажать OK.

4) Используя Visual Studio 2008 добавить остальные библиотеки в качестве контента, для этого необходимо:

a) Нажать в окне Solution Explorer кнопку Show All Files:

b) Найти в списке Solution Explorer файлы:

Newtonsoft. pact. dll

SQLite. Interop.104.dll

System. Data. SQLite. dll

System. Data. SqlServerCe. dll

c) Для каждого файла нажать правой кнопкой мыши на файл и выбрать меню Include in Project:

d) Для каждого файла перейти в окно Properties и указать для поля Build Action значение Content и для поля Copy to Output Directory значение Copy always:

5) Собрать проект.

5.6.2 Инициализация и настройка в рамках WinCE-фреймворка

Главный класс для вызова методов API называется HHive. При создании его экземпляра необходимо указать параметры проекта для инициализации. Для этого используется класс HyperHiveState.

Ниже показан пример инициализации HyperHive в классе Program:

Expand source 

using System;

using HyperHive;

using HyperHive. Models;

namespace SmartDeviceProject

{

  static class Program

  {

  // Статическое свойство для получения HyperHive

  public static HHive HyperHive { get; private set; }

  /// <summary>

  /// The main entry point for the application.

  /// </summary>

  [MTAThread]

  static void Main()

  {

  // Задаем параметры для работы с HyperHive

  var hhState = new HyperHiveState

  {

  Host = "test. sp. ",

  Environment = "test",

  Project = "project",

  Application = "app"

  }; 

  // Создаем объект класса HHive на основе выставленных параметров

  HyperHive = new HHive(hhState);

  }

  }

}

5.6.3 Вызов методов WinCE

В Windows CE-фреймворке все методы выполняются синхронно.

Большинство методов возвращают экземпляр класса OperationResult, который содержит свойство Success, указывающий на успешность выполнения метода и свойство Message, которое содержит описание ошибки или информацию, возвращаемую методом.

Expand source 

namespace HyperHive. Models

{

  public class OperationResult

  {

  public bool Success { get; private set; }

  public string Message { get; private set; }

  }

}

5.6.4 Описание методов WinCE

Методы авторизации пользователя

Авторизация пользователя по логину и паролю

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

public OperationResult Auth(string login,

  string password,

  string deviceId)

Выход из режима авторизованного пользователя (UnAuth)

Метод служит для выхода из режима авторизованного пользователя.

public OperationResult UnAuth()

Проверка авторизации пользователя (IsAuthorized)

Свойство служит для проверки авторизации пользователя. Свойство возвращает значение true, если пользователь авторизован, и false - если пользователь не авторизован.

public bool IsAuthorized { get; }

Загрузка структуры доступных ресурсов

Загрузка структуры доступных ресурсов (LoadResourceDescriptions)

Метод служит для загрузки структур (входных и выходных параметров) доступных пользователю ресурсов. Данная структура сохраняется в виде списка внутри класса HHive.

public OperationResult LoadResourceDescriptions()

Получение структуры ресурса

Получение структуры ресурса (GetResourceDescription)

Метод служит для получения структуры (входных и выходных параметров) заданного ресурса. Если структура не найдена в сохраненном списке внутри класса HHive автоматически вызывается метод LoadResourceDescriptions. Метод возвращает экземпляр класса TableModel, который содержит название ресурса и список колонок.

public TableModel GetResourceDescription(string resourceName)

Получение дельты ресурса

Получение дельты ресурса (LoadDelta)

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

public OperationResult LoadDelta(string resourceName)

Получение ресурса без сохранения локально

Получение ресурса без сохранения локально (GetResourceWithoutSave)

Метод служит для получения ресурса в формате JSON без сохранения их в локальной базе данных. Метод возвращает экземпляр класса OperationResult, свойство Message которого содержит JSON данные по ресурсу.

public OperationResult GetResourceWithoutSave(string resourceName)

Отправка данных в таблицу

Отправка данных в таблицу (TablePost)

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

public OperationResult TablePost(string resourceName, string jsonData)

Отправка данных в таблицу

Отправка данных в таблицу (TablePostWithoutSave)

Метод служит для отправки данных на сервер. При вызове данного метода выполняется отправка данных в соответствующий ресурс на сервер. Метод возвращает экземпляр класса OperationResult, свойство Message которого содержит ответ в формате JSON.

public OperationResult TablePostWithoutSave (string resourceName, string jsonData)

Получение сервиса для работы с базой данных

Получение сервиса для работы с базой данных (GetDataBaseService)

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

public DataBaseService GetDataBaseService(string resourceName)

5.7 Фреймворк Cordova

Данный раздел содержит материалы, относящиеся к мобильному фреймворку Cordova.

5.7.1 Подключение Cordova-фреймворка в проект

Для подключения Cordova-фреймворка в проект разработки мобильного приложения необходимо выполнить следующие шаги:

1. Загрузить архив с Cordova-фреймворком (см. материал Загрузка дистрибутивов HyperHive). 


2. Разархивировать файл hhive-framework-cordova. zip;

3. Способ добавления плагина в приложение: cordova plugin add cordova-plugin-hhive;

5.7.2 Инициализация и настройка в рамках Cordova-фреймворка

Инициализация объекта плагина:

Expand source 

Init(host, apiVersion, environmentSlug, projectSlug, applicationSlug, deviceID);

host – адрес сервера (http://, http://eigenmethod. ru и т. п.);

apiVersion – версия API поддерживаемая сервером и плагином (v0.6);

environmentSlug – название среды в HH (environment, env и т. п.);

projectSlug – название проекта в HH (project, proj и т. п.);

applicationSlug – название приложения в HH (application, app и т. п.);

deviceID – id устройства в HH (Создается автоматически, если в системе HH такого нет. Возможно любое значение).