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
1.2 KiB
Markdown
70 lines
1.2 KiB
Markdown
# Transfers
|
|
|
|
<!-- BEGIN GENERATED: __api_Transfers__ -->
|
|
## Méthodes
|
|
|
|
### Transfers.CreateUpload
|
|
|
|
<span class="badge perm-configure">CONFIGURE</span>
|
|
|
|
Create an upload session on the dedicated transfer connection.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `fileName` | `String` | |
|
|
| `size` | `Int` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `fileName` | `String` | |
|
|
| `size` | `Int` | |
|
|
| `transferId` | `String` | |
|
|
| `transferToken` | `String` | |
|
|
|
|
---
|
|
|
|
### Transfers.StartDownload
|
|
|
|
<span class="badge perm-control">CONTROL</span>
|
|
|
|
Create a download session for a previously announced download.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `downloadId` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `fileName` | `String` | |
|
|
| `size` | `Int` | |
|
|
| `transferId` | `String` | |
|
|
| `transferToken` | `String` | |
|
|
|
|
---
|
|
|
|
## Notifications
|
|
|
|
### Transfers.DownloadAvailable
|
|
|
|
Emitted when a completed upload can be downloaded on the dedicated transfer connection.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `downloadId` | `String` | |
|
|
| `fileName` | `String` | |
|
|
| `size` | `Int` | |
|
|
|
|
---
|
|
|
|
<!-- END GENERATED -->
|