Allgemeine Objekt-Methoden und -Eigenschaften

Diese Dokumentation beschreibt die Methoden und Eigenschaften, mit denen Sie Objekte in agorum core lesen, ändern und verwalten können.

In agorum core ist grundsätzlich jedes gespeicherte Element (Datei, Ordner, E-Mail, Notiz, Benutzer, ACL usw.) ein Objekt vom Typ GlobalObject. Die hier dokumentierten Methoden und Eigenschaften stehen daher auf sehr vielen Objekten zur Verfügung.

Zusätzlich gibt es Methoden und Eigenschaften, die nur für bestimmte Objektarten (Dateien, Ordner, E-Mails) sinnvoll oder wirksam sind. Diese Methoden sind in eigene Dokumentationen ausgelagert.

Warum gibt es diese allgemeinen Objekt-Methoden und -Eigenschaften?

Der agorum core Server ist in Java implementiert. Intern gibt es einen Basis-Datentyp namens GlobalObject, von dem alle weiteren, nach außen sichtbaren Datentypen abgeleitet sind. Alle diese konkreten Objekttypen erben die Grundeigenschaften und -funktionen von GlobalObject.

agorum core lässt sich über JavaScript erweitern. Damit ein JavaScript-Entwickler die Java-Objekte des Servers verwenden kann, wird die Rhino-Engine als Brücke zwischen Java und JavaScript eingesetzt. Rhino stellt alle öffentlichen Java-Methoden und -Properties eines Objekts automatisch in JavaScript zur Verfügung. Aus einer Java-Methode wird in JavaScript sowohl der klassische Funktionsaufruf als auch die kompakte Property-Schreibweise nutzbar:

let n1 = object.getName();  // Funktionsaufruf
let n2 = object.name;       // Property-Schreibweise

Voraussetzung für die Beispiele

In allen Beispielen wird davon ausgegangen, dass Sie bereits ein Objekt geladen haben. Dieses können Sie beispielsweise über die Bibliothek common/objects holen:

let objects = require('common/objects');
let object = objects.find('<Object.ID oder UUID oder Pfad>');

Für weitere Informationen zum Laden von Objekten siehe JavaScript-Bibliothek common/objects.

Dokumentationen der Methoden und Eigenschaften

Objekttyp	Beschreibung	Link
Allgemeine Methoden und Eigenschaften	Methoden und Eigenschaften, die auf allen Objekttypen verfügbar sind: Name, ID, UUID, Beschreibung, Zeitstempel, Ersteller/Besitzer, ACLs, Anhänge, Historie, Berechtigungsprüfungen usw.	Allgemeine Objekt-Methoden und -Eigenschaften - Basis
Dateien	Methoden und Eigenschaften, die speziell für Datei-Objekte relevant sind: Check-out/Check-in, Kommentar zum Einchecken, Zugriff auf den DocumentText.	Allgemeine Objekt-Methoden und -Eigenschaften - Dateien
Ordner	Methoden und Eigenschaften, die nur für Ordner sinnvoll sind: Auflisten von Inhalten, Erstellen von Unterordnern, Prüfen, ob es sich um einen Ordner handelt.	Allgemeine Objekt-Methoden und -Eigenschaften - Ordner
E-Mails	Methoden und Eigenschaften, die im Kontext von E-Mail-Objekten relevant sind: Erkennen von Mail-Anhängen, Mail-Body und Zugriff auf Mail-Anhänge.	Allgemeine Objekt-Methoden und -Eigenschaften - E-Mails