====== Web [En cours de Traduction Wismerheal][WSL] ======
Cet objet vous permet de télécharger des données.
===== Fonctions =====
==== Web ====
Fonction de construction.
=== Syntaxe ===
var myObject = new Web(eventsAndOptions);
=== Arguments ===
- eventsAndOptions - (object) l'évènement qui peut être appelé
* onFinished - ([[#onFinished|onFinished]]) cappelé quand les données sont téléchargées
* onDownloadProgress - ([[#onDownloadProgress|onDownloadProgress]]) appelé quand le téléchargement en cours progresse
* onError - ([[#onError|onError]]) appelé quand une erreur survient
* file - ([[en:code:data:file|File]] or string) le fichier ou nom de fichier à utiliser comme destination pour le téléchargement de données, si ce n'est pas définit les données seront stockées dans la RAM
=== Example ===
var myObject = new Web();
var myObject = new Web({
onFinished: function()
{
Console.print("Finished!");
},
file: "myFile.txt"
});
===== Méthodes =====
==== download ====
Débute le téléchargement.
=== Syntaxe ===
myObject.download(url, options);
myObject.download(url);
=== Arguments ===
- url - (string) l'url de la ressources à télécharger
- options - (object) options
* rawHeaders - (object) suite d'entête à définir
* method - (Method) la méthode à utiliser ("get" ou "post")
* postData - (object) "post" les données à envoyées
* query - (object) acquisition d'élément
* user - (string) le nom d'utilisateur à utilisé si demandé
* password - (string) le mot de passe à utilisé si demandé
=== Renvoie ===
* (Web) ce Web
=== Exceptions ===
* (OpenFileError) impossible d'ouvrir le fichier de destination
=== Notes ===
Cette méthode est asynchrone, cela signifie que le renvoi s'effectue avant que les données ne soient téléchargées.
Pour savoir quand le téléchargement est terminé, utilisez l'évènement [[#onFinished|onFinished]] ou la méthode [[#isDownloading|isDownloading]] .
==== isDownloading ====
Renvoie vrai si les données sont toujours en cours de téléchargement.
=== Syntaxe ===
myObject.isDownloading();
=== Renvoie ===
* (boolean) vrai si les données sont toujours en cours de téléchargement
==== toImage ====
Renvoie les données téléchargée comme un [[en:code:core:image|Image]] .
=== Syntaxe ===
myObject.toImage();
=== REnvoie ===
* ([[en:code:core:image|Image]]) l'image
=== Notes ===
Vous ne pouvez pas utiliser cette méthode si le chemin de destination du fichier ne dispose pas de données car aucune donnée ne sera conservée en mémoire.
==== toText ====
Renvoie les données téléchargée comme un texte.
=== Syntaxe ===
myObject.toText(encoding);
myObject.toText();
=== Arguments ===
- encoding - ([[en:code:core:global#encoding|Encoding]]) l'encodage à utiliser
=== Renvoie ===
* (string) le texte
=== Notes ===
Vous ne pouvez pas utiliser cette méthode si le chemin de destination du fichier ne dispose pas de données car aucune donnée ne sera conservée en mémoire.
==== toRawData ====
Renvoie les données téléchargées comme une [[en:code:core:rawdata|RawData]] .
=== Syntaxe ===
myObject.toRawData();
=== Renvoie ===
* ([[en:code:core:rawdata|RawData]]) la série de données
=== Notes ===
Vous ne pouvez pas utiliser cette méthode si le chemin de destination du fichier ne dispose pas de données car aucune donnée ne sera conservée en mémoire.
==== cancel ====
Annule le téléchargement.
=== Syntaxe ===
myObject.cancel();
=== Renvoie ===
* (Web) ce Web
===== Évènements =====
==== onFinished ====
Appelé quahd les données sont téléchargées.
=== Syntaxe ===
myObject.onFinished = function() {};
=== Example ===
myObject.onFinished = function()
{
//Event action
};
==== onDownloadProgress ====
Appelé quand la progression du téléchargement a changé.
=== Syntaxe ===
myObject.onDownloadProgress = function(bytesReceived, bytesTotal) {};
=== Arguments ===
- bytesReceived - (integer) reçoit le compte de byte
- bytesTotal - (integer) compte total de byte
=== Example ===
myObject.onDownloadProgress = function(bytesReceived, bytesTotal)
{
//Event action
};
==== onError ====
Appelé quand une erreur survient.
=== Syntaxe ===
myObject.onError = function(errorText) {};
=== Arguments ===
- errorText - (string) un texte décrivant l'erreur
=== Example ===
myObject.onError = function(errorText)
{
//Event action
};
===== Enumerations =====
==== Méthode====
La méthode de téléchargement.
=== Valeurs ===
- Get: utilisez la méthode "get" (défaut)
- Post: utilisez la méthode "post"