Version: 1.24.327.1123

cRMApplication

Das Application-Objekt des cRM

Implementiert

AsyncDisposable

Eigenschaften

AppDir

get AppDir(): string

Liefert den vollständigen Pfad des Hauptverzeichnisses der Anwendung, d.h. dort wo sich die Applikationsdateien (EXE und OVL) befinden: z.B. C:\Program Files (x86)\combit\cRM

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7245

AppTitle

get AppTitle(): string

Liefert den Namen der Anwendung zurück

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7254

CurrentProject

get CurrentProject(): Promise<Project>

Gibt das geladene Projekt als Objekt vom Typ Project zurück (leer, wenn kein Projekt geladen).

Rückgabewert

Promise<Project>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7435

DBServerName

get DBServerName(): string

Liefert den konfigurierten Datenbankservernamen zurück
Hinweis: Der Datenbankservername wird so zurückgegeben, wie er unter Konto > Datenbankverbindung bzw.per Client-Installation angegeben wurde, inklusive der Groß- und Kleinschreibung.
Ein Vergleich mit bestimmten Werten sollte idealerweise ohne Berücksichtigung von Groß- und Kleinschreibung stattfinden, um ggf. unterschiedliche aber funktionierende Schreibweisen des Datenbankservernamens abzudecken.

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7265

DialogForm

get DialogForm(): Promise<DialogForm>

Liefert ein Objekt vom Objekt DialogForm zurück.

Example

Der Aufruf könnte wie folgt aussehen:

let dialogForm : DialogForm;
try {
	try {
	  dialogForm = await cRM.DialogForm;
	} catch (error) {
	  if (error instanceof (Error)) {
		  await cRM.DialogMessageBox("Der Vorgang wird beendet","Auf das Objekt zur Darstellung des combit CRM Dialogfensters konnte nicht zugegriffen werden.\nBitte wenden Sie sich an Ihren Administrator oder den cosmolink Support.\n\n" + error.message ,"Dialogfenster kann nicht angezeigt werden", MsgBoxButton.OkOnly, MsgBoxIcon.Exclamation);
		  return;
	  }
	}
	//... Verwendung des DialogForm Objekts
} finally {
	await dialogForm?.DisposeAsync();
}

Remarks

Vor der Rückgabe der DialogForm wird eine Registrierungsprüfung der combit DialogForm Komponente durchgeführt.
Sollte diese Registrierung nicht vorhanden sein oder ein unerwartetes Ergebnis zurückliefern wird ein Fehler ausgelöst.
Daher wird empfohlen den Aufruf dieser Eigenschaft nur innerhalb eines vollständigen Fehlerhandlings durchzuführen.

Throws

DialogFormInvalidRegistrationException - Wird ausgelöst wenn die Registrierung der combit DialogForm Komponente nicht gefunden oder ungültig ist

Rückgabewert

Promise<DialogForm>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7301

Edition

get Edition(): Edition

Liefert die Edition zurück.

Rückgabewert

Edition

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7324

Environment

get Environment(): CRMEnvironment

Skriptumgebung

Rückgabewert

CRMEnvironment

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7235

FileVersion

get FileVersion(): CRMVersion

Rückgabe der Dateiversion der installierten Anwendung.

Rückgabewert

CRMVersion

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7334

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7472

MainWindowHandle

get MainWindowHandle(): number

Liefert das Haupt-Fensterhandle zurück.

Rückgabewert

number

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7352

ProcessID

get ProcessID(): number

Liefert die ProzessId zurück.

Rückgabewert

number

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7361

ProductVersion

get ProductVersion(): CRMVersion

Rückgabe der Produkt-Versionsnummer der installierten Anwendung.

Rückgabewert

CRMVersion

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7370

ServerAppDir

get ServerAppDir(): string

Rückgabe des Pfads der Serverinstallation. Im Fall einer Einzelplatzversion wird der Wert der Eigenschaft AppDir zurückgegeben

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7388

TempDir

get TempDir(): string

Rückgabe des Benutzer Temp-Verzeichnisses

Rückgabewert

string

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7397

TimeManagerType

get TimeManagerType(): TimeManagerType

Rückgabe der eingestellten Terminverwaltung.

Rückgabewert

TimeManagerType

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7406

TrialVersion

get TrialVersion(): boolean

Abfrage, ob die aktuelle Version eine Demoversion ist

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7416

UILanguageID

get UILanguageID(): UILanguage

Liefert die Sprachkonstante (LANGID gemäß Microsoft Windows SDK) der aktuell eingestellten Sprache des Benutzerinterfaces.Der Wert korrespondiert zu den ".lng"-Unterverzeichnissen der Installation

Rückgabewert

UILanguage

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7425

Visible

get Visible(): boolean

Gibt den Anzeigezustand der Anwendung zurück oder setzt diesen.
Standardmäßig ist beim Zugriff per COM der Anzeigezustand der Anwendung unsichtbar ( false ).

set Visible(val): void

Gibt den Anzeigezustand der Anwendung zurück oder setzt diesen.
Standardmäßig ist beim Zugriff per COM der Anzeigezustand der Anwendung unsichtbar ( false ).

Parameter

Parameter	Type
`val`	`boolean`

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7458

Methoden

CheckAbortedWaitDlg()

CheckAbortedWaitDlg(): Promise<boolean>

Die Methode muss zwischen StartWaitDlg und EndWaitDlg aufgerufen werden und gibt zurück, ob der Benutzer die Schaltfläche "Abbrechen" des Wartedialoges betätigt hat, sofern StartWaitDlg mit AbbruchSchaltfläche angezeigt wurde. Die Methode wird vorzugsweise in Ausführungsschleifen verwendet.

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7487

ConvertHTML2PlainText()

ConvertHTML2PlainText(html): Promise<string>

Konvertiert einen als HTML übergebenen String nach Klartext

Parameter

Parameter	Type	Description
`html`	`string`	Zu konvertierender HTML-String

Rückgabewert

Promise<string>

Klartext

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7499

ConvertLocalToUTCDateTime()

ConvertLocalToUTCDateTime(date): Promise<Date>

Gibt das UTC-Datum und –Zeit zurück. Dies wird für die Konvertierung der Termine und Aufgaben benötigt, da eine Speicherung in die Datenbanktabelle(cmbt_tm_appointments = Termine | cmbt_tm_todos = Aufgabe) im UTC-Format erfolgt.
Diese Verwendung finden Sie in der Info-Zentrale des mitgelieferten Beispiel Projektes

Parameter

Parameter	Type	Description
`date`	`Date`	Lokales Datum und Uhrzeit

Rückgabewert

Promise<Date>

UTC-Datum

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7512

ConvertPlainText2HTML()

ConvertPlainText2HTML(plainText): Promise<string>

Konvertiert einen als Klartext übergebenen String nach HTML

Parameter

Parameter	Type	Description
`plainText`	`string`	Zu konvertierender Klartext

Rückgabewert

Promise<string>

HTML

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7524

ConvertUTCToLocalDateTime()

ConvertUTCToLocalDateTime(utcDate): Promise<Date>

Gibt das lokale Datum und die Uhrzeit anhand des UTC-Datums zurück

Parameter

Parameter	Type	Description
`utcDate`	`Date`	UTC-Datum und Uhrzeit

Rückgabewert

Promise<Date>

Lokales Datum

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7536

CreateGUID()

CreateGUID(): Promise<string>

Erzeugt einen global eindeutigen Identifier und gibt diesen als unformatierte Zeichenkette zurück

Rückgabewert

Promise<string>

Uniqueidentifier im combit Format

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7547

CreateTempFile()

CreateTempFile(
   prefix, 
   extension, 
autoRemove): Promise<string>

Erzeugt im System-Verzeichnis %TEMP% eine temporäre eindeutige Datei ohne Inhalt und gibt deren Dateiname zurück. In diese Datei kann anschließend bspw. Über die Methode GetContentsByNameToFile der Inhalt eines Feldes vom Typ "Eingebettete Datei" oder "Eingebettete Grafik" gespeichert werden ohne das es Probleme mit einem nicht-eindeutigen Dateinamen gibt.

Parameter

Parameter	Type	Description
`prefix`	`string`	Präfix des Dateinamens
`extension`	`string`	Dateiendung
`autoRemove`	`boolean`	`true` wenn die Datei beim Beenden der Anwendung gelöscht werden soll, andernfalls `false`

Rückgabewert

Promise<string>

Pfad zur temporären Datei

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7561

DebugOutput()

DebugOutput(output): Promise<void>

Debugausgabe in Debwin

Parameter

Parameter	Type
`output`	`string`

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7570

Decrypt()

Decrypt(input, key): Promise<string>

Entschlüsselt einen Text anhand eines übergebenen Keys

Parameter

Parameter	Type	Description
`input`	`string`	Zu entschlüsselnder Text
`key`	`string`	Passphrase

Rückgabewert

Promise<string>

Entschlüsselter Text

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8478

DialogAddressAssistant()

DialogAddressAssistant(mode, input): Promise<CRMDialogResult<DialogOutputAddress>>

Zeigt den Adresseingabe-Assistent für eine übergebene Adresse an oder ergänzt die Adresse mit fehlenden Informationen

Parameter

Parameter	Type	Description
`mode`	`DialogAddressMode`	Gibt an wie der Dialog angezeigt wird
`input`	`DialogInputAddress`	Ermöglicht die Übergabe von Adressinformationen

Rückgabewert

Promise<CRMDialogResult<DialogOutputAddress>>

Enthält die ergänzte Adressinformation sofern möglich in Value . Bei Benutzerabbruch ist IsCanceled gesetzt

Remarks

Version 12.0.0

Die Methode/Eigenschaft wird erst ab dieser Version unterstützt. Bei vorherigen Versionen führt der Aufruf zu einer Exception.

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7587

DialogChoiceMessageBox()

DialogChoiceMessageBox(
   message, 
   title, 
   choices, 
   icon?, 
   enableCancel?, 
parentHandle?): Promise<CRMDialogResult<number>>

Zeigt einen Dialog zur Auswahl von übergebenen Einträgen an.

Parameter

Parameter	Type	Description
`message`	`string`	Nachricht des Dialogs
`title`	`string`	Titel des Dialogs
`choices`	`string`[]	Über diesen Parameter bestimmen Sie die Auswahlmöglichkeiten.
`icon`?	`DialogChoiceIcon`	Bestimmt das neben der Auswahl dargestellte Symbol
`enableCancel`?	`boolean`	Bestimmt, ob eine "Abbrechen"-Schaltfläche angezeigt werden soll.
`parentHandle`?	`number`	Optional - Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll.

Rückgabewert

Promise<CRMDialogResult<number>>

Enthält den 0 basierten Index des gewählten Eintrags in Value . Bei Benutzerabbruch ist IsCanceled gesetzt

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7623

DialogInputBox()

DialogInputBox(
   prompt, 
   title?, 
   defaultValue?, 
   dialogInputType?, 
   maxInputLenght?, 
parentHandle?): Promise<CRMDialogResult<string>>

Zeigt einen Eingabedialog an und gibt den eingetragenen Wert zurück

Parameter

Parameter	Type	Description
`prompt`	`string`	Information, die im Dialog angezeigt werden soll.
`title`?	`string`	Optional - Titel des Dialogs.
`defaultValue`?	`string`	Optional - Voreingestellter Wert für die Eingabe.
`dialogInputType`?	`DialogInputType`	Optional - Reserviert. Der Parameterwert wird derzeit ignoriert.
`maxInputLenght`?	`number`	Optional Voreinstellung:256 - Maximale Länge der Benutzereingabe.
`parentHandle`?	`number`	Optional - Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll.

Rückgabewert

Promise<CRMDialogResult<string>>

Enthält die Benutzereingabe in Value . Bei Benutzerabbruch ist IsCanceled gesetzt

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7694

DialogInputBoxMultiline()

DialogInputBoxMultiline(
   prompt, 
   title?, 
   defaultValue?, 
   dialogSyntaxColoring?, 
   maxInputLenght?, 
parentHandle?): Promise<CRMDialogResult<string>>

Zeigt einen Eingabedialog mit einem mehrzeiligen Eingabefeld an und gibt den eingetragenen Wert zurück.

Parameter

Parameter	Type	Description
`prompt`	`string`	Information, die im Dialog angezeigt werden soll.Beachten Sie bitte, dass keine Umbrüche unterstützt werden.
`title`?	`string`	Optional - Titel des Dialogs.
`defaultValue`?	`string`	Optional - Voreingestellter Wert für die Eingabe.
`dialogSyntaxColoring`?	`DialogSyntaxColoring`	Optional - Angabe, für welche Syntax ein Highlighting bzw. Coloring erfolgen soll. Mögliche Werte: "sql", "script", "" (wenn leer, wird kein Highlighting bzw.Coloring dargestellt).
`maxInputLenght`?	`number`	Optional Voreinstellung: 256 - Maximale Länge der Benutzereingabe.
`parentHandle`?	`number`	Optional - Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll.

Rückgabewert

Promise<CRMDialogResult<string>>

Enthält die Benutzereingabe in Value . Bei Benutzerabbruch ist IsCanceled gesetzt

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7789

DialogMessageBox()

DialogMessageBox(
   messageSubject, 
   messageText, 
   title, 
   button?, 
   icon?, 
parentHandle?): Promise<DialogResult>

Zeigt einen Dialog zur Ausgabe von Informationen im cRM-Stil an

Parameter

Parameter	Type	Description
`messageSubject`	`string`	Hauptzeile der Nachricht, diese wird in einer größeren Schrift dargestellt
`messageText`	`string`	Nachricht des Dialogs.
`title`	`string`	Titel des Dialogs.
`button`?	`MsgBoxButton`	Bestimmt die Schaltflächen des Dialogs
`icon`?	`MsgBoxIcon`	Bestimmt das Icon des Dialogs
`parentHandle`?	`number`	Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden.

Rückgabewert

Promise<DialogResult>

Der Rückgabewert entspricht einer Konstante von DialogResult

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7884

DialogMessageBoxAuto()

DialogMessageBoxAuto(
   messageSubject, 
   messageText, 
   title, 
   messageId, 
   button?, 
   icon?, 
parentHandle?): Promise<DialogResult>

Zeigt einen Dialog zur Ausgabe von Informationen im cRM-Stil an. Zusätzlich wird eine Option "In Zukunft nicht mehr anzeigen" bereitgestellt.

Parameter

Parameter	Type	Description
`messageSubject`	`string`	Hauptzeile der Nachricht, diese wird in einer größeren Schrift dargestellt
`messageText`	`string`	Nachricht des Dialogs.
`title`	`string`	Titel des Dialogs.
`messageId`	`string`	Eindeutige ID in Form einer Zeichenkette zur Speicherung der Auswahl für den Wert "In Zukunft nicht mehr anzeigen".
`button`?	`MsgBoxButton`	Bestimmt die Schaltflächen des Dialogs
`icon`?	`MsgBoxIcon`	Bestimmt das Icon des Dialogs
`parentHandle`?	`number`	Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden.

Rückgabewert

Promise<DialogResult>

Der Rückgabewert entspricht einer Konstante von DialogResult

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7929

DialogSelectColor()

DialogSelectColor(
   currentColor?, 
   defaultColor?, 
parentHandle?): Promise<CRMDialogResult<number>>

Zeigt einen Farbauswahldialog an und gibt den ausgewählten Farbwert zurück

Parameter

Parameter	Type	Description
`currentColor`?	`number`	Optional. Aktuelle Farbe. Wenn dieser Parameter nicht übergeben wird, wird Schwarz verwendet.
`defaultColor`?	`number`	Optional. Neue Farbe, die vorausgewählt werden soll. Wenn dieser Parameter nicht angegeben wird, wird die aktuelle Farbe (vgl.Parameter `currentColor` ) verwendet.
`parentHandle`?	`number`	Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden.

Rückgabewert

Promise<CRMDialogResult<number>>

Enthält den ausgewählten Farbwert in Value . Bei Benutzerabbruch ist IsCanceled gesetzt

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:7970

DialogSelectDir()

DialogSelectDir(
   title, 
   openFileDlg, 
   initialPath?, 
   flags?, 
parentHandle?): Promise<CRMDialogResult<string>>

Zeigt einen Verzeichnisauswahldialog an und gibt den ausgewählten Verzeichnispfad zurück

Parameter

Parameter	Type	Description
`title`	`string`	Dialogtitel
`openFileDlg`	`boolean`	`true` Verzeichnis Öffnen `false` Verzeichnis Speichern.
`initialPath`?	`string`	Optional -Initielles Verzeichnis als Voreinstellung für den Dialog oder leer.
`flags`?	`OFNFlags`	Optional -Reserviert, muss 0 sein
`parentHandle`?	`number`	Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden.

Rückgabewert

Promise<CRMDialogResult<string>>

Enthält den ausgewählten Verzeichnispfad in Value . Bei Benutzerabbruch ist IsCanceled gesetzt

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8032

DialogSelectFile()

DialogSelectFile(
   title, 
   openFileDlg, 
   initialPath?, 
   fileFilter?, 
   flags?, 
parentHandle?): Promise<CRMDialogResult<string>>

Zeigt einen Dateiauswahldialog an und gibt den ausgewählten Dateipfad zurück.

Parameter

Parameter	Type	Description
`title`	`string`	Dialogtitel
`openFileDlg`	`boolean`	`true` Datei Öffnen `false` Datei Speichern.
`initialPath`?	`string`	Optional -Initielles Verzeichnis als Voreinstellung für den Dialog oder leer. Kann einen kompletten Dateipfad enthalten oder leer sein.
`fileFilter`?	`string`	Optional -Kann eine Liste von Dateifiltern enthalten oder leer sein. Format: BeschreibungFilter1
`flags`?	`OFNFlags`	Optional -Bestimmt die Interaktion mit dem Dialog (Beschreibung siehe MSDN unter 'OPENFILENAME')
`parentHandle`?	`number`	Optional. Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden.

Rückgabewert

Promise<CRMDialogResult<string>>

Enthält den ausgewählten Dateipfad in Value . Bei Benutzerabbruch ist IsCanceled gesetzt

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8105

DialogSelectString()

DialogSelectString(
   message, 
   choices, 
   sortChoices, 
   allowMultiSelect?, 
   allowFilter?, 
   profileKey?, 
parentHandle?): Promise<CRMDialogResult<string[]>>

Zeigt einen Dialog zur Auswahl eines oder mehrerer Strings an.

Parameter

Parameter	Type	Description
`message`	`string`	Information oder Frage, die im Titel des Dialogs angezeigt werden soll.
`choices`	`string`[]	Liste mit Auswahlmöglichkeiten. Beginnt Eintrag mit einem *, dann wird dieser Eintrag vorausgewählt.
`sortChoices`	`SortOrderChoices`	Sortierung der Einträge
`allowMultiSelect`?	`boolean`	Optional Vorteinstellung `true` - `true` : Mehrfachauswahl von Einträgen ist möglich `false` : Mehrfachauswahl von Einträgen ist nicht möglich
`allowFilter`?	`boolean`	Optional Vorteinstellung `true` - `true` : Suche innerhalb der Auflistung der Einträge ermöglicht `false` : Suche innerhalb der Auflistung der Einträge nicht ermöglicht
`profileKey`?	`string`	Optional - Name, unter welchem innerhalb der Registrierung im nachfolgenden Schlüssel die letzte Auswahl gespeichert und beim nächsten Mal automatisch geladen werden soll. Wenn neue Einträge mit einem * übergeben wurden, sodass diese vorausgewählt angezeigt werden sollen, dann überschreiben die neuen Einträge die bestehende Vorauswahl aus der Registrierung. Folgender Registrierungsschlüssel wird verwendet:HKEY_CURRENT_USER\Software\combit\combit Relationship Manager\Projects\{Name des Projektes}\COMDialogSelectString
`parentHandle`?	`number`	Optional - Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden.

Rückgabewert

Promise<CRMDialogResult<string[]>>

Enthält ein Array der ausgewählten Strings in Value . Bei Benutzerabbruch ist IsCanceled gesetzt

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8192

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8484

Encrypt()

Encrypt(input, key): Promise<string>

Verschlüsselt einen Text anhand eines übergebenen Keys

Parameter

Parameter	Type	Description
`input`	`string`	Zu verschlüsselnder Text
`key`	`string`	Passphrase

Rückgabewert

Promise<string>

Verschlüsselter Text

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8465

EndWaitDlg()

EndWaitDlg(): Promise<void>

Blendet einen zuvor mit StartWaitDlg angezeigten Wartedialog aus.

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8267

FetchGlobalConfigFile()

FetchGlobalConfigFile(sourceFilePath, targetFilePath): Promise<boolean>

Holt die globalen Konfigurationsdateien ohne Projekt-ID.

Parameter

Parameter	Type	Description
`sourceFilePath`	`string`	Dateiname in der cmbt_Files Tabelle in der System-Datenbank
`targetFilePath`	`string`	Dateiname, unter dem die Datei abgespeichert werden soll.

Rückgabewert

Promise<boolean>

true wenn der Befehl erfolgreich ausgeführt wurde, andernfalls false

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8280

GetIniProfileString()

GetIniProfileString(
   section, 
   property, 
   defaultValue, 
iniFile): Promise<string>

Liest einen Eintrag aus einer INI-Datei aus.

Parameter

Parameter	Type	Description
`section`	`string`	Name der Sektion in der INI-Datei, in der der zu lesende Eintrag steht.
`property`	`string`	Name des zu lesenden Eintrags.
`defaultValue`	`string`	Der Standardwert, der zurückgegeben wird, wenn kein Eintrag mit dem angegebenen Namen existiert.
`iniFile`	`string`	Pfad zur INI-Datei.

Rückgabewert

Promise<string>

Eintrag der INI-Datei

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8295

InvokeMenu()

InvokeMenu(menuId, synchronous): Promise<boolean>

Ruft einen Menüeintrag der Anwendung auf. Neben der ID des Menüeintrages wird angegeben, ob das Script solange warten soll, bis der Befehl abgearbeitet wurde(und evtl. Dialoge geschlossen wurden) oder ob das Script direkt weiterlaufen soll.

Parameter

Parameter	Type	Description
`menuId`	`number`	Die ID des Menüeintrages.
`synchronous`	`boolean`	`true` : synchrone Ausführung `false` : asynchrone Ausführung

Rückgabewert

Promise<boolean>

true wenn der Befehl zum Aufrufen eines Menüeintrags erfolgreich übermittelt wurde, false wenn der Befehl nicht übermittelt werden konnte, weil z.B. der Menüeintrag nicht zur Verfügung steht

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8309

Login(
   projectFilePath, 
   userName, 
password): Promise<Project>

Öffnet ein Projekt.
Diese Methode sollte nur aufgerufen werden, wenn noch kein anderes Projekt geladen ist.

Parameter

Parameter	Type	Description
`projectFilePath`	`string`	Verzeichnispfad der Projektdatei. Übergibt man für das zu ladende Projekt leer, so wird zunächst versucht das bereits geladene Projekt zurückzugeben.Wurde Login aber unmittelbar nach CreateObject mit leer aufgerufen, wird versucht das zuletzt geladene Projekt zu öffnen.
`userName`	`string`	Benutzername. Übergibt man diesen und das Passwort leer, wird Windows Authentifizierung versucht. Schlägt diese fehl, wird der Login-Dialog angezeigt.
`password`	`string`	Passwort des Benutzers

Rückgabewert

Promise<Project>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8324

PerformanceCounterCreate()

PerformanceCounterCreate(counterName): Promise<void>

Legt einen Messpunkt mit einem bestimmten Namen an oder setzt einen bereits existierenden Messpunkt mit dem übergebenen Namen auf 0 zurück.So können Performance-Messungen mit Hilfe des Debug-Tools des cRM durchgeführt werden.

Parameter

Parameter	Type	Description
`counterName`	`string`	Name des Messpunkts.

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8343

PerformanceCounterHit()

PerformanceCounterHit(counterName, additionalInfo?): Promise<void>

Gibt eine Messung der vergangenen Zeit in Millisekunden seit dem Aufruf von PerformanceCounterCreate(counterName: string) für den angegebenen Namen eines Messpunkts im Debug-Tool des cRM aus.
Der zweite Parameter ist optional und kann, wenn erforderlich, noch weitere relevante Informationen zur Messung ausgeben.

Parameter

Parameter	Type	Description
`counterName`	`string`	Name des Messpunkts.
`additionalInfo`?	`string`	Optional - Weitere Informationen.

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8355

SendMail()

SendMail(
   subject, 
   content, 
   toEmailAddresses?, 
   ccEmailAddresses?, 
   bccEmailAddresses?, 
   files?, 
showDialog?): Promise<boolean>

Sendet eine eMail über die MAPI-Schnittstelle, unabhängig von den Record oder RecordSet Objekten.

Parameter

Parameter	Type	Description
`subject`	`string`	Betreff der eMail.
`content`	`string`	Text der eMail.
`toEmailAddresses`?	`string`[]	Empfänger E-Mail-Adressen
`ccEmailAddresses`?	`string`[]	CC E-Mail-Adressen
`bccEmailAddresses`?	`string`[]	BCC E-Mail-Adressen
`files`?	`string`[]	Optional - Liste von eMail-Anhängen.
`showDialog`?	`boolean`	Optional Voreinstellung: `true` - Gibt an ob der Dialog angezeigt wird

Rückgabewert

Promise<boolean>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8378

SetIniProfileString()

SetIniProfileString(
   section, 
   property, 
   value, 
iniFile): Promise<void>

Setzt einen Eintrag in einer INI-Datei.

Parameter

Parameter	Type	Description
`section`	`string`	Name der Sektion in der INI-Datei, in der der zu lesende Eintrag steht.
`property`	`string`	Name des zu lesenden Eintrags.
`value`	`string`	Der zu setzende Wert.
`iniFile`	`string`	Pfad zur INI-Datei.

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8410

SetWaitDlgText()

SetWaitDlgText(text): Promise<void>

Hiermit kann der Text in einem per StartWaitDlg gestarteten Wartedialog nachträglich geändert werden.

Parameter

Parameter	Type	Description
`text`	`string`	Setzt den Text eines offenen Wartedialogs

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8420

StartWaitDlg()

StartWaitDlg(
   text, 
   cancel, 
initialDelay?): Promise<void>

Zeigt einen Wartedialog mit einer Fortschrittsanimation sowie einem zu übergebenden Informationstext an. Die Ausführung des Scripts wird während der Anzeige fortgeführt.Die Ausblendung erfolgt mit EndWaitDlg. Über den zweiten Parameter kann bestimmt werden, ob der Dialog eine "Abbrechen"-Schaltfläche enthalten soll.Wenn ja, dann kann mit CheckAbortedWaitDlg geprüft werden, ob die Schaltfläche betätigt wurde. Reserviert: Über den dritten Parameter kann die Verzögerung bis zur Anzeige des Dialogs eingestellt werden.Standardmäßig wird eine Verzögerung von 3 Sekunden verwendet, um zu verhindern, dass schnell geöffnete und geschlossene Dialoge flackern.

Parameter

Parameter	Type	Description
`text`	`string`	Der anzuzeigende Informationstext.
`cancel`	`boolean`	Anzeige einer Schaltfläche "Abbrechen"
`initialDelay`?	`number`	Optional - Reserviert, derzeit wird immer 0 verwendet. Verzögerung bis zur Anzeige des Dialogs in Sekunden. 0 = unmittelbare Anzeige. Der vorbelegte Wert beträgt 3 Sekunden

Rückgabewert

Promise<void>

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8432

StoreGlobalConfigFile()

StoreGlobalConfigFile(sourceFilePath, targetFilePath): Promise<boolean>

Speichert die globalen Konfigurationsdateien ohne Projekt-ID.

Parameter

Parameter	Type	Description
`sourceFilePath`	`string`	Dateiname unter dem die Datei in der cmbt_Files Tabelle in der System-Datenbank abgelegt werden soll.
`targetFilePath`	`string`	Dateiname der lokalen Datei, die verwendet werden soll.

Rückgabewert

Promise<boolean>

true wenn der Befehl erfolgreich ausgeführt wurde, andernfalls false

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8452

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8490

[hasInstance]()

static hasInstance: boolean

Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.

Parameter

Parameter	Type
`value`	`any`

Rückgabewert

boolean

Definiert in

SDK/Cosmolink.Scripting.SDK.CRMApplication.ts:8498

Implementiert​

Eigenschaften​

AppDir​

Rückgabewert​

Definiert in​

AppTitle​

Rückgabewert​

Definiert in​

CurrentProject​

Rückgabewert​

Definiert in​

DBServerName​

Rückgabewert​

Definiert in​

DialogForm​

Example​

Remarks​

Throws​

Rückgabewert​

Definiert in​

Edition​

Rückgabewert​

Definiert in​

Environment​

Rückgabewert​

Definiert in​

FileVersion​

Rückgabewert​

Definiert in​

IsDisposed​

Rückgabewert​

Definiert in​

MainWindowHandle​

Rückgabewert​

Definiert in​

ProcessID​

Rückgabewert​

Definiert in​

ProductVersion​

Rückgabewert​

Definiert in​

ServerAppDir​

Rückgabewert​

Definiert in​

TempDir​

Rückgabewert​

Definiert in​

TimeManagerType​

Rückgabewert​

Definiert in​

TrialVersion​

Rückgabewert​

Definiert in​

UILanguageID​

Rückgabewert​

Definiert in​

Visible​

Parameter​

Rückgabewert​

Definiert in​

Methoden​

CheckAbortedWaitDlg()​

Rückgabewert​

Definiert in​

ConvertHTML2PlainText()​

Parameter​

Rückgabewert​

Definiert in​

ConvertLocalToUTCDateTime()​

Parameter​

Rückgabewert​

Definiert in​

ConvertPlainText2HTML()​

Parameter​

Rückgabewert​

Definiert in​

ConvertUTCToLocalDateTime()​

Parameter​

Rückgabewert​

Definiert in​

Implementiert

Eigenschaften

AppDir

Rückgabewert

Definiert in

AppTitle

Rückgabewert

Definiert in

CurrentProject

Rückgabewert

Definiert in

DBServerName

Rückgabewert

Definiert in

DialogForm

Example

Remarks

Throws

Rückgabewert

Definiert in

Edition

Rückgabewert

Definiert in

Environment

Rückgabewert

Definiert in

FileVersion

Rückgabewert

Definiert in

IsDisposed

Rückgabewert

Definiert in

MainWindowHandle

Rückgabewert

Definiert in

ProcessID

Rückgabewert

Definiert in

ProductVersion

Rückgabewert

Definiert in

ServerAppDir

Rückgabewert

Definiert in

TempDir

Rückgabewert

Definiert in

TimeManagerType

Rückgabewert

Definiert in

TrialVersion

Rückgabewert

Definiert in

UILanguageID

Rückgabewert

Definiert in

Visible

Parameter

Rückgabewert

Definiert in

Methoden

CheckAbortedWaitDlg()

Rückgabewert

Definiert in

ConvertHTML2PlainText()

Parameter

Rückgabewert

Definiert in

ConvertLocalToUTCDateTime()

Parameter

Rückgabewert

Definiert in

ConvertPlainText2HTML()

Parameter

Rückgabewert

Definiert in

ConvertUTCToLocalDateTime()

Parameter

Rückgabewert

Definiert in