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>
177 lines
2.9 KiB
Markdown
177 lines
2.9 KiB
Markdown
# Scripts
|
|
|
|
<!-- BEGIN GENERATED: __api_Scripts__ -->
|
|
## Méthodes
|
|
|
|
### Scripts.AddScript
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Add a script
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `content` | `String` | |
|
|
| `name` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `errors` | `StringList` | optionnel |
|
|
| `script` | [Script](../types.md#script) | optionnel |
|
|
| `scriptError` | [ScriptError](../types.md#scripterror) | |
|
|
|
|
---
|
|
|
|
### Scripts.EditScript
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Edit a script
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `id` | `Uuid` | |
|
|
| `content` | `String` | optionnel |
|
|
| `name` | `String` | optionnel |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `errors` | `StringList` | optionnel |
|
|
| `scriptError` | [ScriptError](../types.md#scripterror) | |
|
|
|
|
---
|
|
|
|
### Scripts.GetScriptContent
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get a scripts content.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `id` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `content` | `String` | optionnel |
|
|
| `scriptError` | [ScriptError](../types.md#scripterror) | |
|
|
|
|
---
|
|
|
|
### Scripts.GetScripts
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get all script, that is, their names and properties, but no content.
|
|
|
|
**Paramètres :**
|
|
|
|
_Aucun paramètre._
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `scripts` | [Scripts](../types.md#scripts) | |
|
|
|
|
---
|
|
|
|
### Scripts.RemoveScript
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
remove a script
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `id` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `scriptError` | [ScriptError](../types.md#scripterror) | |
|
|
|
|
---
|
|
|
|
## Notifications
|
|
|
|
### Scripts.ScriptAdded
|
|
|
|
Emitted when a script has been added to the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `script` | [Script](../types.md#script) | |
|
|
|
|
---
|
|
|
|
### Scripts.ScriptChanged
|
|
|
|
Emitted when a script has been changed in the system (e.g. renamed).
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `name` | `String` | |
|
|
| `scriptId` | `Uuid` | |
|
|
|
|
---
|
|
|
|
### Scripts.ScriptContentChanged
|
|
|
|
Emitted when a script's content has been changed in the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `scriptId` | `Uuid` | |
|
|
|
|
---
|
|
|
|
### Scripts.ScriptLogMessage
|
|
|
|
Emitted when a script produces a console message.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `message` | `String` | |
|
|
| `scriptId` | `Uuid` | |
|
|
| `type` | [ScriptMessageType](../types.md#scriptmessagetype) | |
|
|
|
|
---
|
|
|
|
### Scripts.ScriptRemoved
|
|
|
|
Emitted when a script has been removed from the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `id` | `Uuid` | |
|
|
|
|
---
|
|
|
|
<!-- END GENERATED -->
|