Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core für Entwickler > agorum core JavaScript-API > Allgemeine Objekt-Methoden und -Eigenschaften

Allgemeine Objekt-Methoden und -Eigenschaften - Basis

Diese Dokumentation beschreibt Methoden und Eigenschaften, die auf jedem Objekt in agorum core zur Verfügung stehen. Sie sind thematisch gruppiert, damit Sie ähnliche Funktionen leicht finden.

Schreibweise Methode vs. Eigenschaft: JavaScript (Rhino-Engine) stellt agorum core Java-Getter wie getName() zusätzlich als Eigenschaft (name) bereit. Eigenschaften greifen Sie ohne Klammern ab (z. B. object.name), Methoden rufen Sie mit Klammern auf (z. B. object.parents()). Achten Sie in den Beispielen genau auf diese Unterscheidung.

Bei den Beispielen wird davon ausgegangen, dass Sie bereits ein Objekt geladen haben:

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

Identifikation & Namen

Jedes Objekt in agorum core besitzt eine eindeutige Kennung (ID/UUID) sowie einen Namen. Zusätzlich gibt es abgeleitete Namensvarianten (Basisname, Datei-Erweiterung) und einen Übersetzungsschlüssel für die Oberfläche.

Enthaltene Methoden

ID

Aufgabe Datentyp
Nur lesend. Liefert die eindeutige ID des Objekts als String. string

Beispiel

let id = object.ID;

Bedingungen/Ausnahmen

getId()

Aufgabe Datentyp
Liefert die numerische, serverweit eindeutige ID des Objekts als Zahl (long). long

Beispiel

let id = object.getId();

Bedingungen/Ausnahmen

UUID

Aufgabe Datentyp
Setzen und Holen der UUID (Universally Unique Identifier) des Objekts. Die UUID wird beim Anlegen automatisch vergeben und identifiziert das Objekt eindeutig. string

UUID setzen

object.UUID = '0e3a3c00-d104-11e5-a821-080027cddacf';

UUID holen

let uuid = object.UUID;

Bedingungen/Ausnahmen

name

Aufgabe Datentyp
Setzen und Holen des Namens des Objekts. Bei Dateien enthält der Name auch die Datei-Erweiterung. string

name setzen

object.name = 'neuer-name.txt';

name holen

let name = object.name;

Bedingungen/Ausnahmen

baseName

Aufgabe Datentyp
Nur lesend. Liefert den Namen des Objekts ohne Datei-Erweiterung zurück. string

Beispiel

let baseName = object.baseName;
// For an object named "document.pdf":
// baseName === 'document'

Bedingungen/Ausnahmen

nameExtension

Aufgabe Datentyp
Nur lesend. Liefert die Datei-Erweiterung des Objekts zurück (ohne Punkt). string

Beispiel

let nameExtension = object.nameExtension;
// For an object named "document.pdf":
// nameExtension === 'pdf'

Bedingungen/Ausnahmen

displayName

Aufgabe Datentyp
Nur lesend. Liefert den Anzeigenamen des Objekts, wie er in der Oberfläche dargestellt wird (ggf. übersetzter Name). string

Beispiel

let displayName = object.displayName;

Bedingungen/Ausnahmen

Leserechte notwendig.

objectTextKey

Aufgabe Datentyp
Setzen und Holen des objectTextKey. Dieser Übersetzungsschlüssel wird für die Übersetzung von Ordnernamen oder ähnlichen Übersetzungsobjekten verwendet. string

objectTextKey setzen

object.objectTextKey = 'agorum.textkey.file.private';

objectTextKey holen

let objectTextKey = object.objectTextKey;

Bedingungen/Ausnahmen

Berechtigungen & Zugriffssteuerung

agorum core steuert den Zugriff auf jedes Objekt über Access-Control-Lists (ACLs). Zusätzlich können Scope-ACLs vergeben werden, die bereichsweise gelten. Darüber hinaus können Sie für den aktuellen Benutzer prüfen, ob eine konkrete Aktion (Auschecken, Löschen, Ändern etc.) erlaubt ist, ohne die ACL selbst zu lesen.

Enthaltene Methoden und Eigenschaften

acl

Aufgabe Datentyp
Setzen und Holen der Access-Control-List (ACL) eines Objekts. Die ACL bestimmt, welche Benutzer/Gruppen mit welchen Rechten auf das Objekt zugreifen dürfen. AccessControlList

ACL setzen

object.acl = objects.find('acl:public');

ACL lesen

let acl = object.acl;

Bedingungen/Ausnahmen

scopeAcls

Aufgabe Datentyp
Nur lesend. Liefert alle Scope-ACLs des Objekts zurück. Sind keine Scope-ACLs gesetzt, wird null zurückgegeben (kein leeres Array). AccessControlList[] oder null

Beispiel

let scopeAcls = object.scopeAcls || [];
scopeAcls.forEach(acl => console.log('- ' + acl.name));

Bedingungen/Ausnahmen

deleteScopeAcl(acl)

Aufgabe Datentyp
Entfernt eine oder mehrere Scope-ACLs vom Objekt. Es werden ausschließlich die Zuordnungen entfernt. Die ACL-Objekte selbst bleiben erhalten. –

Beispiel – einzelne Scope-ACL entfernen

let acl = objects.find('acl:ACL_ProjectA');
object.deleteScopeAcl(acl);

Beispiel – mehrere Scope-ACLs auf einmal entfernen

let acls = [
  objects.find('acl:ACL_ProjectA'),
  objects.find('acl:ACL_ProjectB')
];
object.deleteScopeAcl(acls);

Bedingungen/Ausnahmen

deleteAllScopeAcls()

Aufgabe Datentyp
Entfernt alle Scope-ACLs vom Objekt. Es werden ausschließlich die Zuordnungen zwischen Objekt und Scope-ACLs entfernt. Die ACL-Objekte selbst bleiben erhalten. –

Beispiel

object.deleteAllScopeAcls();

Bedingungen/Ausnahmen

mayCheckOut

Aufgabe Datentyp
Nur lesend. Prüft, ob der aktuelle Benutzer das Objekt auschecken darf. boolean

Beispiel

if (object.mayCheckOut) {
  object.checkOut(null);
}

Bedingungen/Ausnahmen

Leserechte notwendig.

mayDelete

Aufgabe Datentyp
Nur lesend. Prüft, ob der aktuelle Benutzer das Objekt löschen darf. boolean

Beispiel

let mayDelete = object.mayDelete;

Bedingungen/Ausnahmen

Leserechte notwendig.

mayInsert

Aufgabe Datentyp
Nur lesend. Prüft, ob der aktuelle Benutzer in diesem Ordner ein Objekt ablegen darf (bei Ordnern) bzw. das Objekt in einen Ordner ablegen darf. boolean

Beispiel

let mayInsert = object.mayInsert;

Bedingungen/Ausnahmen

Leserechte notwendig.

mayModify

Aufgabe Datentyp
Nur lesend. Prüft, ob der aktuelle Benutzer die Attribute des Objekts ändern darf. boolean

Beispiel

let mayModify = object.mayModify;

Bedingungen/Ausnahmen

Leserechte notwendig.

mayRemove(parent)

Aufgabe Datentyp
Methode – mit Klammern aufrufen. Prüft, ob der aktuelle Benutzer das Objekt aus dem angegebenen Elternordner entfernen darf. boolean

Beispiel

let parent    = objects.find('/agorum/roi/Files/Inbox');
let mayRemove = object.mayRemove(parent);

Bedingungen/Ausnahmen

Leserechte notwendig.

writable

Aufgabe Datentyp
Nur lesend. Prüft, ob der aktuelle Benutzer auf das Objekt Schreibrechte hat. boolean

Beispiel

if (object.writable) {
  object.description = 'Neue Beschreibung';
}

Bedingungen/Ausnahmen

Leserechte notwendig.

Pfade & Parents

Ein Objekt in agorum core kann in mehreren Ordnern gleichzeitig verlinkt sein. Es hat daher möglicherweise mehrere Pfade und mehrere „Parents“ (übergeordnete Ordner). Die folgenden Methoden liefern Informationen über diese Verlinkungen.

Enthaltene Methoden und Eigenschaften

allFolderPath

Aufgabe Datentyp
Liefert alle Pfade zurück, unter denen das Objekt verknüpft ist. Da ein Objekt in agorum core in mehreren Ordnern verlinkt sein kann, sind auch mehrere Pfade möglich. string[]

Beispiel

let objects = require('common/objects');
let obj = objects.find('/agorum/roi/customers/example/js/test.js');

let paths = obj.allFolderPath;
paths.forEach(path => console.log(path));

Bedingungen/Ausnahmen

anyFolderPath

Aufgabe Datentyp
Liefert einen einzelnen Pfad zurück, unter dem das Objekt erreichbar ist. Ist das Objekt in mehreren Ordnern verlinkt, wird nur einer davon zurückgegeben. string

Beispiel

let objects = require('common/objects');
let object = objects.find('/agorum/roi/Files/document.pdf');

console.log('Objekt liegt unter: ' + object.anyFolderPath);

Bedingungen/Ausnahmen

parents()

Aufgabe Datentyp
Liefert alle Ordner zurück, in denen das Objekt verknüpft ist. Object[]

Beispiel

let objects = require('common/objects');
let object  = objects.find('/agorum/roi/Files/document.pdf');

let parentNames = object.parents().map(parent => parent.name);

Bedingungen/Ausnahmen

firstParent

Aufgabe Datentyp
Nur lesend. Liefert den ersten übergeordneten Ordner des Objekts. Bei mehrfach verknüpften Objekten wird ein beliebiger – aber deterministischer – Parent zurückgegeben. Object

Beispiel

let objects = require('common/objects');
let object  = objects.find('/agorum/roi/Files/example.pdf');

let parentName = object.firstParent.name;

Bedingungen/Ausnahmen

Leserechte notwendig.

getParent(name)

Aufgabe Datentyp
Liefert den übergeordneten Ordner mit dem angegebenen Namen zurück. Ein „Parent“ ist dabei ein Ordner, in dem das Objekt über eine FolderPathRelation verknüpft ist. Object

Beispiel

let objects = require('common/objects');
let object  = objects.find('/agorum/roi/customers/example/js/test.js');

let parentJs = object.getParent('js');

Bedingungen/Ausnahmen

hasParents()

Aufgabe Datentyp
Prüft, ob das Objekt in mindestens einem Ordner verknüpft ist. boolean

Beispiel

let hasParents = object.hasParents();

Bedingungen/Ausnahmen

Leserechte notwendig.

Anhänge

In agorum core kann jedes Objekt beliebig viele weitere Objekte als Anhänge referenzieren. Anhänge sind unabhängige Objekte, deren Beziehung zum Hauptobjekt über eine spezielle Relation gepflegt wird. Die folgenden Methoden helfen beim Hinzufügen, Ersetzen, Entfernen und Prüfen von Anhängen.

Enthaltene Methoden und Eigenschaften

attachments()

Aufgabe Datentyp
Liefert alle Anhänge des Objekts zurück. Diese Methode ist der bevorzugte Weg, um die Anhänge eines Objekts zu ermitteln. Object[]

Beispiel

let objects = require('common/objects');
let mainDoc = objects.find('/agorum/roi/Files/report.pdf');

let attachments = mainDoc.attachments();
attachments.forEach(a => console.log('- ' + a.name));

Bedingungen/Ausnahmen

addAttachment(object)

Aufgabe Datentyp
Hängt ein weiteres Objekt als Anhang an das aktuelle Objekt. Bestehende Anhänge bleiben erhalten. –

Beispiel

let objects = require('common/objects');

let mainDoc  = objects.find('/agorum/roi/Files/report.pdf');
let appendix = objects.find('/agorum/roi/Files/appendix.pdf');

mainDoc.addAttachment(appendix);

Bedingungen/Ausnahmen

removeAttachments(objects[])

Aufgabe Datentyp
Entfernt die angegebenen Objekte aus der Liste der Anhänge des aktuellen Objekts. Nur die übergebenen Anhänge werden entfernt, alle anderen bleiben erhalten. –

Beispiel

let objects = require('common/objects');

let main = objects.find('/agorum/roi/Files/report.pdf');
let a1   = objects.find('/agorum/roi/Files/appendix-a.pdf');
let a2   = objects.find('/agorum/roi/Files/appendix-b.pdf');

main.removeAttachments([a1, a2]);

Bedingungen/Ausnahmen

Schreibrechte notwendig.

hasAttachments()

Aufgabe Datentyp
Prüft, ob das Objekt Anhänge besitzt. boolean

Beispiel

if (object.hasAttachments()) {
  // Attachments are present
}

Bedingungen/Ausnahmen

attached

Aufgabe Datentyp
Nur lesend. Prüft, ob das Objekt an einem anderen Objekt als Anhang hängt. boolean

Beispiel

if (object.attached) {
  // The object is attached to another object
}

Bedingungen/Ausnahmen

attachedTo()

Aufgabe Datentyp
Liefert alle Objekte zurück, an denen das aktuelle Objekt als Anhang hängt. Object[]

Beispiel

let objects = require('common/objects');
let attachment = objects.find('/agorum/roi/Files/appendix.pdf');

// Get all objects this object is attached to
let hostObjects = attachment.attachedTo();
hostObjects.forEach(host => console.log(host.name));

Bedingungen/Ausnahmen

Historie & Versionen

Bei jeder relevanten Änderung an einem Objekt kann agorum core eine Historieninstanz anlegen: Das ist ein Schnappschuss des Objekts zu diesem Zeitpunkt. Die folgenden Methoden geben Zugriff auf diese Historien-Instanzen. Arbeitskopien (Working Copies), die beim Auschecken von Dateien entstehen, sind in der Dokumentation Allgemeine Objekt-Methoden und -Eigenschaften - Dateien beschrieben.

Enthaltene Methoden und Eigenschaften

historyCount

Aufgabe Datentyp
Nur lesend. Liefert die Anzahl der Historien-Instanzen des Objekts zurück. int

Beispiel

let historyCount = object.historyCount;

Bedingungen/Ausnahmen

Leserechte notwendig.

historyObjects

Aufgabe Datentyp
Nur lesend. Liefert ein Array mit allen Historien-Instanzen des Objekts zurück. Jede Instanz repräsentiert eine frühere Version. Object[]

Beispiel

let objects = require('common/objects');
let object = objects.find('/agorum/roi/Files/contract.pdf');

let histories = object.historyObjects;
histories.forEach(h => console.log(h.versionNumber + ': ' + h.checkinComment));

Bedingungen/Ausnahmen

Leserechte notwendig.

ensureHistory()

Aufgabe Datentyp
Erzwingt das Erzeugen einer Historie bei der nächsten Änderung am Objekt. Object (neue Objekt-Instanz)

Ohne ensureHistory kann es passieren, dass das System keine neue Historieninstanz anlegt, wenn die letzte Änderung zeitnah zurückliegt. Mit ensureHistory wird für die nächste Änderung garantiert eine Historieninstanz erzeugt.

Wichtige Punkte:

Beispiel – Name ändern und dabei Historie erzeugen

object.ensureHistory().name = 'neuer-name.pdf';

Beispiel – Inhalt aus einer anderen Datei setzen

Sie können den Inhalt einer Quelldatei (srcObj) auf ein Zielobjekt (dstObj) schreiben und dabei zuvor eine Historie auf dem Zielobjekt erzeugen:

srcObj.streamContent(dstObj.ensureHistory());

Beispiel – Metadaten setzen und dabei Historie erzeugen

let metadata = require('filingassistant/metadata');

metadata({
  my_status:       'archived',
  my_archive_date: new Date()
}).save(object.ensureHistory());

Bedingungen/Ausnahmen

Sperren (Locks)

Objekte in agorum core können gesperrt werden, um konkurrierende Änderungen zu verhindern. Es gibt verschiedene Sperrarten (Hard-Lock, Session-Lock, Shared-Lock), die über die folgenden Properties abgefragt werden können.

Enthaltene Methoden und Eigenschaften

locked

Aufgabe Datentyp
Nur lesend. Prüft, ob das Objekt aktuell gesperrt ist. boolean

Beispiel

let isLocked = object.locked;

Bedingungen/Ausnahmen

lockedBy

Aufgabe Datentyp
Nur lesend. Liefert den Benutzer zurück, der das Objekt gesperrt hat. DirectoryUserObject

Beispiel

let lockedBy = object.lockedBy;
if (lockedBy) {
  console.log('Gesperrt durch: ' + lockedBy.name);
}

Bedingungen/Ausnahmen

Leserechte notwendig.

lockedFor

Aufgabe Datentyp
Nur lesend. Liefert die SessionID zurück, für die das Objekt gesperrt ist. long

Bedeutung der Rückgabewerte (wenn lockState = 4):

Beispiel

let lockedFor = object.lockedFor;

Bedingungen/Ausnahmen

Leserechte notwendig.

lockState

Aufgabe Datentyp
Liefert bzw. setzt den aktuellen Sperrzustand des Objekts. int

Mögliche Werte:

Achtung: Das direkte Setzen von lockState = 8 ist nicht möglich. Verwenden Sie stattdessen die Funktion lockShared(identifier).

lockState setzen (Sperre entfernen)

object.lockState = 0;

lockState holen

let lockState = object.lockState;

lockState auf 8 setzen (Shared-Lock)

let obj = objects.find('<ID des Objekts>');
// The identifier defines which application / user group works together
obj.lockShared('onlyoffice');

Weitere Informationen zum programmatischen Setzen und Entfernen von Sperren finden Sie in der Dokumentation JavaScript-Bibliothek common/objects im Abschnitt lock (objects.lock.hard/session/shared/remove).

Bedingungen/Ausnahmen

Zum Setzen bzw. Verwenden der lock-Funktionen sind Schreibrechte erforderlich.

Lebenszyklus

Dieser Abschnitt umfasst Methoden rund um den Lebenszyklus eines Objekts: Löschen (endgültig oder in den Papierkorb), Zustand (im Papierkorb, temporär, unveränderlich) und das automatische Ablaufdatum.

Enthaltene Methoden und Eigenschaften

delete()

Aufgabe Datentyp
Löscht das Objekt endgültig aus dem System. –

Achtung: Datenverlust durch Aufruf dieser Funktion. Das Objekt kann nach dem Aufruf nicht mehr aus dem Serverpapierkorb wiederhergestellt werden.

Möchten Sie stattdessen das Objekt in den Serverpapierkorb legen, verwenden Sie den Aufruf trash.

Beispiel

object.delete();

Bedingungen/Ausnahmen

Schreibrechte notwendig.

deleted

Aufgabe Datentyp
Nur lesend. Liefert true, wenn das Objekt in keinem Ordner mehr verknüpft ist – es also „abgehängt“ ist. Das Objekt kann in diesem Zustand entweder im Serverpapierkorb liegen (siehe inTrash) oder „verschollen“ sein, wenn es ohne trash abgehängt wurde. boolean

Beispiel

if (object.deleted) {
  console.log('Objekt ist in keinem Ordner mehr verknüpft');
}

Bedingungen/Ausnahmen

inTrash

Aufgabe Datentyp
Nur lesend. Prüft, ob das Objekt sich im Serverpapierkorb befindet. boolean

Beispiel

if (object.inTrash) {
  console.log('Objekt liegt im Serverpapierkorb');
}

Bedingungen/Ausnahmen

expirationDate

Aufgabe Datentyp
Setzen und Holen des Ablaufdatums des Objekts. Zum angegebenen Datum wird das Objekt automatisch endgültig gelöscht. Date

Tipp: Wenn Sie zusätzlich ein Systemflag setzen möchten (z. B. zum Kennzeichnen archivierter Objekte), setzen Sie zuerst das expirationDate und danach die Systemflags.

expirationDate setzen

let date = new Date();
date.setFullYear(date.getFullYear() + 11);
object.expirationDate = date;

Zurücksetzen (Ablaufdatum entfernen):

object.expirationDate = null;

expirationDate holen

let expirationDate = object.expirationDate;

Bedingungen/Ausnahmen

immutable

Aufgabe Datentyp
Nur lesend. Liefert true, wenn das Objekt nicht geändert werden darf. boolean

Beispiel

if (object.immutable) {
  // The object must not be modified
}

Bedingungen/Ausnahmen

mutable

Aufgabe Datentyp
Nur lesend. Prüft, ob die Attribute des Objekts geändert werden dürfen. boolean

Beispiel

let mutable = object.mutable;

Bedingungen/Ausnahmen

temporary

Aufgabe Datentyp
Lesend. Prüft, ob es sich um ein temporäres Objekt handelt. boolean

Beide Zugriffsformen sind möglich – als Property (temporary) und als Funktion (isTemporary()).

Beispiel

let isTemporary = object.temporary;

Bedingungen/Ausnahmen

Leserechte notwendig.

Metadaten & Sonstiges

Zu jedem Objekt gehören zusätzliche Metadaten wie Datumsangaben, Benutzerreferenzen (Ersteller, Besitzer, letzter Änderer), Beschreibung, Flags sowie Textinhalte. Außerdem finden sich hier Utility-Properties wie belongingObject/mainObj (übergeordnetes Hauptobjekt) und sessionController (Benutzerkontext).

Enthaltene Methoden und Eigenschaften

createDate

Aufgabe Datentyp
Setzen und Holen des Erstellungsdatums des Objekts. Das Datum wird intern automatisch beim Anlegen des Objekts gesetzt und muss im Normalfall nicht manuell geändert werden. Date

createDate setzen

object.createDate = new Date();

createDate holen

let createDate = object.createDate;

Bedingungen/Ausnahmen

Zum Setzen sind Schreibrechte notwendig.

lastModifyDate

Aufgabe Datentyp
Setzen und Holen des Datums der letzten Änderung. Date

lastModifyDate setzen

object.lastModifyDate = new Date();

lastModifyDate holen

let lastModifyDate = object.lastModifyDate;

Bedingungen/Ausnahmen

Zum Setzen sind Schreibrechte notwendig.

updateDate

Aufgabe Datentyp
Setzen und Holen des updateDate des Objekts. Dieses Datum gibt an, wann das Objekt zuletzt aktualisiert wurde. Date

updateDate setzen

object.updateDate = new Date();

updateDate holen

let updateDate = object.updateDate;

Bedingungen/Ausnahmen

Zum Setzen Schreibrechte notwendig.

creator

Aufgabe Datentyp
Setzen und Holen des Erstellers des Objekts. Der Ersteller wird intern automatisch gesetzt, wenn das Objekt angelegt wird. Ein manuelles Setzen ist im Normalfall nur bei Datenimporten nötig. DirectoryUserObject

creator setzen

object.creator = objects.find('user:demo');

creator holen

let creator = object.creator;

Bedingungen/Ausnahmen

Zum Setzen sind Schreibrechte notwendig.

lastModifier

Aufgabe Datentyp
Setzen und Holen des zuletzt ändernden Benutzers. Wird beim Ändern eines Objekts automatisch gesetzt; ein manuelles Setzen ist im Normalfall nur bei Datenimporten nötig. DirectoryUserObject

lastModifier setzen

object.lastModifier = objects.find('user:demo');

lastModifier holen

let lastModifier = object.lastModifier;

Bedingungen/Ausnahmen

Zum Setzen sind Schreibrechte notwendig.

owner

Aufgabe Datentyp
Setzen und Holen des Besitzers des Objekts. Der Besitzer gibt an, welchem Benutzer das Objekt gehört. DirectoryUserObject

owner setzen

object.owner = objects.find('user:demo');

owner holen

let owner = object.owner;

Bedingungen/Ausnahmen

description

Aufgabe Datentyp
Setzen und Holen der Beschreibung des Objekts. string

description setzen

object.description = 'Das ist die Beschreibung des Objekts';

description holen

let description = object.description;

Bedingungen/Ausnahmen

flags

Aufgabe Datentyp
Setzen und Holen der benutzerdefinierten Flags des Objekts. long

flags setzen

object.flags = 2;

flags holen

let flags = object.flags;

Bedingungen/Ausnahmen

systemFlags

Aufgabe Datentyp
Setzen und Holen der Systemflags des Objekts. Systemflags sind eine bitweise kombinierbare Kennzeichnung zur Steuerung des Systemverhaltens. long

systemFlags setzen

object.systemFlags = 28;

systemFlags holen

let systemFlags = object.systemFlags;

Bedingungen/Ausnahmen

text

Aufgabe Datentyp
Nur lesend. Liefert den formatierten Text des Objekts zurück (z. B. mit Hervorhebungen aus dem Suchindex). string

Beispiel

let text = object.text;

Bedingungen/Ausnahmen

rawText

Aufgabe Datentyp
Nur lesend. Liefert den unformatierten Text des Objekts zurück (Ergebnis der Textextraktion, ohne Formatierungsinformationen). string

Beispiel

let rawText = object.rawText;

Bedingungen/Ausnahmen

Leserechte notwendig.

belongingObject

Aufgabe Datentyp
Liefert das übergeordnete Hauptobjekt zurück, zu dem das aktuelle Objekt gehört (z. B. das Hauptobjekt einer Historieninstanz, einer Arbeitskopie oder eines Mail-Bestandteils). Ist das Objekt selbst schon ein Hauptobjekt, gibt belongingObject das Objekt selbst zurück. Object

Beispiel

let belongingObject = object.belongingObject;

Bedingungen/Ausnahmen

mainObj

Aufgabe Datentyp
Nur lesend. Liefert das übergeordnete Hauptobjekt zurück. Ist das Objekt selbst schon ein Hauptobjekt, wird das Objekt selbst zurückgegeben. Object

Beispiel

let main = object.mainObj;

Bedingungen/Ausnahmen

sessionController

Aufgabe Datentyp
Nur lesend. Liefert den SessionController, mit dem das Objekt geladen wurde. Über den SessionController kann bei Bedarf mit einem anderen Benutzerkontext weitergearbeitet werden. SessionController

Beispiel

let sc = object.sessionController;

Bedingungen/Ausnahmen