Allgemeine Objekt-Methoden - Ordner

Diese Dokumentation beschreibt Methoden und Eigenschaften, die nur für Objekte vom Typ Ordner sinnvoll sind. Ob ein Objekt ein Ordner ist, können Sie über die Eigenschaft isFolder prüfen.

Neben den hier beschriebenen Methoden und Eigenschaften gelten alle aus Allgemeine Objekt-Methoden und -Eigenschaften - Basis weiterhin.

Bei den Beispielen wird davon ausgegangen, dass Sie bereits einen Ordner geladen haben:

let objects = require('common/objects');
let folder  = objects.find('/agorum/roi/Files');

isFolder

Aufgabe	Datentyp
Nur lesend. Prüft, ob das Objekt ein Ordner ist.	boolean

Beispiel

if (folder.isFolder) {
  // Object is a folder - folder methods can be used safely
}

Bedingungen/Ausnahmen

Leserechte notwendig.

items()

Aufgabe	Datentyp
Liefert alle Objekte, die im Ordner verknüpft sind, als Array zurück.	Object[]

Wird ein leeres Array zurückgegeben, wenn der Ordner leer ist.

Hinweis:items() steht nur auf Ordner-Objekten zur Verfügung. Wird die Methode auf einem Objekt aufgerufen, das kein Ordner ist (z. B. einer Datei), wird ein Fehler geworfen. Prüfen Sie daher vor dem Aufruf mit isFolder, ob es sich um einen Ordner handelt.

Beispiel

if (folder.isFolder) {
  let names = folder.items().map(item => item.name);
  names.forEach(name => console.log(name));
}

Bedingungen/Ausnahmen

Leserechte notwendig.
Zurückgegeben werden nur Objekte, die der aktuelle Benutzer sehen darf.

itemsCount

Aufgabe	Datentyp
Nur lesend. Liefert die Anzahl der Unterelemente des Ordners zurück, ohne dass alle Elemente geladen werden müssen. Diese Property ist bei großen Ordnern deutlich effizienter als das Längen-Ermitteln über items().	int

Beispiel

let count = folder.itemsCount;
console.log('Ordner enthält ' + count + ' Elemente');

Bedingungen/Ausnahmen

Leserechte notwendig.

itemsNoFolder

Aufgabe	Datentyp
Nur lesend. Liefert alle Elemente des Ordners außer Unterordnern zurück.	Object[]

Beispiel

let files = folder.itemsNoFolder;
files.forEach(file => console.log('Datei: ' + file.name));

Bedingungen/Ausnahmen

Leserechte notwendig.

itemsOnlyFolder

Aufgabe	Datentyp
Nur lesend. Liefert ausschließlich die Unterordner des Ordners zurück.	Object[]

Beispiel

let subfolders = folder.itemsOnlyFolder;
subfolders.forEach(sub => console.log('Unterordner: ' + sub.name));

Bedingungen/Ausnahmen

Leserechte notwendig.

createPath(path)

Aufgabe	Datentyp
Erstellt einen oder mehrere Unterordner unterhalb des aktuellen Ordners. Existiert der Pfad bereits, wird der bestehende Pfad zurückgegeben (die Funktion ist idempotent).	Object (unterster erstellter Ordner)

Die Methode wird direkt auf einem Ordner-Objekt aufgerufen, nicht global.
Ein Basisordner muss also vorher über objects.find() geladen werden.
Der übergebene Pfad kann mehrere Ordner untereinander enthalten (z. B. 'Archive/2024/Q1').

Beispiel – einzelnen Ordner anlegen

let objects = require('common/objects');
let base    = objects.find('/agorum/roi/Files');

if (base.isFolder) {
  let newFolder = base.createPath('Neuer Ordner');
  console.log('Erstellt: ' + newFolder.anyFolderPath);
}

Beispiel – verschachtelte Struktur anlegen

let base = objects.find('/agorum/roi/Files');

let deep = base.createPath('Archive/2026/Q1/Januar');
console.log('Tiefster Ordner: ' + deep.anyFolderPath);

Rückgabewert

Sie erhalten den untersten Ordner der neu erstellten (oder bereits vorhandenen) Struktur zurück.

Bedingungen/Ausnahmen

Schreibrechte / Ordner-Anlege-Rechte auf dem Basisordner notwendig.
Existiert der Pfad bereits, wird der vorhandene Ordner zurückgegeben. Es wird kein Fehler geworfen.