TaskSchedulerHelper

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:49

Helferklasse für die Skriptausführung mit dem cosmolink TaskScheduler

Example

import { TaskSchedulerHelper } from "./lib/TaskSchedulerHelper";
await using task: TaskSchedulerHelper = await TaskSchedulerHelper.createAsync(cRM);

Eigenschaften

extPKField

Abfragesignatur

get extPKField(): string;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:119

Gibt den Inhalt der SessionProperty "ExtPKField" zurück

Rückgabewert

string

---

extRecordid

Abfragesignatur

get extRecordid(): string;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:126

Gibt den Inhalt der SessionProperty "ExtRecordid" zurück

Rückgabewert

string

---

isActive

Abfragesignatur

get isActive(): boolean;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:133

Gibt zurück, ob ein Task aktiv ist

Rückgabewert

boolean

---

taskID

Abfragesignatur

get taskID(): string;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:140

Gibt die ID des aktiven Tasks zurück

Rückgabewert

string

Methoden

dialogMessageBoxAsync()

dialogMessageBoxAsync(
   messageSubject, 
   messageText, 
   messageTitle, 
style): Promise<void>;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:188

Schreibt in abhängigkeit eines aktiven Tasks ein Log oder öffnet eine DialogMessageBox mit den Informationen

Parameter

Parameter	Type	Description
messageSubject	string	Subject
messageText	string	Text
messageTitle	string	Titel
style	MsgBoxIcon	MsgBoxIcon

Rückgabewert

Promise<void>

Example

await Task.dialogMessageBoxAsync(`Der Vorgang wird beendet.`, `Bei der Ausführung des Tasks ist ein unerwartetes Verhalten aufgetreten`, `cosmolink`, MsgBoxIcon.MsgBoxIcon.Information);

---

initializeAsync()

initializeAsync(): Promise<void>;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:91

Initialisiert die TaskSchedulerHelper Instanz

Rückgabewert

Promise<void>

---

logAsync()

logAsync(message): Promise<void>;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:166

Schreibt eine Information in das Tasklog

Parameter

Parameter	Type	Description
message	string	zu schreibende Information

Rückgabewert

Promise<void>

Example

await Task.logAsync(`Bei der Ausführung des Tasks ist ein unerwartetes Verhalten aufgetreten`);

---

sendMailToTaskReceiverAsync()

sendMailToTaskReceiverAsync(viewName, attachments): Promise<void>;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:233

Sendet eine Mail an alle Taskempfänger, es ist zwingend notwendig vorher zu prüfen, ob ein Task aktiv ist.

Parameter

Parameter	Type	Description
viewName	string	Name der Ansicht
attachments	string[]	weitere Anhänge

Rückgabewert

Promise<void>

Example

	if (task.IsActive) 
  {
			await task.sendMailToTaskReceiverAsync(`Kontakte`, null);
	}

---

setErrorAsync()

setErrorAsync(): Promise<void>;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:206

Setzt den Task als Fehlgeschlagen = 1

Rückgabewert

Promise<void>

---

Create()

static Create(cRMHelper): Promise<TaskSchedulerHelper>;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:72

Erstellt und initialisiert eine neue TaskSchedulerHelper Instanz

Parameter

Parameter	Type	Description
cRMHelper	combitCRMHelper	combit CRM Instanz

Rückgabewert

Promise<TaskSchedulerHelper>

Deprecated

Die Funktion steht in zukünftigen Versionen eventuell nicht mehr zur Verfügung und sollte nicht mehr verwendet werden, da diese durch die Funktion createAsync ersetzt wurde.

---

createAsync()

static createAsync(cRMHelper): Promise<TaskSchedulerHelper>;

Definiert in: lib/cosmolink.Lib.TaskScheduler.Helper.ts:82

Erstellt und initialisiert eine neue TaskSchedulerHelper Instanz

Parameter

Parameter	Type	Description
cRMHelper	combitCRMHelper	combit CRM Instanz

Rückgabewert

Promise<TaskSchedulerHelper>