Describing UWP Framework Methods

Framework methods are divided into several categories, each of them contains corresponding methods:

Authentication Methods

Methods of this area are implemented in the AuthApi property that is available in the HyperHive (hyperHive.AuthApi) class.

The AuthAsync method is used to authorize the user using login and password.

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

Arguments:

login. User login.
password. User login.
headers. Dictionary with additional HTTP headers.

NOTE. The argument can take the NULL value.

The method returns instance of the Task<string> class.

The Logout method is used to exit the authorized user mode.

Logout();

The method returns instance of the Task<string> class.

The ResourcesAsync method is used to get a scheme of available resources and automatically create corresponding tables in the database.

NOTE. The method is executed only after successful authorization.

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

Arguments:

dataBase. Database file name.
headers. Dictionary with additional HTTP headers.

NOTE. The argument can take the NULL value.

The method returns instance of the Task<string> class.

The SetSslChecks method is used to set a mode of checking certificates on establishing a TLS/SSL connection.

SetSslChecks(bool enable);

Arguments:

enable. Indicates whether check is enabled or disabled.

The method returns value of the "bool" type.

Methods for Working with Databases

Methods of this area aee implemented in the DatabaseApi property that is available in the HyperHive (hyperHive.DatabaseApi) class.

The OpenDatabase method is used to create or open encrypted database.

OpenDatabase(string database, string key);

Arguments:

database. Path to the database containing database name within application folder.
key. Database password.

NOTE. Password can be an empty string.

The method returns True if database was opened successfully, otherwise the method returns False.

If the database has not yet been created, a new database is created and opened for work with the use of the specified encryption key.

Of the database already exists,an attempt to open database with the specified key is executed.

The CloseDatabase method is used to close database at the specified path.

CloseDatabase(string database);

Arguments:

database. Path to the database containing database name.

The method returns True if database is closed successfully, otherwise the method returns False.

The ExecuteQueryForResourceAsync method is used to create queries to local SQLite database.

ExecuteQueryForResourceAsync(string database, string query);

Arguments:

database. Path to the database containing database name.
query. SQL query.

The method returns instance of the Task<string> class.

The GetTablesNamesAsync method is used to get a resource tables list.

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

Arguments:

database. Path to the database containing database name.
resource. Resource name.
parameters. Parameters, at which resource data was obtained.
table. Name of table for filtering.

The method returns instance of the Task<string> class.

The DropCacheAsync method is used to delete saved resource data with parameters.

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

Arguments:

database. Path to the database containing database name.
resource. Resource name.
parameters. Parameters, at which resource data was obtained.

The method returns instance of the Task<string> class.

Methods for Working with Digital Signature (DSS)

Methods of this area are implemented in the DssApi property, which is available in the HyperHive (hyperHive.DssApi) class.

The CertificatesAsync method is used to request a user certificates list in the DSS system.

CertificatesAsync(string password);

Arguments:

password. DSS password.

The method returns instance of the Task<string> class.

The SignAsync method is used to create a document signature by table cell address.

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

Arguments:

resource. Resource name.
table. Table name.
parameters. Resource parameter values as JSON.
column. Column identifier.
rowId. Row identifier.
password. DSS password.
certificateId. DSS certificate identifier.
certificatePin. DSS certificate PIN code.

The method returns identifier of the signature if it was created successfully and instance of the Task<string> class.

The SignsAsync method is used to get signatures history for specific user and device.

SignsAsync();

The method returns instance of the Task<string> class.

The SignRemoveAsync method is used to request signature removal by its identifier.

SignRemoveAsync(int signId);

Arguments:

signId. Signature identifier.

The method returns instance of the Task<string> class.

File Connector Methods

Methods of this area are implemented in the FileConnectorApi property, which is available in the HyperHive (hyperHive.FileConnectorApi) class.

The GetDirectoryAsync method is used to request to get directory contents, the files and folders list in the specified directory.

GetDirectoryAsync(string mountName, string directoryName);

Arguments:

mountName. Mount point name on server.
directoryName. Directory path relative to the mount point.

NOTE. If only "./" is set, root folder contents is returned.

The method returns instance of the Task<string> class.

The GetFileMetaAsync method is used to create a request to get information about file on server.

GetFileMetaAsync(string mountName, string fileName);

Arguments:

mountName. Mount point name on server.
fileName. Path to file relative to the mount point.

The method returns instance of the Task<string> class.

The GetFileAsync method is used to create a request to get file from server.

GetFileAsync(string mountName, string fileName);

Arguments:

mountName. Mount point name on server.
fileName. Path to file relative to the mount point.

The method returns instance of the Task<string> class.

The PutFileAsync file is used to create a request to upload file to server.

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

Arguments:

mountName. Mount point name on server.
fileNameTo. Upload file path relative to the mount point.
fileNameFrom. Path to uploaded file.

The method returns instance of the Task<string> class.

The DeleteFileAsync method is used to create a request to delete file from server.

DeleteFileAsync(string mountName, string fileName)

Arguments:

mountName. Mount point name on server.
fileName. Path to file relative to the mount point.

The method returns instance of the Task<string> class.

Methods for Working with Logs

Methods of this area are implemented in the LoggingApi property that is available in the HyperHive (hyperHive.LoggingApi) class.

The SetLogLevel method is used to set a minimum logging level.

SetLogLevel(LogLevels level);

Arguments:

LogLevels. Enumeration:

Database. Work with database.
Verbose. Details for debugging and testing.
Debug. Debug output for developer.
Info. Information that is useful for SDK user (statistics, main settings, start/stop status, and so on).
Warning. Warning. The user or developer should take into account application work result.
Error. The error, after which the application can work but results may be unexpected.
Assert. Application does not work.
Output. Standard output.

The method returns value of the "int" type.

The SetLogFileName method is used to specify a database file that stores logs.

SetLogFileName(string dbFileName, string key);

Arguments:

dbFileName. Database name.
key. Database password.

NOTE. Password can be an empty string.

The method returns value of the "bool" type.

Methods for logging events with selected logging level.

Log(string message, LogLevels level);

LogInfo(string message);

LogWarning(string message);

LogError(string message);

Arguments:

message. Log text.
LogLevels. Logging level.

All methods are synchronous and return nothing.

The SyncLogsAsync method is used to synchronize logs with core.

SyncLogsAsync(bool remove);

Arguments:

remove. Removal indicator.

The method returns instance of the Task<string> class.

The SyncLogsScheduleAsync method is used to plan synchronization of logs with core.

SyncLogsScheduleAsync();

The method returns instance of the Task<string> class.

Resource Request Methods

Methods of this area are implemented in the RequestApi property that is available in the HyperHive (hyperHive.RequestApi) class.

NOTE. If resource structure has been changed in the data source, recreate it in the mobile platform administrator panel, and also recreate cache in the mobile framework. Otherwise the resource with the old structure is returned.

The WebRequestAsync method is used to execute a request to WEB resource with custom parameters. Available parameters are specified in the WebCallParams class.

WebRequestAsync(string resource, WebCallParams webCallParams);

Arguments:

resource. Resource name.
webCallParams. The object containing parameters of request to WEB resource.

The method returns instance of the Task<string> class.

Request model description:

public sealed class WebCallParams
{

// Data sent in request body.

public string Data { get; set; }

// Dictionary with additional HTTP headers.

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

// Number of request repetitions.

public int? RetryCount { get; set; }

// Interval between repetitions.

public int? RetryIntervalSec { get; set; }

// File name for saving data.

public string FileName { get; set; }

}

The ToDatabaseRequestAsync method is used to get resource table data or refresh resource via getting delta of resource table data. The method is called if there is a scheme of available resources obtained using the ResourcesAsync method after successful authorization. Available parameters are specified in the DatabaseCallParams class.

ToDatabaseRequestAsync(string resource, DatabaseCallParams databaseCallParams);

Arguments:

resource. Resource name.
databaseCallParams. The object containing parameters of request to get resource data.

The method returns instance of the Task<string> class.

Request model description:

public sealed class DatabaseCallParams

{

// Path to database including database name.

public string Database { get; set; }

// Transaction identifier (it is set only for resource with table parameters).

public string TransactionId { get; set; }

// Data sent in request body.

public string Data { get; set; }

// Number of request repetitions.

public int? RetryCount { get; set; }

// Interval between repetitions.

public int? RetryIntervalSec { get; set; }

// Indicates whether delta of resource table data must be requested, otherwise resource table data is requested in the TableStream format.

public bool DeltaOnly { get; set; }

}

The ToFileRequestAsync method is used to get resource table data or refresh resource via getting delta of resource table data. The obtained data is written to file. The method is called if there is a scheme of available resources obtained using the ResourcesAsync method after successful authorization. Available parameters are specified in the FileCallParams class.

ToFileRequestAsync(string resource, FileCallParams fileCallParams);

Arguments:

resource. Resource name.
fileCallParams. The object containing parameters of request to get resource data with writing to file.

The method returns instance of the Task<string> class.

Request model description:

public sealed class FileCallParams

{

// Transaction identifier (it is set only for resource with table parameters).

public string TransactionId { get; set; }

// Data sent in request body.

public string Data { get; set; }

// Number of request repetitions.

public int? RetryCount { get; set; }

// Interval between repetitions.

public int? RetryIntervalSec { get; set; }

// Name of file for saving data (if it is not set, data is sent to local database).

public string FileName { get; set; }

// Indicates whether delta of resource table data must be requested, otherwise resource table data is requested in the TableStream format.

public bool DeltaOnly { get; set; }

}

Methods for Working with States

Methods of this area are implemented in the StateApi property that is available in the HyperHive (hyperHive.StateApi) class.

The SetState method is used to save the current state.

SetState(string state);

Arguments:

state. State.

The method returns True if saving was successful, otherwise the method returns False.

The GetState method is used to get state.

GetState();

The method returns string value of the string type.

The GetVersionCoreApi method is used to give information about version of core in use.

GetVersionCoreApi(int depth);

Arguments:

depth. Depth.

The method returns value of the string type.

Transaction ID Methods

Methods of this area are implemented in the TransactionApi property that is available in the HyperHive (hyperHive.TransactionApi) class.

The TransactionsAsync method is used to get transactions history for the current user and device.

TransactionsAsync(string resource);

Arguments:

resource. Resource name.

The method returns instance of the Task<string> class.

The TransactionAsync method is used to get transaction by transaction identifier for the current user or device.

TransactionAsync(string resource, string transactionId);

Arguments:

resource. Resource name.
transactionId. Transaction identifier.

The method returns instance of the Task<string> class.

The TransactionDeleteAsync method is used to delete record from the transactions list.

TransactionDeleteAsync(string resource, string transactionId);

Arguments:

resource. Resource name.
transactionId. Transaction identifier.

The method returns instance of the Task<string> class.