Patrick Schurig
b26274595c
Some checks failed
Build & Deploy docs / build-deploy (push) Failing after 10m17s
- Nouveau générateur scripts/gen_api_reference.py : 19 namespaces → docs/api/metier/ (10) + docs/api/systeme/ (9) + notifications.md + types.md (96 types · 55 enums · 4 flags) + SUMMARY.md literate-nav - Badges permissionScope (perm-none/control/configure/admin) dans extra.css - Guide docs/integrations/jsonrpc-api.md (connexion TCP/WS, auth, conventions énergie) - mkdocs.yml : Référence API dans la nav, REST→JsonRPC renommé - mkdocs build --strict : 0 warnings · --check idempotent Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
# AppData
|
|
|
|
<!-- BEGIN GENERATED: __api_AppData__ -->
|
|
## Méthodes
|
|
|
|
### AppData.Load
|
|
|
|
<span class="badge perm-control">CONTROL</span>
|
|
|
|
Retrieve an app data storage value that has previously been set with Store(). If no value had been set for this appId/key combination before, an empty value will be returned.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `appId` | `String` | |
|
|
| `key` | `String` | |
|
|
| `group` | `String` | optionnel |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `value` | `String` | |
|
|
|
|
---
|
|
|
|
### AppData.Store
|
|
|
|
<span class="badge perm-configure">CONFIGURE</span>
|
|
|
|
Store an app data entry to the server. App data can be used by the client application to store configuration values. The app data storage is a key-value pair storage. Each entry value is identified by an appId, a key and optionally a group. The value data is a bytearray and can contain arbitrary data, such as a JSON map or image data, however, be aware of the maximum packet size for the used transport.
|
|
This might be useful to a client application to sync settings across multiple instances of the same application.
|
|
The group parameter might be used to create groups for this application.
|
|
IMPORTANT: Currently no verification of the appId is done. The appid is merely a mechanism to prevent different different client apps from colliding by using the same key for data entries. This implies that the app data storage may not be suited for sensitive data given that anyone with a valid server token can read it.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `appId` | `String` | |
|
|
| `key` | `String` | |
|
|
| `group` | `String` | optionnel |
|
|
| `value` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
_Aucun paramètre._
|
|
|
|
---
|
|
|
|
## Notifications
|
|
|
|
### AppData.Changed
|
|
|
|
Emitted whenever the app data is changed on the server.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `appId` | `String` | |
|
|
| `key` | `String` | |
|
|
| `group` | `String` | optionnel |
|
|
| `value` | `String` | |
|
|
|
|
---
|
|
|
|
<!-- END GENERATED -->
|