Aller au contenu principal

téléchargement

Téléchargez un fichier vers le stockage cloud de oneentry.

Description​

Cette méthode télécharge un fichier vers un stockage de fichiers cloud. Passez à la date la valeur obtenue à partir de l'entrée de type "file". Elle renvoie une Promise qui se résout en un objet IUploadingReturn[].

Les données sont un objet fichier (ou un tableau), en savoir plus - Objet File

FileUploading.upload(

file*, fileQuery, fileQuery.type*, fileQuery.entity*, fileQuery.id*, fileQuery.width, fileQuery.height, fileQuery.compress

);

Schéma des paramètres​

Schéma

file(obligatoire): File | Blob
Fichier à télécharger
exemple: new File(["content"], "file.png", {"type": "image/png"})

fileQuery: IUploadingQuery
Paramètres de requête optionnels
exemple:

{
  "type": "page",
  "entity": "editor",
  "id": 3787,
  "width": 0,
  "height": 0,
  "compress": true,
  "template": 1
}

fileQuery.type(obligatoire): string
Type, détermine le nom du dossier dans le stockage.
exemple: "page"

fileQuery.entity(obligatoire): string
Nom de l'entité à partir de laquelle le fichier est téléchargé, détermine le nom du dossier dans le stockage.
exemple: "editor"

fileQuery.id(obligatoire): number
Identifiant de l'objet à partir duquel le fichier est téléchargé, détermine le nom du dossier dans le stockage.
exemple: 3787

fileQuery.width: number
Paramètre de largeur.
exemple: 0

fileQuery.height: number
Paramètre de hauteur.
exemple: 0

fileQuery.compress: boolean
Drapeau d'optimisation (compression) pour les images.
exemple: true

Exemples​

Exemple minimal​


const fileQuery = {
  "type": "page",
  "entity": "editor",
  "id": 3787,
  "width": 0,
  "height": 0,
  "compress": true
};

const response = await FileUploading.upload(file, fileQuery);

Exemple de réponse​

[
  {
    "filename": "files/project/page/3492/editor/7b949671-f7ed-4caa-b3c9-44b12cf0e7b4.md",
    "downloadLink": "https://your-project.oneentry.cloud/cloud-static/files/project/page/3492/editor/7b949671-f7ed-4caa-b3c9-44b12cf0e7b4.md",
    "size": 4463
  }
]

Schéma de réponse​

Schéma: IUploadingReturn[]

filename: string
Nom de fichier avec chemin relatif.
exemple: "uploads/file.png"

downloadLink: string
Lien pour télécharger le fichier.
exemple: "https://example.com/uploads/file.png"

size: number
Taille du fichier en octets.
exemple: 1024