📂
Intercambio archivos
Te explicamos cómo usar nuestro SDK de intercambio de archivos.
La documentación y recursos necesarios para utilizar FileShare SDK está estrictamente restringido para uso de clientes de Videsk. Nos reservamos el derecho de restringir su acceso y uso, si detectamos un uso inadecuado.
Este SDK te permite utilizar la función de intercambio de archivos de forma sencilla, pero te permite definir tu propia interfaz o flujos.
El sistema de intercambio de archivos opera como una bandeja de envío, que posee a su vez una lista de archivos por enviar o ya enviados.
Esta función es activada por el agente manualmente, debes escuchar los eventos antes de comenzar a enviar archivos.
Para utilizar el intercambio de archivo necesitas cargar:
HTML
Javascript
<script src="https://cdn.videsk.io/sdk/filesharing.min.js" async></script>
const script = document.createElement('script');
script.src = "https://cdn.videsk.io/sdk/filesharing.min.js";
script.setAttribute('async', true);
document.appendChild(script);
Este SDK no requiere de una instancia manual, es decir,
new FileSharing()
. Actualmente, debes utilizarlo en conjunto con nuestro otro SDK Phone.Esto lo podrás hacer usando un método llamado
addExtension
, la cual permite añadir extensiones o características extras.const phone new Phone();
phone.addExtension({ name: 'fileshare', extension: FileShare });
En el caso de la clave (key)
extension
, corresponde a la clase FileShare
. Por lo tanto, debes cargar el script
desde nuestro CDN previamente a este código para poder referenciarlo.Una vez que hagas esto, automáticamente Phone SDK se hará cargo del intercambio a nivel de red y deberás escuchar los diferentes eventos.
Para obtener acceso a la instancia
FileShare
deberás usar el método extensionGetModule
.const fileshare = phone.extensionGetModule('fileshare');
Esto devuelve una instancia de la clase
FileShare
con sus métodos y propiedades.Para acceder al listado de archivos debes usar la propiedad
queue
.const fileshare = phone.extensionGetModule('fileshare');
const files = fileshare.queue;
Para obtener un listado actualizado puedes usar los eventos usando la propiedad de la instancia
fileshare.queue
.Los archivos que se envíen mediante el SDK serán añadidos a un
queue
el cual corresponde a un Array
.fileshare.queue
// output
[{...}]
Cada elemento dentro de este
Array
es un Object
, que está compuesto de:{
buffer: ArrayBuffer,
endedAt: Number,
id: String,
meta: Object,
progress: Number,
received: Number,
size: Number,
startedAt: Number,
status: String
}
Corresponde al Buffer en memoria del archivo a enviar o recibido. Debes convertir este ArrayBuffer en el tipo de dato que necesites. Más información sobre ArrayBuffer acá.
Corresponde a la fecha de término en el intercambio de archivos como
timestamp
.Corresponde a la fecha de inicio en el intercambio de archivos como
timestamp
.Corresponde al id del archivo intercambiado.
Corresponde a los meta datos del archivo a enviar o enviado, como un
Object
. Esta compuesto por name
y type
, siendo el nombre del archivo y tipo (MIME) respectivamente.Corresponde al total porcentual intercambiado desde 0 a 100.
Corresponde al tamaño en bytes recibidos.
Corresponde al tamaño del archivo a enviar o recibido.
Corresponde al estado del archivo a enviar o recibido, el cual puede ser
queued
, canceled
, sending
, receiving
, completed
.
Última actualización 4mo ago