ks.message

ks.message wird verwendet um Informationen in verschiedenen Art und Weisen dem User zu präsentieren.

addLog

Serverseitig

Schreibt die angegebene Nachricht in Konsole des Servers.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
message	String	Ja	Nachricht die angezeigt werden soll
severity	String	Nein	Bestimmt die Farbe in der die Nachricht angezeigt werden soll error warn info success

Beispiel

Das Beispiel zeigt, wie Sie eine Error Meldung in der Server Konsole anzeigen können.

await ks.message.addLog('Hier ist ein Fehler passiert!', 'error');

Clientseitig

Zeigt die angegebene Nachricht als Growl oder im Tray an.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
message	String	Ja	Nachricht die angezeigt werden soll
severity	String oder Objekt	Nein	Bestimmt die Farbe in der die Nachricht angezeigt werden soll error warn info success
key	String	Nein	Bestimmt wo die Nachricht angezeigt werden soll tray growl

Die severity kann Clientseitig optional auch durch ein Objekt ersetzt werden, um weitere Optionen zu definieren.

Beispiel

Das Beispiel zeigt, wie Sie eine Info-Growl anzeigen, die nicht von alleine verschwindet.

await ks.message.addLog('Hier ist eine Info Nachricht', {
    severity: 'info',
    sticky: true,
    closable: true
});

clearLogs

Sticky, nicht schließbare Growls können per ks.message.clearLogs() wieder entfernt werden.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
key	String	Nein	Key der zuvor hinzugefügten Nachricht

Beispiel

Das Beispiel zeigt, wie Sie alle vorhandenen Growls schließen.

ks.message.clearLogs('growl');

backgroundConfirm

Zeigt eine Growl mit Option zum Annehmen oder Ablehnen an. Es ist möglich eine Funktion für die jeweilige Option anzugeben. Der User ist nicht dazu gezwungen eine der Optionen anzuklicken.

info

Diese Funktion steht nur Clientseitig zur Verfügung.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
message	String	Ja	Nachricht die angezeigt werden soll
scriptAccept	Funktion	Nein	Funktion die ausgeführt werden soll, wenn "Annehmen" geklickt wurde
scriptReject	Funktion	Nein	Funktion die ausgeführt werden soll, wenn "Ablehnen" geklickt wurde

Beispiel

Das Beispiel zeigt, wie Sie eine Bestätigungsgrowl erstellen können.

await ks.message.backgroundConfirm('Wollen Sie diese Aktion wirklich ausführen?', () => {
    console.log('Der User will die Aktion ausführen!');
}, () => {
    console.log('Der User will die Aktion nicht ausführen!');
});

confirm

Öffnet einen Dialog im Vordergrund mit Option zum Annehmen oder Ablehnen. Es ist möglich eine Funktion für die jeweilige Option anzugeben. Der User ist dazu gezwungen eine der Optionen anzuklicken.

info

Diese Funktion steht nur Clientseitig zur Verfügung.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
message	String	Ja	Nachricht die angezeigt werden soll
scriptAccept	Funktion	Nein	Funktion die ausgeführt werden soll, wenn "Annehmen" geklickt wurde
scriptReject	Funktion	Nein	Funktion die ausgeführt werden soll, wenn "Ablehnen" geklickt wurde
size	String	Nein	Definiert die Größe des Dialogs

Beispiel

Das Beispiel zeigt, wie Sie einen kleinen Dialog öffnen, der den User dazu auffordert die Aktion an- oder abzulehnen.

await ks.message.confirm('Wollen Sie diese Aktion wirklich ausführen?', () => {
    console.log('Der User will die Aktion ausführen!');
}, () => {
    console.log('Der User will die Aktion nicht ausführen!');
}, 'small');

prompt

Öffnet einen Dialog im Vordergrund mit angegebener Nachricht und stellte ein Textfeld zur Verfügung, in die ein User Daten eingeben kann. Falls der User den Dialog bestätigt, wird der eingegebene Text zurückgegeben.

info

Diese Funktion steht nur Clientseitig zur Verfügung.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
title	String	Ja	Text der in der Kopfzeile des Dialogs angezeigt werden soll
message	String	Ja	Nachricht die angezeigt werden soll
size	String	Nein	Definiert die Größe des Dialogs

Beispiel

Das Beispiel zeigt, wie Sie einen kleinen Dialog öffnen, der den User dazu auffordert einen Text einzugeben.

const name = await ks.message.prompt('Erfassung Ihres Names', 'Wie sollen wir Sie nennen?', 'small');
console.log(name); // wenn User akzeptiert hat, steht hier der eingegebene Text, ansonsten null

throw

Schmeißt einen neuen KolibriScriptError, der die weitere Ausführung des folgenden Codes abbricht.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
message	String	Ja	Nachricht die angezeigt werden soll
code	Number	Nein	StatusCode der bspw. bei fehlgeschlagenem HTTP-Request angezeigt wird
suppressGrowl	Boolean	Nein	Steuert ob Growl im Client angezeigt wird

Beispiel

Das Beispiel zeigt, wie Sie einen Fehler schmeißen können, falls eine vorherige Bedingung nicht erfüllt wurde.

if (!isValid) {
    ks.message.throw('Daten konnten nicht validiert werden', 500);
}

addNotification

Fügt dem übergebenen User eine neue Benachrichtigung hinzu, die oben Links unter dem Glockensymbol angezeigt wird.

Parameter

Name	Typ	Pflichtangabe	Beschreibung
user	Objekt	Ja	User dem die Benachrichtigung angezeigt werden soll
record	Objekt	Ja	Der Datensatz der von der Benachrichtigung betroffen ist
data	Objekt	Ja	Enthält die Nachricht die angezeigt werden soll und einen Command der bei Klick auf die Benachrichtigung ausgeführt wird
save	Boolean	Nein	Steuert ob die Benachrichtigung in der Datenbank persistiert werden soll

Beispiel

Das Beispiel zeigt, wie Sie einem User eine Benachrichtigung hinzufügen können. Diese Benachrichtigung wird, wenn sie geöffnet wird, den User zu dem angegebenen ThirdPartyCredential Datensatz umleiten.

const recordWithChanges = await ks.record.get('ThirdPartyCredential', 'someUUID');
await ks.message.addNotification(user, recordWithChanges, {
    message: `Es gab Änderungen in ihrem ThirdPartyAccount ${record.representativeString}`,
    command: 'return ks.router.redirectToEntity(record);'
}, false);

Optionen

severity

Bestimmt die Farbe in der die Nachricht angezeigt werden soll.

key

Anhand des keys können Growls programmatisch geschlossen werden.

sticky

Parameter steuert, ob die Growl automatisch wieder verschwindet.

closable

Parameter steuert, ob die Growl vom User geschlossen werden kann.