lib
lib:hx
Haxall framework definitions
meta
tags
| created |
The timestamp when entity was created |
|---|---|
| disKey |
Localized string key formatted as |
| disMacro |
Display name using macro syntax |
| disabled |
Indicates the entity is in a disabled state |
| flags |
Flags string |
| mod |
Last modified time of record - see docSkySpark |
| multiLine |
Indicates that a multi-line text input should be used |
| noSkyarc |
Marks a Haxall library as not runnable on SkySpark enabled products |
| password |
Manages password which is hashed/stored to the password store |
| projMeta |
Singleton record for project meta data |
| reader |
Fantom type qname for reader class |
| steadyState |
The delay before transitioning to the steady state |
| trash |
Marks a record for deletion |
| typeName |
Fantom type qname |
| username |
Username for an authentication account |
| writer |
Fantom type qname for writer class |
ops
filetypes
funcs
| about |
Return |
|---|---|
| commit |
Commit one or more diffs to the folio database |
| context |
Get the current context as a Dict with the following tags |
| diff |
Construct a modification "diff" used by |
| isSteadyState |
Return |
| isWatched |
Return if given record is under at least one watch |
| libAdd |
Enable a library by name in the runtime |
| libRemove |
Disable a library by name in the runtime |
| libStatus |
Return grid of enabled libs and their current status |
| passwordSet |
Store a password key/val pair into current project's password store |
| pods |
Return list of installed Fantom pods |
| read |
Read from database the first record which matches filter |
| readAll |
Reall all records from the database which match the filter |
| readAllStream |
Reall all records which match filter as stream of Dict records |
| readAllTagNames |
Return the intersection of all tag names used by all the records matching the given filter |
| readAllTagVals |
Return the range of all the values mapped to a given tag name used by all the records matching the given filter |
| readById |
Read a record from database by |
| readByIdPersistentTags |
Given record id, read only the persistent tags from Folio |
| readByIdTransientTags |
Given record id, read only the transient tags from Folio |
| readByIds |
Read a list of record ids into a grid |
| readByIdsStream |
Read a list of ids as a stream of Dict records |
| readCount |
Return the number of records which match the given filter expression |
| readLink |
Read a record Dict by its id for hyperlinking in a UI |
| services |
Grid of installed services |
| stripUncommittable |
Strip any tags which cannot be persistently committed to Folio |
| toRec |
Coerce a value to a record Dict |
| toRecId |
Coerce a value to a Ref identifier |
| toRecIdList |
Coerce a value to a list of Ref identifiers |
| toRecList |
Coerce a value to a list of record Dicts |
| tzdb |
Return the installed timezone database as Grid with following columns |
| unitdb |
Return the installed unit database as Grid with following columns |
| watchAdd |
Add a grid of recs to an existing watch and return the grid passed in |
| watchClose |
Close an open watch by id |
| watchOpen |
Open a new watch on a grid of records |
| watchPoll |
Poll an open watch and return all the records which have changed since the last poll |
| watchRemove |
Remove a grid of recs from an existing watch and return grid passed in |
| xetoReload |
Reload all the Xeto libraries |