REST.Backend.KinveyApi.TKinveyApi.UploadFile

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

procedure UploadFile(const AFileName: string; AContentType: string; APublic: Boolean; const AUserFields: TJSONObject; out ANewFile: TFile); overload;
procedure UploadFile(const AFileName: string; const AStream: TStream; AContentType: string; APublic: Boolean; const AUserFields: TJSONObject; out ANewFile: TFile); overload;

C++

void __fastcall UploadFile(const System::UnicodeString AFileName, System::UnicodeString AContentType, bool APublic, System::Json::TJSONObject* const AUserFields, /* out */ TFile &ANewFile)/* overload */;
void __fastcall UploadFile(const System::UnicodeString AFileName, System::Classes::TStream* const AStream, System::UnicodeString AContentType, bool APublic, System::Json::TJSONObject* const AUserFields, /* out */ TFile &ANewFile)/* overload */;

Propriétés

Type Visibilité  Source Unité  Parent
procedure
function
public
REST.Backend.KinveyApi.pas
REST.Backend.KinveyApi.hpp
REST.Backend.KinveyApi TKinveyApi


Description

Télécharge un fichier sur Kinvey.

La méthode UploadFile prend les paramètres suivants :

Paramètre Description
AFileName La chaîne contenant le nom du fichier.
AContentType La chaîne indiquant le type de contenu du fichier.
APublic Par défaut, les fichiers téléchargés sur Kinvey sont privés. Définissez ce paramètre sur True pour créer un fichier lisible publiquement. Le téléchargement du fichier avec l'attribut "lisible publiquement" signifie que le lien de téléchargement à ce fichier sera une URL non signée normale qui n'expire pas, jusqu'à ce que le fichier soit supprimé ou défini comme privé.
AUserFields TJSONObject inclus dans TRESTRequest.
ANewFile Paramètre de sortie de type TFile pour stocker les informations relatives au fichier.
AStream Le TStream avec le fichier à télécharger.
Remarque : Cet argument s'applique uniquement à la deuxième méthode surchargée.

La première méthode surchargée UploadFile prend les cinq premiers paramètres du tableau ci-dessus, crée un TFileStream avec AFileName et appelle la deuxième méthode surchargée en ajoutant le TFileStream en tant que paramètre AStream.

Le téléchargement des fichiers sur Kinvey s'effectue en deux étapes :

  1. UploadFile envoie une requête POST à Kinvey afin de récupérer l'URL de téléchargement où il est possible de télécharger le fichier. La première étape ne télécharge pas le contenu du fichier, elle récupère uniquement l'URL de téléchargement.
  2. UploadFile envoie ensuite une requête PUT à Kinvey indiquant l'URL de téléchargement et envoyant le contenu du fichier.

Remarque : Kinvey utilise Google Cloud Storage pour stocker les fichiers.

Voir aussi