> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Fichiers

> Répertoriez, téléchargez, téléversez et supprimez des fichiers d'entité au moyen de l'API File de PlayFab.

`playfab file` gère les fichiers stockés sur une entité PlayFab, comme un joueur.

```text theme={null}
xbox --playfab-title-id ABC123 playfab file <command>
```

Chaque commande de fichier exige `--entity-id` et `--entity-type`. Pour un joueur, transmettez l'ID de son
compte de joueur du titre avec `--entity-type title_player_account`, et non l'ID de son compte de joueur
principal; [`playfab player account get`](https://docs.xbox.com/fr-CA/tools/xbox-cli/commands/playfab/player) le retourne sous la forme
`UserInfo.TitleInfo.TitlePlayerAccount.Id`.

| Commande | Chemin de l'API PlayFab | Description |
| - | - | - |
| `playfab file list` | `/File/GetFiles` | Répertorie les fichiers d'une entité. |
| `playfab file download` | `/File/GetFiles` | Télécharge un fichier. |
| `playfab file upload` | `/File/InitiateFileUploads`, `/File/FinalizeFileUploads` et `/File/AbortFileUploads` si le téléversement échoue | Téléverse un fichier local, en l'ajoutant ou en le remplaçant. |
| `playfab file delete` | `/File/DeleteFiles` | Supprime un ou plusieurs fichiers. Demande d'abord une confirmation; consultez [Sécurité et opérations destructrices](https://docs.xbox.com/fr-CA/tools/xbox-cli/safety.md). |

## Sortie

`playfab file list` écrit les métadonnées des fichiers sur stdout en JSON, ou sous forme de tableau avec
`--output table`, qui affiche `FILE NAME`, `LAST MODIFIED` et `CHECKSUM`.

`upload`, `download` et `delete` sont des opérations sur les fichiers, comme `cp` et `rm`. Elles n'écrivent
rien sur stdout et signalent ce qu'elles ont fait sur stderr :

| Commande | stderr en cas de réussite |
| - | - |
| `playfab file upload` | `Uploading source file: <path>` au début, puis `Uploaded '<name>' (<bytes> bytes).` |
| `playfab file download` | `Downloaded '<name>' to '<path>' (<bytes> bytes).` |
| `playfab file delete` | `Deleted file: '<name>'`, ou `Deleted files: '<name>', '<name>'` pour plusieurs fichiers |

Ces messages peuvent changer d'une version à l'autre; les scripts doivent donc vérifier le code de sortie : `0`
lorsque l'opération a réussi, et un code non nul lorsqu'elle a échoué, avec l'erreur sur stderr. Ces
trois commandes n'acceptent pas `--output table`, et `--data-only` ne change pas ce qu'elles
écrivent.

## `playfab file list`

```bash theme={null}
xbox --playfab-title-id ABC123 playfab file list --entity-id TITLEPLAYER123 --entity-type title_player_account
xbox --playfab-title-id ABC123 playfab file list --entity-id TITLEPLAYER123 --entity-type title_player_account --output table
```

## `playfab file download`

| Option | Obligatoire | Description |
| - | - | - |
| `--entity-id <entity-id>` | Oui | ID de l'entité. |
| `--entity-type <entity-type>` | Oui | Type d'entité. |
| `--name <name>` | Oui | Nom du fichier à télécharger. |
| `--dest <dest>` | Non | Chemin local où écrire le fichier. Par défaut, le nom du fichier dans le répertoire actuel. Transmettez-la lorsque ce nom n'est pas valide localement. `-` pour stdout n'est pas pris en charge. |

`download` remplace un fichier local qui se trouve déjà au chemin de destination.

```bash theme={null}
xbox --playfab-title-id ABC123 playfab file download --entity-id TITLEPLAYER123 --entity-type title_player_account --name data.json --dest data.json
```

Lorsque l'entité n'a aucun fichier portant ce nom, l'erreur affiche la commande `file list` à exécuter :

```console theme={null}
$ xbox --playfab-title-id ABC123 playfab file download --entity-id TITLEPLAYER123 --entity-type title_player_account --name save.json
Error: File 'save.json' not found on this entity. To see its files, run:
  xbox --playfab-title-id ABC123 playfab file list --entity-id TITLEPLAYER123 --entity-type title_player_account
```

## `playfab file upload`

| Option | Obligatoire | Description |
| - | - | - |
| `--entity-id <entity-id>` | Oui | ID de l'entité. |
| `--entity-type <entity-type>` | Oui | Type d'entité. |
| `--file <file>` | Oui | Chemin du fichier local à téléverser. `-` pour stdin n'est pas pris en charge. |
| `--name <name>` | Non | Nom sous lequel stocker le fichier. Par défaut, le nom du fichier local. |

```console theme={null}
$ xbox --playfab-title-id ABC123 playfab file upload --entity-id TITLEPLAYER123 --entity-type title_player_account --file save.json
Uploading source file: D:\NodArena\save.json
Uploaded 'save.json' (2048 bytes).
```

### Si un téléversement échoue

Pendant qu'un téléversement est en cours, PlayFab bloque tous les autres téléversements vers les fichiers de l'entité,
y compris ceux du jeu lui-même, qui échouent avec `EntityFileOperationPending`. Ainsi, lorsqu'un téléversement
échoue en cours de route, ou que vous appuyez sur Ctrl+C, la CLI l'annule et indique sur stderr si l'annulation
a fonctionné. Lorsque l'annulation fonctionne, les fichiers de l'entité restent inchangés.

Lorsque la CLI ne peut pas annuler le téléversement, ou ne peut pas déterminer si le téléversement ou l'annulation a été appliqué,
elle l'indique. Elle affiche la commande qui annule le téléversement en attente et, lorsque le fichier pourrait
avoir changé, la commande `file list` permettant de le vérifier. Exécutez la commande d'annulation seulement si les téléversements suivants
échouent avec `EntityFileOperationPending`, car elle annule aussi un téléversement de ce fichier que
le jeu a lancé.

## `playfab file delete`

| Argument / option | Obligatoire | Description |
| - | - | - |
| `<names...>` | Oui | Un ou plusieurs noms de fichiers à supprimer. |
| `--entity-id <entity-id>` | Oui | ID de l'entité. |
| `--entity-type <entity-type>` | Oui | Type d'entité. |
| `--confirm`, `--yes`, `-y` | En dehors d'un terminal interactif | Confirmer la suppression. |

```bash theme={null}
xbox --playfab-title-id ABC123 playfab file delete data.json --entity-id TITLEPLAYER123 --entity-type title_player_account --confirm
```


## Related topics

- [Fichiers d'entité](https://docs.xbox.com/fr-CA/services/playfab/live-service-management/game-configuration/entities/entity-files.md)
- [Obtenir des fichiers](https://docs.xbox.com/fr-CA/services/playfab/api-references/rest/data/file/get-files.md)
- [Supprimer des fichiers](https://docs.xbox.com/fr-CA/services/playfab/api-references/rest/data/file/delete-files.md)
- [Copie de fichiers (xbcp.exe)](https://docs.xbox.com/fr-CA/tools/tools-console/commandlinetools/xbcp.md)
- [Suppression de fichiers (xbdel.exe)](https://docs.xbox.com/fr-CA/tools/tools-console/commandlinetools/xbdel.md)
