Helper Class Reference  1.4
HomeGenie - Automation Programs API
Public Member Functions | List of all members
DataHelper Class Reference

Data and database Helper class.
Class instance accessor: Data More...

Public Member Functions

string GetFolder (string fixedName=null)
 Gets the path of program's data folder. More...
 
LiteDatabase LiteDb (string fileName)
 Open and get a LiteDatabase instance. See LiteDB website http://www.litedb.org for documentation. More...
 
bool AddToSystemBackup (string path)
 Sets additional file or folder to be added to the system backup file. More...
 
bool RemoveFromSystemBackup (string path)
 Removes an additional file or folder from the system backup file. More...
 

Detailed Description

Data and database Helper class.
Class instance accessor: Data

Member Function Documentation

◆ GetFolder()

string GetFolder ( string  fixedName = null)

Gets the path of program's data folder.

Parameters
fixedNameGet a shareable folder with the given fixed name.
Returns

◆ LiteDb()

LiteDatabase LiteDb ( string  fileName)

Open and get a LiteDatabase instance. See LiteDB website http://www.litedb.org for documentation.

Returns
LiteDatabase
Parameters
fileNameThe database file name.

Example:

var db = Data.LiteDb("my_data.db");
...

◆ AddToSystemBackup()

bool AddToSystemBackup ( string  path)

Sets additional file or folder to be added to the system backup file.

Parameters
path
Returns

◆ RemoveFromSystemBackup()

bool RemoveFromSystemBackup ( string  path)

Removes an additional file or folder from the system backup file.

Parameters
path
Returns

The documentation for this class was generated from the following file: