patchFoldersRemoveDocuments method

Future<RestApiResponse> patchFoldersRemoveDocuments(RestApiDOCUframeFolderType folderType, String folderId, List<String> documentOids, { String className = '', bool moveToTrashBin = true, dynamic deep = false, })

Entfernt Dokumente aus einem Ordner

Entfernt die Verknüpfung von Dokumenten zu einem Ordner. Optional können die Dokumente in den Papierkorb verschoben werden.

folderType - Der Typ des Quellordners folderId - Die ID des Quellordners documentOids - Liste der zu entfernenden Dokument-OIDs className - Klassenname für spezielle Ordnertypen (Favoriten, Historie) moveToTrashBin - Dokumente in Papierkorb verschieben (Standard: true) deep - Tiefe Entfernung aus Unterordnern (Standard: false)

Returns: RestApiResponse mit dem Entfernungsstatus

Beispiel:

RestApiResponse response = await api.v1.folders.patchFoldersRemoveDocuments(
  RestApiFolderType.oid,
  "folder-oid-12345",
  ["doc-123", "doc-456"],
  moveToTrashBin: false
);

Implementation

Future<RestApiResponse> patchFoldersRemoveDocuments(
  RestApiDOCUframeFolderType folderType,
  String folderId,
  List<String> documentOids, {
  String className = '',
  bool moveToTrashBin = true,
  dynamic deep = false,
}) {
  return _execute(
    method: ApiHttpMethod.patch,
    path:
        '/folders/remove/${Uri.encodeComponent(folderType.value)}/'
        '${Uri.encodeComponent(folderId)}',
    queryParameters: className.isEmpty
        ? const <String, String>{}
        : <String, String>{'class': className},
    body: jsonEncode(<String, dynamic>{
      'documents': documentOids,
      'moveToTrashBin': moveToTrashBin,
      'deep': deep,
    }),
    operation: 'patchFoldersRemoveDocuments',
  );
}