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

Методы во фреймворке разделены на несколько категорий, каждая из которых содержит соответствущие методы:

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

Методы данной области реализованы в свойстве AuthApi, которое доступно в классе HyperHive (hyperHive.AuthApi).

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

AuthAsync(string login, string password, IDictionary<string, string> headers);

Аргументы:

login. Логин пользователя;
password. Пароль пользователя;
headers. Словарь с дополнительными HTTP-заголовками.

Примечание. Аргумент может принимать значение «null».

Метод возвращает экземпляр класса Task<string>.

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

Logout();

Метод возвращает экземпляр класса Task<string>.

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

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

ResourcesAsync(string dataBase, IDictionary<string, string> headers);

Аргументы:

dataBase. Имя файла с базой;
headers. Словарь с дополнительными HTTP-заголовками.

Примечание. Аргумент может принимать значение «null».

Метод возвращает экземпляр класса Task<string>.

Метод SetSslChecks служит для установки режима проверки сертификатов при установке TLS/SSL соединения.

SetSslChecks(bool enable);

Аргументы:

enable. Признак включения или отключения проверки.

Метод возвращает значение типа «bool».

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

Методы данной области реализованы в свойстве DatabaseApi, которое доступно в классе HyperHive (hyperHive.DatabaseApi).

Метод OpenDatabase служит для создания или открытия зашифрованной базы данных.

OpenDatabase(string database, string key);

Аргументы:

database. Путь к базе, содержащий имя базы, в рамках папки приложения;
key. Пароль к базе.

Примечание. Пароль может быть пустой строкой.

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

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

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

Метод CloseDatabase служит для закрытия базы данных по указанному пути.

CloseDatabase(string database);

Аргументы:

database. Путь к базе, содержащий имя базы.

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

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

ExecuteQueryForResourceAsync(string database, string query);

Аргументы:

database. Путь к базе, содержащий имя базы;
query. SQL-запрос.

Метод возвращает экземпляр класса Task<string>.

Метод GetTablesNamesAsync предназначен для получения списка таблиц ресурса.

GetTablesNamesAsync(string database, string resource, string parameters, string table);

Аргументы:

database. Путь к базе, содержащий имя базы;
resource. Имя ресурса;
parameters. Параметры, при которых были получены данные ресурса;
table. Имя таблицы для фильтрации.

Метод возвращает экземпляр класса Task<string>.

Метод DropCacheAsync предназначен для удаления сохраненных данных ресурса с параметрами.

DropCacheAsync(string database, string resource, string parameters);

Аргументы:

database. Путь к базе, содержащий имя базы;
resource. Имя ресурса;
parameters. Параметры, при которых были получены данные ресурса.

Метод возвращает экземпляр класса Task<string>.

Методы работы с цифровой подписью (DSS)

Методы данной области реализованы в свойстве DssApi, которое доступно в классе HyperHive (hyperHive.DssApi).

Метод CertificatesAsync служит для запроса списка сертификатов пользователя в системе DSS.

CertificatesAsync(string password);

Аргументы:

password. Пароль DSS.

Метод возвращает экземпляр класса Task<string>.

Метод SignAsync предназначен для создания подписи документа по адресу ячейки таблицы.

SignAsync(string resource, string table, string parameters, string column, string rowId, string password, string certificateId, string certificatePin);

Аргументы:

resource. Имя ресурса;
table. Имя таблицы;
parameters. Значения параметров ресурса в виде JSON;
column. Идентификатор колонки;
rowId. Идентификатор строки;
password. Пароль DSS;
certificateId. Идентификатор сертификата DSS;
certificatePin. Пин-код сертификата DSS.

Метод возвращает идентификатор подписи, если создание прошло успешно, и экземпляр класса Task<string>.

Метод SignsAsync предназначен для получения истории подписей для конкретного пользователя и устройства.

SignsAsync();

Метод возвращает экземпляр класса Task<string>.

Метод SignRemoveAsync служит для запроса удаления подписи по её идентификатору.

SignRemoveAsync(int signId);

Аргументы:

signId. Идентификатор подписи.

Метод возвращает экземпляр класса Task<string>.

Методы файлового коннектора

Методы данной области реализованы в свойстве FileConnectorApi, которое доступно в классе HyperHive (hyperHive.FileConnectorApi).

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

GetDirectoryAsync(string mountName, string directoryName);

Аргументы:

mountName. Имя точки монтирования на сервере;
directoryName. Путь директории относительно точки монтирования.

Примечание. Если задать только «./», то вернется содержимое корневой папки.

Метод возвращает экземпляр класса Task<string>.

Метод GetFileMetaAsync служит для создания запроса на получение информации о файле на сервере.

GetFileMetaAsync(string mountName, string fileName);

Аргументы:

mountName. Имя точки монтирования на сервере;
fileName. Путь к файлу относительно точки монтирования.

Метод возвращает экземпляр класса Task<string>.

Метод GetFileAsync служит для создания запроса получения файла с сервера.

GetFileAsync(string mountName, string fileName);

Аргументы:

mountName. Имя точки монтирования на сервере;
fileName. Путь к файлу относительно точки монтирования.

Метод возвращает экземпляр класса Task<string>.

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

PutFileAsync(string mountName, string fileNameTo, string fileNameFrom);

Аргументы:

mountName. Имя точки монтирования на сервере;
fileNameTo. Путь загрузки файла относительно точки монтирования;
fileNameFrom. Путь к загружаемому файлу.

Метод возвращает экземпляр класса Task<string>.

Метод DeleteFileAsync служит для создания запроса удаления файла с сервера.

DeleteFileAsync(string mountName, string fileName)

Аргументы:

mountName. Имя точки монтирования на сервере;
fileName. Путь к файлу относительно точки монтирования.

Метод возвращает экземпляр класса Task<string>.

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

Методы данной области реализованы в свойстве LoggingApi, которое доступно в классе HyperHive (hyperHive.LoggingApi).

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

SetLogLevel(LogLevels level);

Аргументы:

LogLevels. Перечисление:

Database. Работа с базой данных;
Verbose. Детальная информация для отладки и тестирования;
Debug. Отладочная информация для разработчика;
Info. Информация, полезная пользователю сдк (статистика, ключевые настройки, статус старта/остановки и другое);
Warning. Предупреждение. Пользователю/разработчику следует обратить внимание на результат работы приложения;
Error. Ошибка, после которой приложение может работать, но результаты могут быть неожиданными;
Assert. Приложение не работает;
Output. Стандартный вывод.

Метод возвращает значение типа «int».

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

SetLogFileName(string dbFileName, string key);

Аргументы:

dbFileName. Имя базы данных;
key. Пароль к базе.

Примечание. Пароль может быть пустой строкой.

Метод возвращает значение типа «bool».

Методы для логирования событий с выбранным уровнем.

Log(string message, LogLevels level);

LogInfo(string message);

LogWarning(string message);

LogError(string message);

Аргументы:

message. Текст лога;
LogLevels. Уровень логирования.

Все методы синхронные и ничего не возвращают.

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

SyncLogsAsync(bool remove);

Аргументы:

remove. Признак удаления.

Метод возвращает экземпляр класса Task<string>.

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

SyncLogsScheduleAsync();

Метод возвращает экземпляр класса Task<string>.

Методы запросов к ресурсам

Методы данной области реализованы в свойстве RequestApi, которое доступно в классе HyperHive (hyperHive.RequestApi).

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

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

WebRequestAsync(string resource, WebCallParams webCallParams);

Аргументы:

resource. Имя ресурса;
webCallParams. Объект, содержащий параметры запроса к WEB-ресурсу.

Метод возвращает экземпляр класса Task<string>.

Описание модели запроса:

public sealed class WebCallParams
{

// Данные, передаваемые в теле запроса.

public string Data { get; set; }

// Словарь с дополнительными HTTP заголовками.

public IDictionary<string, string> Headers { get; set; }

// Количество повторений запроса.

public int? RetryCount { get; set; }

// Интервал между повторениями.

public int? RetryIntervalSec { get; set; }

// Имя файла для сохранения данных.

public string FileName { get; set; }

}

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

ToDatabaseRequestAsync(string resource, DatabaseCallParams databaseCallParams);

Аргументы:

resource. Имя ресурса;
databaseCallParams. Объект, содержащий параметры запроса для получения данных ресурса.

Метод возвращает экземпляр класса Task<string>.

Описание модели запроса:

public sealed class DatabaseCallParams

{

// Путь к базе включая имя базы.

public string Database { get; set; }

// Идентификатор транзакции (задается только для ресурса с табличными параметрами).

public string TransactionId { get; set; }

// Данные, передаваемые в теле запроса.

public string Data { get; set; }

// Количество повторений запроса.

public int? RetryCount { get; set; }

// Интервал между повторениями.

public int? RetryIntervalSec { get; set; }

// Признак того, что необходимо запрашивать лишь дельту табличных данных ресурса, в противном случае будут запрошены табличные данные ресурса в формате TableStream.

public bool DeltaOnly { get; set; }

}

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

ToFileRequestAsync(string resource, FileCallParams fileCallParams);

Аргументы:

resource. Имя ресурса;
fileCallParams. Объект, содержащий параметры запроса для получения данных ресурса с записью в файл.

Метод возвращает экземпляр класса Task<string>.

Описание модели запроса:

public sealed class FileCallParams

{

// Идентификатор транзакции (задается только для ресурса с табличными параметрами).

public string TransactionId { get; set; }

// Данные, передаваемые в теле запроса.

public string Data { get; set; }

// Количество повторений запроса.

public int? RetryCount { get; set; }

// Интервал между повторениями.

public int? RetryIntervalSec { get; set; }

// Имя файла для сохранения данных (если не задано - данные попадают в локальную БД).

public string FileName { get; set; }

public bool DeltaOnly { get; set; }

}

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

Методы данной области реализованы в свойстве StateApi, которое доступно в классе HyperHive (hyperHive.StateApi).

Метод SetState служит для сохранения текущего состояния.

SetState(string state);

Аргументы:

state. Состояние.

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

Метод GetState служит для получения состояния.

GetState();

Метод возвращает строковое значение типа «string».

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

GetVersionCoreApi(int depth);

Аргументы:

depth. Глубина.

Метод возвращает значение типа «string».

Методы Id транзакций

Методы данной области реализованы в свойстве TransactionApi, которое доступно в классе HyperHive (hyperHive.TransactionApi).

Метод TransactionsAsync служит для получения истории транзакций для текущего пользователя и устройства.

TransactionsAsync(string resource);

Аргументы:

resource. Имя ресурса.

Метод возвращает экземпляр класса Task<string>.

Метод TransactionAsync служит для получения транзакции по идентификатору транзакции для текущего пользователя и устройства.

TransactionAsync(string resource, string transactionId);

Аргументы:

resource. Имя ресурса;
transactionId. Идентификатор транзакции.

Метод возвращает экземпляр класса Task<string>.

Метод TransactionDeleteAsync предназначен для удаления записи о запросе из списка транзакций.

TransactionDeleteAsync(string resource, string transactionId);

Аргументы:

resource. Имя ресурса;
transactionId. Идентификатор транзакции.

Метод возвращает экземпляр класса Task<string>.

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