{"id":21233534,"url":"https://github.com/friflo/fliox-docs","last_synced_at":"2026-01-02T14:06:59.364Z","repository":{"id":176837238,"uuid":"515872524","full_name":"friflo/fliox-docs","owner":"friflo","description":"JSON Fliox - API Reference","archived":false,"fork":false,"pushed_at":"2023-02-22T11:53:55.000Z","size":916,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-21T18:36:46.329Z","etag":null,"topics":["api-reference","json-fliox"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/friflo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-20T07:08:39.000Z","updated_at":"2022-08-03T08:07:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"9280d2c1-d6a3-40fc-a400-7c4e7c7bf338","html_url":"https://github.com/friflo/fliox-docs","commit_stats":null,"previous_names":["friflo/fliox-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/friflo%2Ffliox-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/friflo%2Ffliox-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/friflo%2Ffliox-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/friflo%2Ffliox-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/friflo","download_url":"https://codeload.github.com/friflo/fliox-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243676705,"owners_count":20329432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-reference","json-fliox"],"created_at":"2024-11-20T23:59:16.431Z","updated_at":"2026-01-02T14:06:59.332Z","avatar_url":"https://github.com/friflo.png","language":null,"readme":"# ![logo](docs/images/Json-Fliox.svg)   **fliox-docs API Reference**![SPLASH](docs/images/paint-splatter.svg)\r\n\r\n\r\nThis project contains the API Reference of the [**JSON Fliox**](https://github.com/friflo/Friflo.Json.Fliox) library.    \r\nFollowing sections list fundamental [Friflo.Json.Fliox.Hub.*](api/Friflo/Json/Fliox/Hub/index.md) classes grouped by their **use case**.  \r\nThese groups fit mainly to their namespaces. Except `.Remote` containing client as well server classes. \r\n\r\n### Client\r\n\r\n*Example client*\r\n[`Todo/Client/TodoClient.cs`](https://github.com/friflo/FlioxHub.Demos/blob/main/Todo/Client/TodoClient.cs)\r\n*and client utilization*\r\n[`Todo/Test/Trial.cs`](https://github.com/friflo/FlioxHub.Demos/blob/main/Todo/Test/Trial.cs)\r\n\r\n| Namespace    | Class                                                                                 | Description                                                                                          |\r\n| -------------|-------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |\r\n| .Client      | [FlioxClient](api/Friflo/Json/Fliox/Hub/Client/FlioxClient/index.md)                  | `FlioxClient` subclasses are used as **database clients** and **database schema**                    |\r\n| .Client      | [EntitySet\u003c,\u003e](api/Friflo/Json/Fliox/Hub/Client/EntitySet-2/index.md)                 | **Strongly typed** API to a access a database container used as property in a `FlioxClient` subclass |\r\n| .Remote      | [HttpClientHub](api/Friflo/Json/Fliox/Hub/Remote/HttpClientHub/index.md)              | Connects to a Hub via **HTTP** by passing it to a `FlioxClient` constructor                          |\r\n| .Remote      | [WebSocketClientHub](api/Friflo/Json/Fliox/Hub/Remote/WebSocketClientHub/index.md)    | Connects to a Hub via **Websocket** by passing it to a `FlioxClient` constructor                     |\r\n\r\n\r\n### Host\r\n\r\n*HTTP Hub bootstrapping examples* \r\n[`Todo/Hub/Program.cs`](https://github.com/friflo/FlioxHub.Demos/blob/main/Todo/Hub/Program.cs) *and*\r\n[`Demo/Hub/Program.cs`](https://github.com/friflo/FlioxHub.Demos/blob/main/Demo/Hub/Program.cs)\r\n\r\n| Namespace    | Class                                                                                 | Description                                                                     |\r\n| ------------ |-------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |\r\n| .Remote      | [HttpHost](api/Friflo/Json/Fliox/Hub/Remote/HttpHost/index.md)                        | Host a `FlioxHub` as **HTTP** / **WebSocket** server                            |\r\n| .Remote      | [StaticFileHandler](api/Friflo/Json/Fliox/Hub/Remote/StaticFileHandler/index.md)      | Add static web files to the `HttpHost` like the **Hub Explorer**                |\r\n| .Host        | [FlioxHub](api/Friflo/Json/Fliox/Hub/Host/FlioxHub/index.md)                          | Used as a Proxy between a `FlioxClient` and a concrete database                 |\r\n| .Host        | [FileDatabase](api/Friflo/Json/Fliox/Hub/Host/FileDatabase/index.md)                  | Database storing records in the `file-system`                                   |\r\n| .Host        | [MemoryDatabase](api/Friflo/Json/Fliox/Hub/Host/MemoryDatabase/index.md)              | Database storing records `in-memory`                                            |\r\n| .Host        | [DatabaseSchema](api/Friflo/Json/Fliox/Hub/Host/DatabaseSchema/index.md)              | Used to assign a **schema** to a database                                       |\r\n| .Host        | [DatabaseService](api/Friflo/Json/Fliox/Hub/Host/DatabaseService/index.md)            | Used to implement custom database commands declared in a `FlioxClient` subclass |\r\n| .Host.Event  | [EventDispatcher](api/Friflo/Json/Fliox/Hub/Host/Event/EventDispatcher/index.md)      | Enables **Pub-Sub** by a `FlioxHub`                                             |\r\n\r\n\r\n### DB\r\n\r\n*Adding support databases example*\r\n[`Demo/Hub/Program.cs`](https://github.com/friflo/FlioxHub.Demos/blob/main/Demo/Hub/Program.cs)\r\n\r\n| Namespace    | Class                                                                                 | Description                                               |\r\n| ------------ |-------------------------------------------------------------------------------------- | --------------------------------------------------------- |\r\n| .DB.Cluster  | [ClusterDB](api/Friflo/Json/Fliox/Hub/DB/Cluster/ClusterDB/index.md)                  | Expose information of hosted databases as a database      |\r\n| .DB.Monitor  | [MonitorDB](api/Friflo/Json/Fliox/Hub/DB/Monitor/MonitorDB/index.md)                  | Expose request information of a `FlioxHub` as a database  |\r\n| .DB.UserAuth | [UserAuthenticator](api/Friflo/Json/Fliox/Hub/DB/UserAuth/UserAuthenticator/index.md) | Performs user authentication and authorization            |\r\n\r\n\r\n\r\n\r\n\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffriflo%2Ffliox-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffriflo%2Ffliox-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffriflo%2Ffliox-docs/lists"}