Referencia API del cliente
API del cliente
El cliente sobre el que están hechos el drive y los hooks;
createMemoryClient responde igual, desde la página. Un rechazo del servidor se lanza como un RequestError con su status y su code: name-taken, in-trash, over-quota, forbidden…Crea uno
import { createDriveClient } from '@rebofiles/drive'; // or @rebofiles/react
const client = createDriveClient({
base: '/api/files',
headers: async () => ({ authorization: `Bearer ${await token()}` }),
parallel: 3, // parts at once, of each file
retry: { attempts: 5, delay: 1000 }, // a part that fails, again
});
const { entries } = await client.list(null);
const file = await client.upload(input.files[0], { parent: entries[0].id, onProgress: ({ sent, size }) => draw(sent / size) });Leer
| Método | What it does |
|---|---|
| list(folder) | Lo que hay en una carpeta, o arriba del todo con null, y la ruta hasta ella. |
| entry(id) | Una entrada, dónde está y si está en la papelera. |
| recent() | Los últimos archivos cambiados. |
| trash() | Lo que hay en la papelera de uno. |
| shared() | Lo que otros compartieron con quien pregunta. |
| sharedNew() | Cuántos de esos son nuevos desde la última vez que miró. |
| search(query, { within, trashed }) | Por nombre: cada palabra, en mayúsculas o minúsculas, con o sin acentos. |
| searchText(query) | Por lo que está escrito en los archivos, cada uno con un trozo de su texto. |
| activity(id, limit?) | Quién hizo qué en una entrada, y dentro de una carpeta; lo más nuevo primero. |
| usage() | Los bytes que uno guarda, y cuántos puede. |
| starred() | Lo que destacó quien pregunta, lo último destacado primero. |
| withField(name, value) | Lo que tiene un campo con un valor, de lo que uno puede leer: los archivos de un cliente, de un caso. |
Cambiar
| Método | What it does |
|---|---|
| createFolder(name, parent) | Una carpeta; “(2)” cuando el nombre está ocupado. |
| rename(id, name, 'keep-both'?) | Se rechaza si el nombre ya existe ahí, salvo que se conserven ambos. |
| move(id, parent, 'keep-both'?) | A otra carpeta, o arriba del todo. |
| setColor(id, color | null) | Una carpeta en uno de los nueve colores del drive, o en el suyo de nuevo. |
| copy(id, parent?) | Una copia de un archivo, sus bytes copiados en el almacenamiento: junto a él, o en el propio inicio donde no se puede poner. |
| setFields(id, { name: value | null }) | Campos de tu aplicación en una entrada, cada uno con su texto, o quitado con null. |
| star(id, starred?) | Destacado por quien pregunta, o ya no con false: lo suyo, que nadie más ve. |
| moveToTrash(id) | A la papelera, con lo que tiene dentro. |
| restore(id) | Fuera de la papelera, de vuelta donde estaba. |
| deleteForever(id) | Eliminado, también sus bytes. |
| emptyTrash() | Toda la papelera de uno, eliminada. |
| restoreVersion(id, version) | Una versión antigua de vuelta, como una nueva, sin volver a enviar sus bytes. |
Subidas
| Método | What it does |
|---|---|
| upload(file, { parent, file, onProgress, signal, images, text, sha256 }) | Un archivo en partes, reanudado tras un corte; file para una nueva versión; sus imágenes reducidas, su placeholder y su texto se envían después. |
| duplicates(hashes) | Los archivos que ya tienen esos bytes, de entre los que uno puede leer. |
Compartir
| Método | What it does |
|---|---|
| share(id, who, role, days?) | Con alguien, o con todos los que han iniciado sesión como *, como lector, comentarista o editor. |
| unshare(id, who) | Ya no; cualquiera puede salir de lo que se compartió con él. |
| people(query) | Quién coincide con lo escrito, personas y grupos, como los encuentra la aplicación (people del servidor). |
| names(ids) | Cómo se llama cada uno de estos ids, de personas y de group:; el que no se conoce se omite. |
| createLink(id, days, { password, once, uploads, request }) | Un enlace para leerlo sin iniciar sesión, y su token; de una carpeta, uno que también recibe archivos o solo los recibe; con request, los documentos que pide. |
| updateLink(id, link, { days, uploads, request, closed }) | Un enlace cambiado: por días desde hoy, lo que recibe y pide; cerrado, o abierto otra vez. |
| linkToken(id, link) | El token de un enlace hecho antes: siempre el mismo. |
| removeLink(id, link) | Retirado. |
Solicitudes
| Método | What it does |
|---|---|
| received() | Lo que llegó por las solicitudes de archivos de uno, lo más nuevo primero. |
| requests() | Las solicitudes de archivos de uno: cada carpeta, su enlace, su token y lo que llegó. |
| remind(id, link) | A quien se le envió una solicitud, recordado ahora de lo que falta, con los reminders del servidor. |
| expiring(days?) | Archivos que uno puede leer cuyo campo expires llega en tantos días (15), o ya pasó; lo más próximo primero. |
| review(id, status, reason?) | Un archivo que llegó, aceptado, o devuelto con un motivo que ve la página de quien lo envió; sin revisar con null. |
Archivos
| Método | What it does |
|---|---|
| url(id, { version, inline, size }) | Una dirección para leer un archivo: una descarga, o para mostrarlo en un tamaño. |
| urls(ids, { inline, size }) | Las de muchos archivos a la vez, cada una con hasta cuándo es válida. |
| pack(ids) | Lo que contiene un archivo comprimido de algunas entradas, para downloadZip. |
Ajustes
| Método | What it does |
|---|---|
| settings() | Los ajustes del drive, los propios, y si uno puede cambiar los del drive. |
| saveSettings(settings) | Los del drive, para quien pueda configurarlo. |
| saveMySettings(mine) | El idioma y el tema propios. |
En vivo
| Método | What it does |
|---|---|
| watch(onChange, { onState }) | Lo que cambia cualquiera, en el momento: las carpetas y entradas de cada cambio que uno puede ver. Vuelve solo tras un corte. Devuelve lo que lo detiene. |
Comentarios
| Método | What it does |
|---|---|
| comments(id) | Lo que se dice de una entrada, cada hilo con sus respuestas debajo. |
| addComment(id, text, replyTo?) | Un comentario, o una respuesta bajo otro; se avisa a los nombrados con @. |
| editComment(id, comment, text) | Lo que dice el comentario propio. |
| resolveComment(id, comment, resolved?) | Un hilo resuelto, o abierto de nuevo. |
| removeComment(id, comment) | Retirado, con sus respuestas: por su autor, o el dueño. |
Conservar
| Método | What it does |
|---|---|
| hold(id, reason?) | Una retención legal: ni ella ni lo que tiene dentro va a la papelera ni se borra hasta quitarla. Para quien puede configurar. |
| release(id) | La retención quitada. |
| exportPerson(user?) | Todo lo de una persona, para un .zip: lo suyo, lo que dijo y lo que hizo. |
Avisos
| Método | What it does |
|---|---|
| notifications() | Lo que se le avisó a quien pregunta (compartido con él o un grupo suyo, nombrado en un comentario), lo más nuevo primero, y cuántos son nuevos. |
| sawNotifications() | Ya miró: ninguno es nuevo. |
Administrar
| Método | What it does |
|---|---|
| adminUsage() | Para quien puede configurar: los archivos, carpetas y bytes de cada persona, y de todo el drive. |
| adminRequests() | Para quien puede configurar: cada solicitud abierta, a quién se envió y lo que aún falta, para recordárselo. |
| adminActivity(limit?) | Para quien puede configurar: lo que se hizo en cualquier parte del drive, lo más nuevo primero. |