Zum Hauptinhalt springen

Benutzerdefinierte Aktionen

Dieses Skript enthält Callbacks für den Mappentyp eFile .

tipp

Zum Aktivieren der Callbacks muss das Skript ou.tmpl.eFiles.callbacks.actions in ou.cust.eFiles.callbacks.actions umbenannt werden.

Verwendung​

Für was kann ich diese Callbacks verwenden?​

Screenshot

  • Standard-Benutzerdefinierte Aktionen beeinflussen

Welche Callbacks sind definiert?​

  • beforeAddKeyWord: Bevor die Aktion Neuer Tag ausgeführt wird
  • afterAddKeyWord: Nachdem die Aktion Neuer Tag ausgeführt wurde
  • beforeComplete: Bevor die Aktion Abschließen ausgeführt wird
  • afterComplete: Nachdem die Aktion Abschließen ausgeführt wurde
  • beforeIndex: Bevor die Mappe indexiert wird
  • afterIndex: Nachdem die Mappe indexiert wurde
  • beforeDelete: Bevor die Aktion Löschen ausgeführt wird
  • afterDelete: Nachdem die Aktion Löschen ausgeführt wurde

Callbacks​

beforeAddKeyWord​

Dieser Callback wird getriggert, bevor die Aktion Neuer Tag ausgeführt wird.

beforeAddKeyWord(tagName: string): boolean | void;
tipp

Gibt man false zurück, so wird die Standard-Logik umgegangen und nicht ausgeführt.

beforeAddKeyWord: function(tagName) {
    /**
     * @type {eFile}
     */
    var docFile = context.file;

    // Eigene Logik hier
    // Mit return false; kann die vorhandene Logik übersprungen werden.
    return false;
}

Oder Fehlermeldung ausgeben:

beforeAddKeyWord: function(tagName) {
    /**
     * @type {eFile}
     */
    var docFile = context.file;

    throw new Error("Nope du nicht!");
}

afterAddKeyWord​

Dieser Callback wird getriggert, nachdem die Aktion Neuer Tag ausgeführt wurde. In dem data Parameter wird die neu erzeugte Mappe übergeben.

afterAddKeyWord(data: { keyWordFile: eFileKeyword }): void;
afterAddKeyWord: function(data) {
    data.keyWordFile.eComment = "Der User wars";
    data.keyWordFile.sync();
}

beforeComplete​

Dieser Callback wird getriggert, bevor die Aktion Abschließen ausgeführt wird.

beforeComplete(file: eFile): boolean | void;
tipp

Gibt man false zurück, so wird die Standard-Logik umgegangen und nicht ausgeführt.

beforeComplete: function(file) {
    // Eigene Logik hier
    // Mit return false; kann die vorhandene Logik übersprungen werden.
    return false;
}

Oder Fehlermeldung ausgeben:

beforeComplete: function(file) {
    throw new Error("Nope du nicht!");
}

afterComplete​

Dieser Callback wird getriggert, bevor die Aktion Abschließen ausgeführt wird.

afterComplete(file: eFile): void;
warnung

Achtung! Die Mappe ist hier bereits versiegelt!

afterComplete: function(file) {

}

beforeIndex​

Dieser Callback wird getriggert, bevor die Aktion Indexieren ausgeführt wird.

beforeIndex(file: eFile): boolean | void;
tipp

Gibt man false zurück, so wird die Standard-Logik umgegangen und nicht ausgeführt.

beforeIndex: function(file) {

    // Eigene Logik hier
    // Mit return false; kann die vorhandene Logik übersprungen werden.
    return false;

}

afterIndex​

Dieser Callback wird getriggert, nachdem die Aktion Indexieren ausgeführt wurde.

afterIndex(file: eFile): void;
tipp

Gibt man false zurück, so wird die Standard-Logik umgegangen und nicht ausgeführt.

afterIndex: function(file) {

}

beforeDelete​

Dieser Callback wird getriggert, bevor die Aktion Löschen ausgeführt wird.

beforeDelete(file: eFile): boolean | void;
tipp

Gibt man false zurück, so wird die Standard-Logik umgegangen und nicht ausgeführt.

beforeDelete: function(file) {
    // Eigene Logik hier
    // Mit return false; kann die vorhandene Logik übersprungen werden.
    return false;
}

Oder Fehlermeldung ausgeben:

beforeDelete: function(file) {
    throw new Error("Nope du nicht!");
}

afterDelete​

Dieser Callback wird getriggert, bevor die Aktion Löschen ausgeführt wird.

afterDelete(file: eFile): void;
tipp

Gibt man false zurück, so wird die Standard-Logik umgegangen und nicht ausgeführt.

afterDelete: function(file) {
    // ?
}