Prise en main

Installer

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Utilisez ensuite le prompt suivant :

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-uploader` plugin in my project.

Si vous préférez une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

bun add @capgo/capacitor-uploader
bunx cap sync

Importer

import { Uploader } from '@capgo/capacitor-uploader';

Démarrage rapide

Lancez un upload, abonnez-vous à events, et suivez l'upload retourné id.

import { Uploader } from '@capgo/capacitor-uploader';

let uploadId = '';

const listener = await Uploader.addListener('events', async (event) => {
  if (event.id !== uploadId) return;

  if (event.name === 'uploading') {
    console.log(event.payload.percent);
  }

  if (event.name === 'completed' || event.name === 'failed') {
    if (event.eventId) {
      await Uploader.acknowledgeEvent({ eventId: event.eventId });
    }
    await listener.remove();
  }
});

const { id } = await Uploader.startUpload({
  filePath: 'file:///data/user/0/.../scan.jpg',
  serverUrl: 'https://api.example.com/v1/assets',
  method: 'POST',
  headers: { Authorization: 'Bearer token' },
  maxRetries: 3,
});
uploadId = id;

Exemple : PUT S3 présigné

PUT les uploads ne supportent qu'un seul fichier. Utilisez l'URL présignée comme serverUrl et configurez method: 'PUT'.

await Uploader.startUpload({
  filePath: capturedUri,
  serverUrl: presignedUrl,
  method: 'PUT',
  headers: { 'Content-Type': 'image/jpeg' },
});

Exemple : formulaire multipart avec champs supplémentaires

await Uploader.uploadMultipart({
  url: 'https://api.example.com/upload',
  filePath: localPath,
  fieldName: 'file',
  fields: { userId: '42', kind: 'receipt' },
  headers: { Authorization: 'Bearer token' },
});

Erreurs courantes

• Plusieurs fichiers: utilisez le files array sur startUpload pour une seule requête multipart. PUT impossible d'envoyer plusieurs corps de requête.
• Arrière-plan web: l'upload s'arrête si l'utilisateur ferme l'onglet. Utilisez les plateformes natives si l'opération doit se poursuivre en arrière-plan.
• Annuler: appelez removeUpload({ id }) avec l'id de startUpload.
• Progression: attachez toujours le events listener avant de commencer, sinon vous risquez de rater le début.

Aperçu de API

startUpload

Commencer l'upload d'un fichier vers un serveur.

L'upload continuera en arrière-plan même si l'application est fermée ou mise en arrière-plan. Écoutez les événements d'upload pour suivre la progression, la réussite ou l'échec.

import { Uploader } from '@capgo/capacitor-uploader';

const { id } = await Uploader.startUpload({
  filePath: 'file:///path/to/file.jpg',
  serverUrl: 'https://example.com/upload',
  headers: {
    'Authorization': 'Bearer token'
  },
  method: 'POST',
  uploadType: 'multipart',
  fileField: 'photo'
});
console.log('Upload started with ID:', id);

removeUpload

Annuler et supprimer un upload en cours.

Cela arrêtera l'upload s'il est en cours et libérera les ressources.

import { Uploader } from '@capgo/capacitor-uploader';

await Uploader.removeUpload({ id: 'upload-123' });

Référence de type

uploadOption

Options de configuration pour l'upload d'un fichier.

export interface uploadOption {
  /**
   * The local file path of the file to upload.
   * Can be a file:// URL or an absolute path.
   *
   * @since 0.0.1
   */
  filePath: string;

  /**
   * The server URL endpoint where the file should be uploaded.
   *
   * @since 0.0.1
   */
  serverUrl: string;

  /**
   * The title of the upload notification shown to the user.
   * Android only.
   *
   * @default 'Uploading'
   * @since 0.0.1
   */
  notificationTitle?: string;

  /**
   * HTTP headers to send with the upload request.
   * Useful for authentication tokens, content types, etc.
   *
   * @since 0.0.1
   * @example
   * ```typescript
   * headers: {
   *   'Authorization': 'Bearer token123',
   *   'X-Custom-Header': 'value'
   * }
   * ```
   */
  headers: {
    [key: string]: string;
  };

  /**
   * The HTTP method to use for the upload request.
   *
   * @default 'POST'
   * @since 0.0.1
   */
  method?: 'PUT' | 'POST';

  /**
   * The MIME type of the file being uploaded.
   * If not specified, the plugin will attempt to determine it automatically.
   *
   * @since 0.0.1
   * @example 'image/jpeg', 'application/pdf', 'video/mp4'
   */
  mimeType?: string;

  /**
   * Additional form parameters to send with the upload request.
   * These will be included as form data in multipart uploads.
   *
   * @since 0.0.1
   */
  parameters?: { [key: string]: string };

  /**
   * The maximum number of times to retry the upload if it fails.
   *
   * @since 0.0.1
   * @default 0
   */
  maxRetries?: number;

  /**
   * The type of upload to perform.
   * - 'binary': Uploads the file as raw binary data in the request body
   * - 'multipart': Uploads the file as multipart/form-data
   *
   * @default 'binary'
   * @since 0.0.2
   */
  uploadType?: 'binary' | 'multipart';

  /**
   * The form field name for the file when using multipart upload type.
   * Only used when uploadType is 'multipart'.
   *
   * @default 'file'
   * @since 0.0.2
   */
  fileField?: string;
}

UploadEvent

Événement émis durant le cycle de vie de l'upload.

export interface UploadEvent {
  /**
   * The current status of the upload.
   * - 'uploading': Upload is in progress
   * - 'completed': Upload finished successfully
   * - 'failed': Upload encountered an error
   *
   * @since 0.0.1
   */
  name: 'uploading' | 'completed' | 'failed';

  /**
   * Additional data about the upload event.
   *
   * @since 0.0.1
   */
  payload: {
    /**
     * Upload progress percentage from 0 to 100.
     * Only present during 'uploading' events.
     *
     * @since 0.0.1
     */
    percent?: number;

    /**
     * Error message if the upload failed.
     * Only present during 'failed' events.
     *
     * @since 0.0.1
     */
    error?: string;

    /**
     * HTTP status code returned by the server.
     * Present during 'completed' and 'failed' events.
     *
     * @since 0.0.1
     */
    statusCode?: number;
  };

  /**
   * Unique identifier for this upload task.
   *
   * @since 0.0.1
   */
  id: string;
}

Source de vérité

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Continuer depuis Getting Started

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-uploader pour la capacité native dans l'utilisation de @capgo/capacitor-uploader, Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.