Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht
Navigation: Dokumentationen agorum core > agorum core JavaScript-API
Diese Dokumentation beschreibt die Methoden getter und setter eines GlobalObjects.
Bei den Beispielen wird davon ausgegangen, dass Sie ein Objekt haben. Dieses können Sie etwa folgendermaßen holen:
let objects = require('common/objects'); let object = objects.find('<Object.id>');
Die hier beschriebenen Methoden gelten nur für Objekte vom Typ Ordner (FOLDEROBJECT).
Ob ein Objekt ein Ordner ist oder nicht, prüfen Sie über die Methode isFolder.
Liefert ein Array aller Objekte in diesem Ordner zurück.
Syntax
object.items().map(item => item.name);
base.items().map(item => item.name);
Enthält die Anzahl der Unterelemente dieses Ordners.
Syntax
object.itemsCount;
Liefert alle Elemente außer Ordner zurück.
Syntax
object.itemsNoFolder;
Liefert alle Unterordner zurück.
Syntax
object.itemsOnlyFolder;
Erstellt einen neuen Ordner.
Beispiel
let base = objects.find('/Home/roi/MyFiles'); // Prüfen, ob das Objekt auch ein Ordner ist if (base.isFolder) { base.createPath('Mein neuer Ordner/Mein neuer Unterordner'); }
Rückgabewert
Sie erhalten den untersten Ordner der neu erstellten Struktur zurück.
Aufgabe | Datentype |
---|---|
Setzen und holen des ACL des Objekts. | AccessControlList |
Hier wird die ACL public gesetzt.
object.acl = objects.find('acl:public');
let acl = object.acl;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen des ACL des Objekts. |
object.aclByName('public');
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Hinzufügen eines Anhangs an das Objekt. | – |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); let obj3 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test2.js'); object.addAttachment(obj3);
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Function addToPathDateQueue() des Objektes |
let xxx = object.addToPathDateQueue()
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Holen aller allAclIDs und Scope-ACLs des Objektes. | long[] |
let allAclIDs = object.allAclIDs;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen aller Anhänge des Objektes. | GlobalObject [] |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); let obj1 = objects.find('/agorum/roi/customers/test-auto-plugin/js/read-meta.json.js'); let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js'); let obj3 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test2.js'); let attachments = [obj1, obj2]; object.setAttachments(attachments); object.addAttachment(obj3); let allAttachments = object.allAttachments;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen aller Pfade des Objekts. | string[] allFolderPath |
let objects = require('common/objects'); let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js'); obj2.allFolderPath;
Aufgabe | Datentype |
---|---|
Holen des anyFolderPath des Objekts. | string |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); let anyFolderPath = object.anyFolderPath;
Der areaName wird noch im Modul desk4web verwendet. Im neuen agorum core hat er keine Bedeutung mehr und sollte auch nicht verwendet werden.
Aufgabe | Datentype |
---|---|
Setzen und holen des areaName des Objekts. | string |
object.areaName = 'Das ist der AreaName';
let areaName = object.areaName;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Holen des associatedUser des Objekts (zugehöriger Benutzer eines Objekts). | DirectoryUserObject |
let associatedUser = object.associatedUser;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen aller Objekte, an denen das Objekt angehängt ist. | GlobalObject [] |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); let obj1 = objects.find('/agorum/roi/customers/test-auto-plugin/js/read-meta.json.js'); let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js'); let obj3 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test2.js'); let ret = []; let attachments = [obj1, obj2]; object.setAttachments(attachments); object.addAttachment(obj3); obj3.attachedTo();
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Holen aller Anhänge des Objekts. | GlobalObject [] |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); let obj1 = objects.find('/agorum/roi/customers/test-auto-plugin/js/read-meta.json.js'); let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js'); let obj3 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test2.js'); let attachments = [obj1, obj2]; object.setAttachments(attachments); object.addAttachment(obj3); attachments = object.attachments();
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Nur Lesend. Gibt den Namen des Objektes ohne Extension zurück. | string |
let baseName = object.baseName;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen des behaviorName des Objekts. | string |
object.behaviorName = 'bh01';
let behaviorName = object.behaviorName;
Aufgabe | Datentype |
---|---|
Holen des belongingObject des Objekts. | GlobalObject |
let belongingObject = object.belongingObject;
Lesrechte notwendig
Aufgabe | Datentype |
---|---|
Bricht das Auschecken eines Objekts ab. | – |
object.cancelCheckOut()
Aufgabe | Datentype |
---|---|
Holen des checkinComment des Objekts. | string |
Der checkinComment ist der Kommentar, der beim Einchecken eines Objekts eingegeben wird. Hier schreibt der Änderer einen kurzen Kommentar, was er an dem Dokument geändert hat.
let checkinComment = object.checkinComment;
Lesrechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt ausgecheckt ist. true Objekt ist ausgecheckt. false Objekt ist nicht ausgecheckt. |
boolean |
let checkedOut = object.checkedOut
if (object.checkedOut) { // ist ausgechecked .. } else { // ist nicht ausgechecked .. }
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt von Ihnen ausgecheckt ist. true Objekt ist von Ihnen ausgecheckt. false Objekt ist nicht von Ihnen ausgecheckt. |
boolean |
let checkedOutByMe = object.checkedOutByMe
if (object.checkedOutByMe) { // ist von Ihnen ausgechecked .. } else { // ist nicht von Ihnen ausgechecked .. }
Aufgabe | Datentype |
---|---|
Checkt die Arbeitskopie eines ausgecheckten Dokuments ein (checkOut). | GlobalObject |
Der Aufruf wird auf dem Original-Objekt ausgeführt. Der Rückgabewert entspricht dem Originalobject, das zuvor ausgecheckt wurde.
Parameter | Datentype | Beschreibung |
---|---|---|
comment | string | Der Kommentar, den der Bearbeiter beim CheckIn eingibt (checkinComment) |
versionNumber | null | Übergeben Sie bei der Versionsnummer null, wird diese über die Standardberechnung berechnet. Wenn nicht vorhanden, fängt die Nummer bei 1.0 an. Wenn isMayjorVersion === true, wird die Zahl vor dem Komma hochgezählt. Beispiel 1.0 - 2.0 - 3.0 Wenn isMayjorVersion === false, wird die Zahl nach dem Komma hochgezählt. Beispiel 1.0 - 1.1 - 1.2 |
versionNumber | string | Wenn Sie die Versionsnummer als String übergeben, wird genau der Inhalt des Strings in die Versionsnummer gesetzt. Jetzt sind Sie für die Berechnung der Versionsnummer selbst verantwortlich. |
isMayiorVersion | boolean | true Hauptversion false keine Hauptversion |
Beispiel
Version automatisch berechnet mit dem Standardverhalten:
let objects = require('common/objects'); let text = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.txt'); // checkOut let co = text.checkOut(null); // Jetzt wird was geändert co.contentString += '\nNoch eine Zeile'; let obj = text.checkIn('Kommentar ' + new Date(), null, false);
Beispiel
Version mit eigener Versionsnummer:
let objects = require('common/objects'); let text = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.txt'); // checkOut let co = text.checkOut(null); // Jetzt wird was geändert co.contentString += '\nNoch eine Zeile - xx'; let obj = text.checkIn('Kommentar ' + new Date(), 'V17.89.55-987', false);
Beispiel
checkIn() auf dem ausgecheckten Objekt aufrufen:
let objects = require('common/objects'); let text = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.txt'); // checkOut let co = text.checkOut(null); // Jetzt wird was geändert co.contentString += '\nNoch eine Zeile - yy'; // Jetzt wird checkIn auf der Arbeitskopie aufgerufen. let obj = co.checkIn('Kommentar ' + new Date(), 'V17.89.55-987', false);
Schreibrechte oder CheckIn-Rechte notwendig.
Aufgabe | Datentype |
---|---|
Checkt eine Datei aus. | GlobalObject |
Beim Auschecken erstellt das System im Verzeichnis Home/{user_id}/myFiles/In Bearbeitung eine Arbeitskopie Ihrer Datei und sperrt das Original, damit das Original von anderen Benutzern nicht verändert werden kann. Der Rückgabewert ist Ihre Arbeitskopie, in der Sie anschließend Ihre Änderungen vornehmen können.
Beispiel
Eine Datei hat drei Versionen:
Sie können verschiedene Szenarien abbilden, je nachdem, welche Dateiversion Sie auschecken möchten:
/* global sc */ let objects = require('common/objects'); let metadata = require('common/metadata'); // Datei (ID) holen, die ausgecheckt werden soll let versions = { current: objects.find(1185750), // aktuelle Version 2.0 der Datei version1: objects.find(1414507) // alte Version 1.0 der Datei }; // Checkout durchführen if (versions.current.historyObject) { // Checkt die aktuelle Version 2.0 aus return versions.version1.belongingObject.checkOut(null); } // Checkt die alte Version 1.0 aus return versions.version1.belongingObject.checkOut(versions.version1); } // Checkt die aktuelle Version 2.0 aus return versions.current.checkOut(null); // Checkt die alte Version 1.0 aus return versions.current.checkOut(versions.version1);
Schreibrechte oder Checkout-Rechte notwendig, um den Checkout durchführen zu können.
Aufgabe | Datentype |
---|---|
Holen des convertablePDF des Objekts. | boolean |
let convertablePDF = object.convertablePDF;
Lesrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen des createDate des Objekts. | date |
Dieses Datum gibt an, wann das Objekt angelegt wurde. Im Normalfall wird dieses Datum intern gesetzt, wenn das Objekt angelegt wird.
object.createDate = new Date();
let createDate = object.createDate;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen des creator des Objekts. | DirectoryUserObject |
Der creator gibt an, welcher Benutzer das Objekt angelegt hat. Im Normalfall wird der creator intern gesetzt, wenn das Objekt angelegt wird.
object.creator = objects.find('user:rolf.lang');
let creator = object.creator;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen des creator des Objekts anhand des Benutzernamens. | – |
object.creatorByName('rolf.lang');
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Löscht das Objekt endgültig. | – |
Achtung: Datenverlust durch Aufruf der Funktion. Das Objekt kann nicht mehr aus dem Serverpapierkorb wiederhergestellt werden. Löschen Sie das Objekt mit diesem Aufruf nur, wenn Sie es wirklich nicht mehr benötigen.
Möchten Sie, dass das Objekt nach dem Löschen im Serverpapierkorb verbleibt, verwenden Sie den Aufruf trash.
object.delete()
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Löscht alle Scope-ACL eines Objektes. | – |
object.deleteAllScopeAcls()
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Löscht einen Scope-ACL eines Objekts. | – |
object.deleteScopeAcl(acl)
Administrative Rechte notwendig.
Aufgabe | Datentype |
---|---|
Holen des Flags deleted des Objekts. | boolean |
let deleted = object.deleted;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Function deleteDeferred des Objekts. | – |
let xxx = object.deleteDeferred
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Löscht den DokumentText eines Objekts. | – |
let xxx = object.deleteDocumentText()
Aufgabe | Datentype |
---|---|
Setzen und holen des deletor des Objekts. | DirectoryUserObject |
object.deletor(DirectoryUserObject?) =
let deletor(DirectoryUserObject?) = object.deletor(DirectoryUserObject?);
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen der Objekt-Beschreibung. | string |
object.description = 'Das ist die Beschreibung des Objekts';
let description = object.description;
Aufgabe | Datentype |
---|---|
Holen der displayableObject eines Objekts. | GlobalObject |
let displayableObject = object.displayableObject;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des Displayname des Objekts. | string |
let displayName = object.displayName
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des DokumentText-Objektes des Objekts. | DocumentTextObject |
let pdf = objects.find('/agorum/roi/customers/test-auto-plugin/test/Willkommen.pdf'); let dto = pdf.documentText; throw 'Das ist der Text, der in den Volltext-Index kommt:\n\n' + dto.contentString;
Ab welcher Version nutzbar?
• agorum core 9.5.1
Aufgabe | Datentype |
---|---|
Erzwingt das Erzeugen einer Historie bei der nächsten Aktion mit diesem Objekt. | – |
Wird bei einer Änderung kein ensureHistory verwendet, kann es sein, dass die letzte Änderung innerhalb der letzten Minute war und somit nicht erneut eine Historie erzeugt wird.
obj.ensureHistory().name = 'neuer-name.pdf';
Der Inhalt eines Quellobjekts (srcObj) kann hierdurch auf ein Zielobjekt (dstObject) geschrieben werden. Verwenden Sie diese Art von content stream bevorzugt, da das System im Hintergrund direkt Optimierungen vornimmt, Stichwort dedup. Vor Setzen des Contents wird eine Historie erzeugt.
srcObj.streamContent(dstObj.ensureHistory());
metadata({ xx: 'yy' }).save(obj.ensureHistory());
Aufgabe | Datentype |
---|---|
|
date |
let date = new Date(); date.setFullYear(date.getFullYear() + 11); object.expirationDate = date;
Zurücksetzen, wenn es gesetzt ist und wieder weggenommen werden soll:
object.expirationDate = new Date(0);
let expirationDate = object.expirationDate;
Aufgabe | Datentype |
---|---|
(nur lesend) Gibt das erste übergeordnete Objekt des Objektes zurück. | GlobalObject |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); let nameFirstParent = object.firstParent.name;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen der Flags des Objekts. | long |
object.flags = 2;
let flags = object.flags = 2 ;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Holen aller Pfade, unter denen das Objekt verknüpft ist. | string[] |
Optional können Sie der Funktion eine Folder-ID übergeben, damit das System die Pfade relativ zu diesem Ordner ausgibt.
let objects = require('common/objects'); let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js'); obj2.getAllFolderPath();
let objects = require('common/objects'); let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js'); // relativ zu dem übergebenen Ordner holen obj2.getAllFolderPath(objects.find('/agorum/roi/customers').getId());
Aufgabe | Datentype |
---|---|
Holen der eindeutigen Objekt-ID des Objekts. | long |
let id = object.getId();
Aufgabe | Datentype |
---|---|
Holen des Parent des Objekts mit einem bestimmten Namen. | GlobalObject |
Der Parent ist ein Ordner, an dem das Objekt mit einem FolderPathRelation verknüpft ist.
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); let parentJs = object.getParent('js');
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt Anhänge besitzt. true Objekt hat Anhänge. false Objekt hat keine Anhänge. |
boolean |
if(object.hasAttachments()) { ?? ... }
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt eigene Anhänge besitzt. true Objekt hat eigene Anhänge. false Objekt hat keine eigenen Anhänge. |
boolean |
object.hasOwnAttachments()
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt Parents hat. true Objekt hat Parents. false Objekt hat keine Parents. |
boolean |
let hasParents = object.hasParents();
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des HistoryCounters des Objekts. | int |
Der HistoryCount gibt an, wie viele Historien das Objekt besetzt.
let historyCount = object.historyCount;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob es sich bei diesem Objekt um ein History-Objekt handelt. true Es handlet sich um ein History-Objekt. false Es handlet sich nicht um ein History-Objekt. |
boolean |
let historyObject = object.historyObject;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen der ID des Objekts. | string |
let ID = object.ID;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des immutable des Objekts. | boolean |
let immutable = object.immutable;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des indexAble des Objekts. | boolean |
let indexAble = object.indexAble;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt im Serverpapierkorb liegt. true Objekt liegt im Serverpapierkorb. false Objekt liegt nicht im Serverpapierkorb. |
boolean |
let inTrash = object.inTrash;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt an einem anderen Objekt angehängt ist. true Objekt ist an einem anderen Objekt angehängt. false Objekt ist nicht an einem anderen Objekt angehängt. |
boolean |
if(object.isAttached()) { ... }
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt ein Ordner ist. true Objekt ist ein Ordner. false Objekt ist kein Ordner. |
boolean |
if(object.isFolder) { ... }
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt gesperrt ist. true Objekt ist gesperrt. false Objekt ist nicht gesperrt. |
boolean |
let isLocked = object.isLocked();
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true false |
boolean |
if(object.isOrdinaryFolder()) { ... }
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt nur ein temporäres Objekt ist. true Objekt ist ein temporäres Objekt. false Objekt ist kein temporäres Objekt. |
boolean |
let isTemporary = object.isTemporary();
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen des lastModifier des Objekts. | DirectoryUserObject |
Der lastModifier gibt an, welcher Benutzer das Objekt zuletzt geändert hat. Im Normalfall wird der lastModifier intern gesetzt, wenn das Objekt geändert wird.
object.lastModifier = objects.find('user:rolf.lang');
let lastModifier = object.lastModifier;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen des lastModifier des Objektes anhand des Benutzernamens. | – |
object.lastModifierByName('rolf.lang');
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen des lastModifyDate des Objekts. | date |
Das lastModifyDate gibt an, wann das Objekt zuletzt geändert wurde. Im Normalfall wird dieses Datum intern gesetzt, wenn sich das Objekt geändert hat.
object.lastModifyDate = new Date();
let lastModifyDate = object.lastModifyDate;
Aufgabe | Datentype |
---|---|
|
RelationObject [] |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); object.leftwardRelations;
Aufgabe | Datentype |
---|---|
|
GlobalObject [] |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); object.leftwardRelationObjects;
Aufgabe | Datentype |
---|---|
Prüft, ob ein Objekt verlinkt ist. Dies bedeutet, dass ein Objekt mehr wie einen Parent hat. true Objekt ist verlinkt. false Objekt ist nicht verlinkt. |
boolean |
let linked = object.linked;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Objekt besitzt unsichtbare Links. false Objekt besitzt keine unsichtbaren Links. |
boolean |
let linkedNotVisible = object.linkedNotVisible;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Sperrt ein Objekt für den aktuellen Benutzer. | – |
object.lock();
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Holen der Benutzer, für die dieses Objekt gesperrt ist. |
let lockedBy = obj2.lockedBy;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen der SessionId, für die dieses Objekt gesperrt ist. > 0 Definiert die SessionId, für die dieses Objekt gesperrt ist. -1 Wurde für keine Session gesperrt. Dies bedeutet, die Sperre bleibt auch über ein Log-out und über einen neuen Systemstart bestehen. |
long |
let lockedFor = object.lockedFor;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob auf dem Objekt ein Sessionlock ist. true Objekt besitzt einen Sessionlock. false Objekt besitzt keinen Sessionlock. |
boolean |
let lockedForSession = object.lockedForSession;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen des Lockstate. 0 Nicht gelockt 1 Hardlock 4 SessionLock |
int |
object.lockState = 0
let lockState = object.lockState;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Holen des MainObjects des Objekts. | GlobalObject |
Das MainObject verweist auf das Hauptobjekt. Dies bedeutet, das Objekt, das auf ein anderes Objekt verweist, ist nur ein Teil des gesamten Objekts. Wenn ein Objekt keinen Verweis auf ein Hauptobjekt hat, ist im MainObject immer das Objekt selbst eingetragen.
let mainObj = object.mainObj;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des mayBeDeleted des Objekts. | boolean |
let mayBeDeleted = object.mayBeDeleted();
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Objekt darf ausgecheckt werden. false Objekt darf nicht ausgecheckt werden. |
boolean |
let mayCheckOut = object.mayCheckOut;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Objekt darf gelöscht werden. false Objekt darf nicht gelöscht werden. |
boolean |
let mayDelete = object.mayDelete;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Objekt darf in den Ordner abgelegt werden. false Objekt darf nicht in den Ordner abgelegt werden. |
boolean |
let mayInsert = object.mayInsert;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Attribute des Objekts dürfen geändert werden. false Attribute des Objekts dürfen nicht geändert werden. |
boolean |
let mayModify = object.mayModify;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Objekt darf verschoben werden. false Objekt darf nicht verschoben werden. |
boolean |
let mayObjectBeMoved = object.mayObjectBeMoved;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Objekt darf abgehängt werden. false Objekt darf nicht abgehängt werden. |
boolean |
let mayRemove = object.mayRemove;
Prüft zusätzlich, ob das Objekt noch über den Ordner geschützt ist. Diese Methode ist der Methode mayRemove vorzuziehen.
Aufgabe | Datentype |
---|---|
true Objekt darf abgehängt werden. false Objekt darf nicht abgehängt werden. |
boolean |
let mayRemove = object.mayRemove(parent);
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Objekt besitzt ein Mailattachment. false Objekt besitzt kein Mailattachment. |
boolean |
let mailAttachment = object.mailAttachment;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Objekt besitzt einen Mailbody. false Objekt besitzt keinen Mailbody . |
boolean |
let mailBody = object.mailBody;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Objekt besitzt einen Mailmsg. false Objekt besitzt keinen Mailmsg. |
boolean |
let mailMsg = object.mailMsg;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Attribute des Objekts dürfen geändert werden. false Attribute des Objekts dürfen nicht geändert werden. |
boolean |
let mutable = object.mutable;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Setzen oder holen des Namens des Objekts. | string |
object.name = 'Neuer name.txt';
let name = object.name;
Aufgabe | Datentype |
---|---|
Holen des nameExtension des Objekts. | string |
let nameExtension = object.nameExtension;
Aufgabe | Datentype |
---|---|
Holen aller Notizen des Objekts. | NoteObject[] |
let notes = object.notes;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des notesRelation des Objekts. | RelationObject[] |
let notesRelation = object.notesRelation;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
|
string |
object.objectTextKey = 'agorum.textkey.file.private';
let objectTextKey = object.objectTextKey;
Aufgabe | Datentype |
---|---|
Setzen und holen des Owners des Objekts. | DirectoryUserObject |
object.owner = objects.find('user:rolf.lang');
let owner = object.owner;
Aufgabe | Datentype |
---|---|
Setzen des Owners des Objekts anhand des Namens. | – |
object.ownerByName('rolf.lang');
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
• Holen der parents des Objekts. • Gibt alle Ordner zurück, in denen das Objekt verknüpft ist. |
GlobalObject [] |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); let parents = object.parents(); let ret = []; parents.forEach(function(parent){ ret.push(parent.name); }); ret;
Aufgabe | Datentype |
---|---|
Holen des previewable des Objekts. | boolean |
let previewable = object.previewable;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob das Objekt eine PWC (privat working copy) ist. true Objekt ist eine PWC. false Objekt ist keine PWC. |
boolean |
let privateWorkingCopy = object.privateWorkingCopy;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des pWCFolder des Objekts. | FolderObject |
let pWCFolder = object.pWCFolder;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des read des Objekts. | boolean |
let read = object.read;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Reindiziert das Objekt / legt das Objekt nochmals in den Index. | – |
object.reIndex()
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Holen des related des Objekts. | boolean |
let related = object.related;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Löscht Anhänge eines Objekts. | – |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); let obj1 = objects.find('/agorum/roi/customers/test-auto-plugin/js/read-meta.json.js'); let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js'); let obj3 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test2.js'); let removeAttachments = [obj1, obj2, obj3]; object.removeAttachments(removeAttachments);
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Function restoreObject(FolderObject target) des Objekts. |
let xxx = object.restoreObject(FolderObject target)
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
|
RelationObject [] |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); object.rightwardRelations;
Aufgabe | Datentype |
---|---|
|
GlobalObject [] |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); object.rightwardRelationObjects;
Aufgabe | Datentype |
---|---|
Holen des rawText des Objekts. | string |
let rawText = object.rawText;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Setzen des scopeAcl des Objekts (ACL oder ACL[]) | ACL[] |
object.scopeAcl = acl;
Beispiel 1
let acl = objects.find('acl:NameDesAcls'); irgendEinObject.scopeAcl = acl;
Beispiel 2
let acls = [ objects.find('acl:NameDesAcls1'), objects.find('acl:NameDesAcls2') ]; irgendEinObject.scopeAcl = acls;
Aufgabe | Datentype |
---|---|
Holen des scopeAclNames des Objekts. | string[] |
let scopeAclNames = object.scopeAclNames;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des scopeAcls des Objekts. | ACL[] |
let scopeAcls = object.scopeAcls;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des sessionController des Objekts. | sessionController |
let sessionController = object.sessionController;
Aufgabe | Datentype |
---|---|
Setzen des sessionLockWithTimer(long) des Objekts. | – |
object.sessionLockWithTimer(long) =
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen von Anhängen an das Objekt. | – |
let objects = require('common/objects'); let object = objects.find('/agorum/roi/customers/test-auto-plugin/js/test-go-api.js'); let obj1 = objects.find('/agorum/roi/customers/test-auto-plugin/js/read-meta.json.js'); let obj2 = objects.find('/agorum/roi/customers/test-auto-plugin/js/test.js'); let attachments = [obj1, obj2]; object.setAttachments(attachments);
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen des expirationDate des Objekts, ohne dass die Updatedates gesetzt werden. | – |
let dae = new Date(); date.setFullYear(date.getFullYear() + 11); object.setExpirationDateSilent(date);
Aufgabe | Datentype |
---|---|
Setzen des setNote(NoteObject) des Objekts. | – |
object.setNote(NoteObject) =
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Holen des specificParents des Objekts. | GlobalObject[] |
let subObjects = object.specificParents('');
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des subObjects des Objekts. | GlobalObject[] |
let subObjects = object.subObjects;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des supportsPreview des Objekts. | boolean |
let supportsPreview = object.supportsPreview;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des systemFlags des Objekts. | long |
object.systemFlags = 28; let systemFlag = object.systemFlag;
Ergebnis
[4, 8, 16]
Aufgabe | Datentype |
---|---|
Setzen und holen der systemFlags des Objekts. | long |
object.systemFlags = 28
let systemFlags = object.systemFlags;
Aufgabe | Datentype |
---|---|
Holen des text des Objekts. | string |
let text = object.text;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Prüft, ob Text am Objekt verfügbar ist. true Text ist verfügbar. false Text ist nicht verfügbar. |
boolean |
let textAvailable = object.textAvailable;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen der timePhasedAction des Objekts. | string |
object.timePhasedAction = 'StartDocFormRobot';
let timePhasedAction = object.timePhasedAction;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und Holen des timePhasedActionDate des Objekts. | date |
object.timePhasedActionDate = new Date();
let timePhasedActionDate = object.timePhasedActionDate;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Funktion unlock() des Objekts | – |
let xxx = object.unlock()
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen der UUID des Objekts. | string |
Die UUID wird normalerweise automatisch vergeben. Sie können sie auch gezielt auf eine vorgegebene UUID setzen.
object.UUID = '0e3a3c00-d104-11e5-a821-080027cddacf';
let UUID = object.UUID;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Setzen und holen des updateDate des Objekts. Dieses Datum gibt an, wann das Objekt zuletzt geändert wurde. | date |
object.updateDate = new Date();
let updateDate = object.updateDate;
Schreibrechte notwendig
Aufgabe | Datentype |
---|---|
Holen der versionNumber des Objekts. | string |
let versionNumber = object.versionNumber;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen der workingCopy des Objekts. | GlobalObject |
let workingCopy = object.workingCopy;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
true Sie besitzen Schreibrechte. false Sie besitzen keine Schreibrechte. |
boolean |
let writable = object.writable;
Leserechte notwendig
Aufgabe | Datentype |
---|---|
Holen des xml des Objekts. | string |
let xml = object.xml;
Leserechte notwendig