$object.changeLog([maxEntries[, includeSubtree[, startRev[, stopRev[, author[, includeTechnical[, excludedModules]]]]]]])changeLog()
Liefert die Liste der Änderungen (tl.changelog:ChangeSet), die das angegebene Fachobjekt betreffen.
Ist includeSubtree gesetzt (Standard), werden auch Änderungen an Objekten berücksichtigt, die sich zum Zeitpunkt der Änderung im Kompositions-Unterbaum des Objektes befanden. Wird der Parameter auf false gesetzt, werden ausschließlich Änderungen am Objekt selbst zurückgeliefert.
Wird kein object übergeben oder null, so wird die globale Änderungshistorie der Anwendung zurückgeliefert (ohne Unterbaum-Einschränkung). In diesem Fall empfiehlt sich die Nutzung von maxEntries, um die Ergebnismenge zu begrenzen.
Die optionalen Parameter startRev und stopRev grenzen den analysierten Revisionsbereich ein. Beide können entweder als Revisions-Objekt oder als Commit-Nummer (Ganzzahl) übergeben werden. Standardmäßig wird die gesamte Historie (ab Revision 1 bis zur aktuellen Revision) analysiert.
Der optionale Parameter author beschränkt das Ergebnis auf Änderungen, die durch den angegebenen Account vorgenommen wurden. Es kann entweder eine tl.accounts:Person oder ein beliebiges Fachobjekt mit einer account-Referenz auf einen Account übergeben werden.
Der optionale Schalter includeTechnical steuert, ob auch Änderungen ausgegeben werden, die ausschließlich technischer Natur sind (also keine Auswirkungen auf das Modell haben).
Der optionale Parameter excludedModules ist eine Sammlung von Modulen, deren Änderungen nicht berücksichtigt werden sollen. Jedes Element kann entweder eine TLModule-Referenz oder ein Modulname als Zeichenkette sein.
| Name | Typ | Beschreibung | Pflicht | Default |
|---|---|---|---|---|
| object | Fachobjekt | Das Fachobjekt, für das die Änderungen ermittelt werden sollen. null oder weglassen liefert die globale Änderungshistorie der Anwendung. |
nein | null |
| maxEntries | Ganzzahl | Begrenzt die Anzahl der zurückgelieferten Änderungen, neueste zuerst. Ein Wert kleiner oder gleich 0 bedeutet keine Begrenzung. | nein | 0 |
| includeSubtree | Wahrheitswert | Legt fest, ob der komplette Kompositions-Unterbaum berücksichtigt wird (true) oder ausschließlich das Objekt selbst (false). |
nein | true |
| startRev | Revision oder Ganzzahl | Erste zu analysierende Revision. Entweder als Revisions-Objekt oder als Commit-Nummer. | nein | 1 (Initial-Revision) |
| stopRev | Revision oder Ganzzahl | Letzte zu analysierende Revision. Entweder als Revisions-Objekt oder als Commit-Nummer. | nein | aktuelle Revision |
| author | tl.accounts:Person oder Fachobjekt mit account-Referenz |
Schränkt das Ergebnis auf Änderungen ein, die durch den angegebenen Account vorgenommen wurden. | nein | null (kein Filter) |
| includeTechnical | Wahrheitswert | Legt fest, ob auch Änderungen ausgegeben werden, die ausschließlich technischer Natur sind (also keine Auswirkungen auf das Modell haben). | nein | false |
| excludedModules | Sammlung von TLModule oder Zeichenketten |
Module, deren Änderungen nicht berücksichtigt werden sollen. Jedes Element kann entweder eine TLModule-Referenz oder ein Modulname als Zeichenkette sein. |
nein | leer |
Typ: Liste von tl.changelog:ChangeSet
Die Liste der Änderungen in aufsteigender Revisions-Reihenfolge.
$project.changeLog()
Liefert alle Änderungen am Projekt und an allen darin enthaltenen Unterobjekten.
$project.changeLog(10, false)
Liefert die zehn neuesten Änderungen, die direkt am Projekt-Objekt vorgenommen wurden (ohne Unterobjekte).
changeLog(null, 50)
Liefert die 50 neuesten Änderungen der gesamten Anwendung, ohne Unterbaum-Einschränkung.
changeLog(author: $account, includeTechnical: true)
Liefert alle Änderungen (inklusive rein technischer), die durch den angegebenen Account durchgeführt wurden.
$project.changeLog(0, true, 1000, 2000)
Liefert alle Änderungen am Projekt (inklusive Unterbaum), die zwischen den Revisionen 1000 und 2000 erfolgten.
changeLog(excludedModules: [`tl.accounts`, "tl.legacy"])
Liefert die globale Änderungshistorie ohne die Änderungen aus den Modulen tl.accounts und tl.legacy.