index
@mineflow/client-react / documents
documents
Type Aliases
| Type Alias | Description |
|---|---|
| ConfirmDocumentBody | Тело шага confirm (опционально; по умолчанию {}). |
| ConfirmDocumentResult | Результат confirm: документ в статусе ready. |
| CreateDocumentBody | Тело шага initiate (метаданные файла + сущность-владелец). |
| DocumentList | Список метаданных документов сущности (массив). |
| DocumentListItem | Один элемент DocumentList (метаданные документа). |
| DownloadUrlResult | Результат GET документа: presigned URL для скачивания/просмотра. |
| InitiateUploadResult | Результат initiate: id pending-документа + presigned PUT URL. |
| ListDocumentsQuery | Query-фильтры списка документов (entityType + entityId). |
Variables
| Variable | Description |
|---|---|
| documentOps | Операции-эндпоинты документов: (client, …) => Promise<data>. Используются напрямую из платформенного оркестратора загрузки (mobile photo-queue, web), который сам делает бинарный PUT между initiate и confirm. |
Functions
| Function | Description |
|---|---|
| useDocumentDownloadUrl | Presigned GET URL документа (для просмотра, когда локальной копии файла уже нет, напр. на другом устройстве/после очистки кэша). Запрос не запускается при пустом id. |
| useDocumentsByEntity | Документы сущности-владельца (entityType+entityId) — кросс-девайс список (ADR-0051): утверждающий на другом устройстве видит вложения рапорта. Запрос не запускается при пустом entityId. |