Favoriten

Favoriten können in DMS auf Akten/Ordnern und natürlich Dokumenten gesetzt werden. Generell kann man solche Objekte zu den Favoriten des Anwenders hinzufügen oder sie daraus entfernen. Die Favoriten werden pro Anwender verwaltet.

Dokumentfavoriten

// zufügen
var success = await dms.Favorites.AddDocumentsToFavorites(listOfDocumentIds);
// entfernen
var success = await dms.Favorites.RemoveDocumentsFromFavorites(listOfDocumentIds);

Mit diesen beiden Aufrufen können die Dokumentfavoriten verändert werden.

Akten-/Ordnerfavoriten

ab API 7.5.31 / DMS 7.4

// zufügen
var success = await dms.Favorites.AddContainerToFavorites(dossierOrFolderId);
// entfernen
var success = await dms.Favorites.RemoveContainerFromFavorites(dossierOrFolderId);

Mit diesen beiden Aufrufen kann eine Akte oder ein Ordner zu den Favoriten hinzugefügt, bzw. entfernt werden.

Favoriten abfragen

Die Favoriten werden über eine einzige Methode abgefragt und enthalten sowohl die Dokument- als auch die Akten/Ordnerfavoriten.

var modus = FavLoadModus.All;
var favorites = await dms.Favorites.LoadContainersByFavorites(orderField, modus);

Das Ergebnisobjekt enthält mehrere Id-Listen für die unterschiedlichen Favoritenarten. favorites.ManualDocumentFavorites enthält alle Dokument-Ids, welche in der Favoritenliste enthalten sind. Allerdings sind hier auch zum Löschen markierte Dokumente enthalten. Darum können diese über die Liste DeleteMarkedDocumentIds identifiziert und entsprechend behandelt werden.

Damit eine effiziente Ermittlung der zugehörigen Akten/Ordner möglich ist, werden deren Ids ebenfalls mitgeliefert in ContainersOfManualDocumentFavorites.

Vom Anwender explizit gesetzt Akten-/Ordnerfavoriten sind in der Liste ManualContainerFavorites enthalten.

Die Liste der automatischen Containerfavoriten funktioniert etwas anders und ist in der Regel leer.

Über den modus-Parameter kann das Ergebnis auf die manuellen Favoriten begrenzt werden. Es werden dann weder die automatischen Favoriten, noch die liste der zum Löschen markierten Dokumente geliefert. Diese Listen sind dann leer.