Cette fonction permet de télécharger un fichier depuis le serveur et éventuellement d'en afficher une prévisualisation dans le navigateur. Selon les paramètres, une copie du fichier pourra être faite dans le répertoire temporaire, puis être supprimée à l'expiration du téléchargement, ou le fichier pourra être lu directement jusqu'à l'expiration du téléchargement.
Domaine d'application
- Client Adélia Cloud.
Paramètres
ALPHA (n) |
NomFichier |
Nom du fichier à télécharger. |
ALPHA (n) |
TypeMime |
Type Mime du fichier ou *BLANK. |
BOOL |
Inline |
Indique si le fichier doit être affiché dans une prévisualisation. Si inline est positionnée à *VRAI et que le type mime du fichier est supporté par le navigateur (images, etc.), une prévisualisation du fichier s'affiche par-dessus le bureau. Sinon, le fichier est téléchargé. |
BOOL |
CreateTempCopy |
Si cette option est positionnée à *VRAI, une copie du fichier sera créée dans le répertoire temporaire de la machine, puis détruite à l'expiration du téléchargement. Si elle est positionnée à *FAUX, le gestionnaire de téléchargement accédera directement au fichier. Dans ce cas, il est nécessaire que le fichier reste disponible et ne soit pas modifié pendant la durée configurée pour le cache de téléchargements. |
BOOL |
CodeRetour |
Code retour de l'opération : *VRAI si l'appel de la fonction a réussi. *FAUX dans le cas contraire. |
Note :
Les données sont conservées en cache pendant 30 minutes (par défaut). Cela permet de reprendre un téléchargement interrompu ou de lancer plusieurs requêtes de téléchargement.
Ce temps d'attente est paramétrable comme suit : dans le fichier ehcache.xml de votre application Wagon, modifiez les paramètres timeToIdleSeconds et timeToLiveSeconds du cache wagonDownloadCache.
Remarque : il est fortement déconseillé de modifier les autres paramètres de ce fichier, notamment les paramètres des autres caches.
Par exemple :
↑ Haut de pageFileName = 'HOME:\documents\document.docx' MimeType = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' APPELER_DLL 'VATOOLBX.DLL' 'VaToolBxCloudDownloadFileEx' FileName MimeType *FAUX *FAUX CodeRetour