JavaScript-Bibliothek agorum.notes/js/notes

Mit dieser JavaScript-Bibliothek steuern Sie die Bedienoberfläche von Notizen in agorum core.

Verwendung

---

Binden Sie die Bibliothek stets am Anfang eines Skripts ein:

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

Funktionen

---

open

Öffnet je nach Parameter ein neues Notiz-Fenster im Anzeigemodus oder im Bearbeitungsmodus.

Syntax

notes.open(<params>);

Parameter „params“

Der Parameter params unterstützt diese Felder:

Feld	Beschreibung	Pflicht
action	Teilt dem Notiz-Fenster mit, welche Aktion das System ausführt. create Erstellt eine Notiz an dem übergebenen Hauptobjekt (im Feld mainObj). view Betrachtet vorhandene Notizen an dem übergebenen Hauptobjekt (im Feld mainObj). edit Bearbeitet eine vorhandene Notiz (im Feld note).	ja
mainObj	Definiert die UUID des Objekts, an das das System eine neue Notiz hängt (action: create) oder dessen Notizen das System darstellt (action: view).	nur für action: create und action: view
note	Definiert die UUID der Notiz, die bearbeitet werden soll.	nur für action: edit
recipients	Definiert ein Array von UUIDs von Benutzern oder Benutzergruppen, die das System als Empfänger einer neu erstellten Notiz (action: create) vorausfüllt.	nein

Beispiel: Neue Notiz erstellen

Erstellen einer neuen Notiz am Ordner /agorum/roi/Files:

let notes = require('/agorum/roi/customers/agorum.notes/js/notes');
let objects = require('common/objects');

notes.open({
  action: 'create',
  mainObj: objects.find('/agorum/roi/Files').UUID
});

Beispiel: Neue Notiz mit vorausgefüllten Empfängern erstellen

Erstellen einer neuen Notiz mit einem definierten Array von UUIDs als vorausgefüllte Empfänger der Notiz.

let notes = require('/agorum/roi/customers/agorum.notes/js/notes');
let objects = require('common/objects');

notes.open({
  mainObj: 'object-uuid',
  action: 'create',
  recipients: [ 'user-uuid-1', 'user-uuid-2', ... ],
});

 

Beispiel: Vorhandene Notiz betrachten

Betrachten vorhandener Notizen am Ordner /agorum/roi/Files:

let notes = require('/agorum/roi/customers/agorum.notes/js/notes');
let objects = require('common/objects');

notes.open({
  action: 'view',
  mainObj: objects.find('/agorum/roi/Files').UUID
});

Beispiel: Vorhandene Notiz bearbeiten

Bearbeiten einer vorhandenen Notiz mit der UUID e25a7629-8254-4356-b3da-26abe85fdab3:

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

notes.open({
  action: 'edit',
  note: 'e25a7629-8254-4356-b3da-26abe85fdab3'
});