JavaScript-Bibliothek agorum.home/js/home

Mithilfe dieser JavaScript-Bibliothek können Sie auf Funktionen von agorum.home zugreifen.

Verwendung

Diese Bibliothek binden Sie stets am Anfang eines Skripts ein:

let home = require('/agorum/roi/customers/agorum.home/js/home');

Funktionen

open

Öffnet einen Ordner in der agorum.home-Hauptansicht.

Wird diese Funktion in einer Registerkarte ohne agorum.home-Ansicht geöffnet oder gibt es keine Registerkarte in der Seitenleiste, der diesen Ordner enthält, öffnet sich stattdessen ein Pop-up-Fenster.

Syntax

open({ id: <folderId> });

Parameter

Parameter	Beschreibung	Pflicht	Default-Wert
id	Definiert die ID des Ordners, der sich öffnet.	ja	–

Beispiele

Den Ordner Eigene Dateien des aktuellen Benutzers öffnen:

let home = require('/agorum/roi/customers/agorum.home/js/home');

home.open({
  id: 'home:MyFiles'
});

Den gewählten Ordner aus einer Aktion des agorum core smart assistant konfigurators öffnen:

let aguila = require('common/aguila');
let home = require('/agorum/roi/customers/agorum.home/js/home');

aguila.enter(() => home.open({
  id: objects[0].UUID
}));

Kompatibilität mit dem agorum core smart assistant

Wenn dieselbe Aktion im agorum core explorer und agorum core smart assistant aufgerufen werden soll, müssen Sie 3 Aktionen erstellen.

Die folgenden drei Beispiele (Aktionen) zeigen, wie Sie zu einer Projektakte springen.

Erste Aktion (Client-Aktion)

Die erste Aktion ist eine Client-Aktion, die prüft, von wo aus der Aufruf stattfindet. Hier wird entschieden, ob die Folgeaktion für den agorum core smart assistant (hier im Beispiel ASA) ist oder für den agorum core explorer (hier im Beispiel AGUILA).

Die Aktion erhält einen Selektor, sodass sie per Klick auf der rechten Maustaste angezeigt wird.

JavaScript

/* global window, folderId, ids */
// ACHTUNG: MUSS EINE CLIENT-AKTION SEIN

if (window.location.href.indexOf('/aguila_module') === -1) {
  'action:_GEHEZU_ASA:' + ids[0]; // Das ist die Folgeaktion für den ASA
}
else {
  'action:_GEHEZU_AGUILA:' + ids[0]; // Das ist die Folgeaktion für den Explorer
}

Aktion „_GEHEZU_AGUILA“ (Server-Aktion)

Diese Aktion hat keinen Selektor, da sie nur über die Client-Aktion aufrufbar ist.

Weiter hat sie in diesem Beispiel ein Metadatum zur Abfrage des Projektnamens.

JavaScript

/* global sc, sca, folder, objects, data */

let obj = require('common/objects');
let aguila = require('common/aguila');
let home = require('/agorum/roi/customers/agorum.home/js/home');
let query = 'identifier:(Projektakte) name:"$1"'.replace('$1', data.acmf_projektName);
let target = obj.search(query)[0];
if (!target) {
  throw 'Projektakte nicht vorhanden:"$1"'.replace('$1', data.acmf_projektName + ' -- ' + query);
}

aguila.enter(() => home.open({
  id: target.UUID
}));

Aktion „_GEHEZU_ASA (Server-Aktion)

Diese Aktion hat keinen Selektor, da sie nur über die Client-Aktion aufrufbar ist.

Weiter hat sie in diesem Beispiel ein Metadatum zur Abfrage des Projektnamens.

JavaScript

/* global sc, sca, folder, objects, data */

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

let query = 'identifier:(Projektakte) name:"$1"'.replace('$1', data.acmf_projektName);
let target = obj.search(query)[0];
if (!target) {
  throw 'Projektakte nicht vorhanden:"$1"'.replace('$1', data.acmf_projektName + ' -- ' + query);
}
target.ID;