CRMApplication
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:102
Das Application Objekt des combit CRM.
Implementiert
Eigenschaften
appDirAsync
Abfragesignatur
get appDirAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:144
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
Promise<string>
appTitleAsync
Abfragesignatur
get appTitleAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:152
Liefert den Namen der Anwendung zurück
Rückgabewert
Promise<string>
currentProjectAsync
Abfragesignatur
get currentProjectAsync(): Promise<Project>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:256
Gibt das geladene Projekt als Objekt vom Typ Project zurück (leer, wenn kein Projekt geladen).
Rückgabewert
Promise<Project>
dbServerNameAsync
Abfragesignatur
get dbServerNameAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:163
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
Promise<string>
editionAsync
Abfragesignatur
get editionAsync(): Promise<Edition>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:176
Liefert die Edition zurück.
Rückgabewert
Promise<Edition>
fileVersionAsync
Abfragesignatur
get fileVersionAsync(): Promise<CRMVersion>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:184
Rückgabe der Dateiversion der installierten Anwendung.
Rückgabewert
Promise<CRMVersion>
isTrialVersionAsync
Abfragesignatur
get isTrialVersionAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:240
Abfrage, ob die aktuelle Version eine Demoversion ist
Rückgabewert
Promise<boolean>
mainWindowHandleAsync
Abfragesignatur
get mainWindowHandleAsync(): Promise<number>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:192
Liefert das Haupt-Fensterhandle zurück.
Rückgabewert
Promise<number>
phoneManagerAsync
Abfragesignatur
get phoneManagerAsync(): Promise<PhoneManager>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:284
Liefert das PhoneManager Objekt zurück.
Rückgabewert
Promise<PhoneManager>
processIDAsync
Abfragesignatur
get processIDAsync(): Promise<number>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:200
Liefert die ProzessId zurück.
Rückgabewert
Promise<number>
productVersionAsync
Abfragesignatur
get productVersionAsync(): Promise<CRMVersion>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:208
Rückgabe der Produkt-Versionsnummer der installierten Anwendung.
Rückgabewert
Promise<CRMVersion>
serialNumberAsync
Abfragesignatur
get serialNumberAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1002
Rückgabe der Seriennummer
Rückgabewert
Promise<string>
serverAppDirAsync
Abfragesignatur
get serverAppDirAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:216
Rückgabe des Pfads der Serverinstallation. Im Fall einer Einzelplatzversion wird der Wert der Eigenschaft AppDir zurückgegeben
Rückgabewert
Promise<string>
tempDirAsync
Abfragesignatur
get tempDirAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:224
Rückgabe des Benutzer Temp-Verzeichnisses
Rückgabewert
Promise<string>
timeManagerTypeAsync
Abfragesignatur
get timeManagerTypeAsync(): Promise<TimeManagerType>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:232
Rückgabe der eingestellten Terminverwaltung.
Rückgabewert
Promise<TimeManagerType>
uiLanguageAsync
Abfragesignatur
get uiLanguageAsync(): Promise<UILanguage>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:248
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
Promise<UILanguage>
visibleAsync
Abfragesignatur
get visibleAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:265
Gibt den Anzeigezustand der Anwendung zurück.
Standardmäßig ist beim Zugriff per COM der Anzeigezustand der Anwendung unsichtbar (false)
Rückgabewert
Promise<boolean>
Methoden
checkAbortedWaitDlgAsync()
checkAbortedWaitDlgAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:292
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>
convertHTML2PlainTextAsync()
convertHTML2PlainTextAsync(html): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:302
Konvertiert einen als HTML übergebenen String nach Klartext
Parameter
| Parameter | Type | Description |
|---|---|---|
html | string | Zu konvertierender HTML-String |
Rückgabewert
Promise<string>
Klartext
convertLocalToUTCDateTimeAsync()
convertLocalToUTCDateTimeAsync(date): Promise<Date>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:314
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 mit Uhrzeit |
Rückgabewert
Promise<Date>
UTC-Datum
convertPlainText2HTMLAsync()
convertPlainText2HTMLAsync(plainText): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:325
Konvertiert einen als Klartext übergebenen String nach HTML
Parameter
| Parameter | Type | Description |
|---|---|---|
plainText | string | Zu konvertierender Klartext |
Rückgabewert
Promise<string>
HTML
convertUTCToLocalDateTimeAsync()
convertUTCToLocalDateTimeAsync(utcDate): Promise<Date>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:336
Gibt das lokale Datum und die Uhrzeit anhand des UTC-Datums zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
utcDate | Date | UTC Datum mit Uhrzeit |
Rückgabewert
Promise<Date>
Lokales Datum mit Uhrzeit
createDialogFormAsync()
createDialogFormAsync(): Promise<DialogForm>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:168
Rückgabewert
Promise<DialogForm>
createGUIDAsync()
createGUIDAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:345
Erzeugt einen global eindeutigen Identifier und gibt diesen als unformatierte Zeichenkette zurück
Rückgabewert
Promise<string>
Uniqueidentifier im combit Format
createTempFileAsync()
createTempFileAsync(
prefix,
extension,
autoRemove): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:357
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
debugOutputAsync()
debugOutputAsync(level, output): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:367
Debugausgabe in Debwin
Parameter
| Parameter | Type | Description |
|---|---|---|
level | DebugOutputLevel | Level der Nachricht |
output | string | Nachricht für die Debugausgabe. |
Rückgabewert
Promise<void>
decryptAsync()
decryptAsync(input, key): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:994
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
dialogAddressAssistantAsync()
dialogAddressAssistantAsync(mode, input): Promise<CRMDialogResult<DialogOutputAddress>>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:387
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 | { city?: string; country?: string; houseNumber?: string; street?: string; zip?: string; } | Ermöglicht die Übergabe von Adressinformationen |
input.city? | string | - |
input.country? | string | - |
input.houseNumber? | string | - |
input.street? | string | - |
input.zip? | string | - |
Rückgabewert
Promise<CRMDialogResult<DialogOutputAddress>>
Enthält die ergänzte Adressinformation DialogOutputAddress sofern möglich in CRMDialogResult.value. Bei Benutzerabbruch ist CRMDialogResult.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.
dialogChoiceMessageBoxAsync()
dialogChoiceMessageBoxAsync(
message,
title,
choices,
options?): Promise<CRMDialogResult<number>>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:418
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. |
options? | { enableCancel?: boolean; icon?: DialogChoiceIcon; parentHandle?: number; } | Optionen |
options.enableCancel? | boolean | Voreinstellung: false Bestimmt ob die Schaltfläche "Abbrechen" angezeigt wird. |
options.icon? | DialogChoiceIcon | Bestimmt das neben der Auswahl dargestellte Symbol |
options.parentHandle? | number | 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 CRMDialogResult.value. Bei Benutzerabbruch ist CRMDialogResult.isCanceled gesetzt
dialogInputBoxAsync()
dialogInputBoxAsync(prompt, options?): Promise<CRMDialogResult<string>>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:452
Zeigt einen Eingabedialog an und gibt den eingetragenen Wert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
prompt | string | Information, die im Dialog angezeigt werden soll. |
options? | { defaultValue?: string; dialogInputType?: Default; maxInputLenght?: number; parentHandle?: number; title?: string; } | Optionen DialogInputBoxOptions |
options.defaultValue? | string | Voreingestellter Wert für die Eingabe. DefaultValue: Empty |
options.dialogInputType? | Default | DefaultValue: null |
options.maxInputLenght? | number | Maximale Länge der Benutzereingabe. DefaultValue: 256 |
options.parentHandle? | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. DefaultValue: 0 |
options.title? | string | Titel des Dialogs. DefaultValue: Empty |
Rückgabewert
Promise<CRMDialogResult<string>>
dialogInputBoxMultilineAsync()
dialogInputBoxMultilineAsync(prompt, options?): Promise<CRMDialogResult<string>>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:502
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. |
options? | { defaultValue?: string; dialogSyntaxColoring?: DialogSyntaxColoring; maxInputLenght?: number; parentHandle?: number; title?: string; } | Optionen DialogInputBoxMultilineOptions |
options.defaultValue? | string | Voreingestellter Wert für die Eingabe. DefaultValue: Empty |
options.dialogSyntaxColoring? | DialogSyntaxColoring | Angabe, für welche Syntax ein Highlighting bzw. Coloring erfolgen soll. Mögliche Werte: "sql", "script", "" (wenn leer, wird kein Highlighting bzw.Coloring dargestellt). DefaultValue: null |
options.maxInputLenght? | number | Maximale Länge der Benutzereingabe. DefaultValue: 256 |
options.parentHandle? | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. DefaultValue: 0 |
options.title? | string | Titel des Dialogs. DefaultValue: Empty |
Rückgabewert
Promise<CRMDialogResult<string>>
dialogMessageBoxAsync()
dialogMessageBoxAsync(
messageSubject,
messageText,
title,
options?): Promise<DialogResult>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:555
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 |
options? | { button?: MsgBoxButton; icon?: MsgBoxIcon; parentHandle?: number; } | Optionen DialogMessageBoxOptions |
options.button? | MsgBoxButton | Bestimmt die Schaltflächen des Dialogs DefaultValue: MsgBoxButton.OkOnly |
options.icon? | MsgBoxIcon | Bestimmt das Icon des Dialogs DefaultValue: MsgBoxIcon.None |
options.parentHandle? | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. DefaultValue: 0 |
Rückgabewert
Promise<DialogResult>
Der Rückgabewert entspricht einer Konstante von DialogResult
dialogMessageBoxAutoAsync()
dialogMessageBoxAutoAsync(
messageSubject,
messageText,
title,
messageId,
options?): Promise<DialogResult>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:593
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". |
options? | { button?: MsgBoxButton; icon?: MsgBoxIcon; parentHandle?: number; } | Optionen DialogMessageBoxOptions |
options.button? | MsgBoxButton | Bestimmt die Schaltflächen des Dialogs DefaultValue: MsgBoxButton.OkOnly |
options.icon? | MsgBoxIcon | Bestimmt das Icon des Dialogs DefaultValue: MsgBoxIcon.None |
options.parentHandle? | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. DefaultValue: 0 |
Rückgabewert
Promise<DialogResult>
Der Rückgabewert entspricht einer Konstante von DialogResult
dialogSelectColorAsync()
dialogSelectColorAsync(options?): Promise<CRMDialogResult<number>>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:627
Zeigt einen Farbauswahldialog an und gibt den ausgewählten Farbwert zurück
Parameter
| Parameter | Type | Description |
|---|---|---|
options? | { currentColor?: number; defaultValue?: number; parentHandle?: number; } | Optionen DialogSelectColorOptions |
options.currentColor? | number | Aktuelle Farbe. Wenn dieser Parameter nicht übergeben wird, wird Schwarz verwendet. |
options.defaultValue? | number | Neue Farbe, die vorausgewählt werden soll. Wenn dieser Parameter nicht angegeben wird, wird die aktuelle Farbe (vgl.Parameter currentColor) verwendet. |
options.parentHandle? | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. DefaultValue: 0 |
Rückgabewert
Promise<CRMDialogResult<number>>
Enthält den ausgewählten Farbwert in CRMDialogResult.value. Bei Benutzerabbruch ist CRMDialogResult.isCanceled gesetzt.
dialogSelectDirAsync()
dialogSelectDirAsync(
title,
openFileDlg,
options?): Promise<CRMDialogResult<string>>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:662
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 |
options? | { flags?: OFNFlags; initialPath?: string; } | Optionen DialogSelectDirOptions |
options.flags? | OFNFlags | Reserviert, muss 0 sein. |
options.initialPath? | string | Initielles Verzeichnis als Voreinstellung für den Dialog oder leer. |
Rückgabewert
Promise<CRMDialogResult<string>>
Enthält den ausgewählten Verzeichnispfad in CRMDialogResult.value. Bei Benutzerabbruch ist CRMDialogResult.isCanceled gesetzt.
dialogSelectFileAsync()
dialogSelectFileAsync(
title,
openFileDlg,
options?): Promise<CRMDialogResult<string>>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:692
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 |
options? | { fileFilter?: string; flags?: OFNFlags; initialPath?: string; parentHandle?: number; } | Optionen DialogSelectFileOptions |
options.fileFilter? | string | Kann eine Liste von Dateifiltern enthalten oder leer sein. Format: BeschreibungFilter1 |
options.flags? | OFNFlags | Bestimmt die Interaktion mit dem Dialog (Beschreibung siehe MSDN unter 'OPENFILENAME') |
options.initialPath? | string | Initielles Verzeichnis als Voreinstellung für den Dialog oder leer. Kann einen kompletten Dateipfad enthalten oder leer sein. |
options.parentHandle? | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. DefaultValue: 0 |
Rückgabewert
Promise<CRMDialogResult<string>>
Enthält den ausgewählten Dateipfad in CRMDialogResult.value. Bei Benutzerabbruch ist CRMDialogResult.isCanceled gesetzt.
dialogSelectStringAsync()
dialogSelectStringAsync(
message,
choices,
options?): Promise<CRMDialogResult<string[]>>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:733
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. |
options? | { allowFilter?: boolean; allowMultiSelect?: boolean; parentHandle?: number; profileKey?: string; sortChoices?: SortOrderChoices; } | Optionen DialogSelectStringOptions |
options.allowFilter? | boolean | Suche innerhalb der Auflistung der Einträge ermöglichen DefaultValue: true |
options.allowMultiSelect? | boolean | Gibt an ob eine Mehrfachauswahl von Einträgen möglich sein soll. DefaultValue: true |
options.parentHandle? | number | Handle eines Fensters, das als Parent-Fenster für den Dialog verwendet werden soll. DefaultValue: 0 |
options.profileKey? | string | 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 |
options.sortChoices? | SortOrderChoices | Sortierung der Einträge DefaultValue: SortOrderChoices.None |
Rückgabewert
Promise<CRMDialogResult<string[]>>
Enthält ein Array der ausgewählten Strings in CRMDialogResult.value. Bei Benutzerabbruch ist CRMDialogResult.isCanceled gesetzt.
encryptAsync()
encryptAsync(input, key): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:983
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
endWaitDlgAsync()
endWaitDlgAsync(): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:792
Blendet einen zuvor mit StartWaitDlg angezeigten Wartedialog aus.
Rückgabewert
Promise<void>
fetchGlobalConfigFileAsync()
fetchGlobalConfigFileAsync(sourceFilePath, targetFilePath): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:805
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
getIniProfileStringAsync()
getIniProfileStringAsync(
section,
property,
defaultValue,
iniFile): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:818
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
getOptionStringAsync()
getOptionStringAsync(
optionName,
reserved,
parentHandle?): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1007
Parameter
| Parameter | Type |
|---|---|
optionName | string |
reserved | string |
parentHandle? | number |
Rückgabewert
Promise<string>
getTickCountAsync()
getTickCountAsync(): Promise<number>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1012
Rückgabewert
Promise<number>
getTimeStampAsync()
getTimeStampAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1017
Rückgabewert
Promise<string>
invokeMenuAsync()
invokeMenuAsync(menuId, synchronous): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:829
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
loginAsync()
loginAsync(
projectFilePath,
userName,
password): Promise<Project>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:846
Ö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>
performanceCounterCreateAsync()
performanceCounterCreateAsync(counterName): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:855
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>
performanceCounterHitAsync()
performanceCounterHitAsync(counterName, additionalInfo?): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:869
Gibt eine Messung der vergangenen Zeit in Millisekunden seit dem Aufruf von performanceCounterCreate 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>
sendMailAsync()
sendMailAsync(
subject,
contents,
options?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:882
Sendet eine eMail über die MAPI-Schnittstelle, unabhängig von den Record oder RecordSet Objekten.
Parameter
| Parameter | Type | Description |
|---|---|---|
subject | string | Betreff der eMail. |
contents | string | Text der eMail. |
options? | { bccEmailAddresses?: string[]; ccEmailAddresses?: string[]; files?: string[]; showDialog?: boolean; toEmailAddresses?: string[]; } | Optionen SendMailOptions |
options.bccEmailAddresses? | string[] | BCC E-Mail-Adressen |
options.ccEmailAddresses? | string[] | CC E-Mail-Adressen |
options.files? | string[] | Liste von eMail-Anhängen. |
options.showDialog? | boolean | Gibt an ob der Dialog angezeigt wird Voreinstellung: true |
options.toEmailAddresses? | string[] | Empfänger E-Mail-Adressen |
Rückgabewert
Promise<boolean>
setDBConnectInfoAsync()
setDBConnectInfoAsync(
dbServer,
dbUser,
dbPwd,
windowsAuth,
dbSystem): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1037
Parameter
| Parameter | Type |
|---|---|
dbServer | string |
dbUser | string |
dbPwd | string |
windowsAuth | boolean |
dbSystem | number |
Rückgabewert
Promise<void>
setDoRestartAsync()
setDoRestartAsync(projectToLoadNextTime): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1043
Parameter
| Parameter | Type |
|---|---|
projectToLoadNextTime | string |
Rückgabewert
Promise<void>
setIniProfileStringAsync()
setIniProfileStringAsync(
section,
property,
value,
iniFile): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:935
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>
setOptionStringAsync()
setOptionStringAsync(
optionName,
value,
options?): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1022
Parameter
| Parameter | Type |
|---|---|
optionName | string |
value | string |
options? | { parentHandle?: number; reserved?: string; } |
options.parentHandle? | number |
options.reserved? | string |
Rückgabewert
Promise<void>
setVisibleAsync()
setVisibleAsync(value): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:274
Setzt den Anzeigezustand der Anwendung.
Standardmäßig ist beim Zugriff per COM der Anzeigezustand der Anwendung unsichtbar (false)
Parameter
| Parameter | Type |
|---|---|
value | boolean |
Rückgabewert
Promise<void>
setWaitDialogTextAsync()
setWaitDialogTextAsync(text): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:946
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>
startWaitDlgAsync()
startWaitDlgAsync(
text,
cancelable,
initialDelay): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:959
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 | Default value | Description |
|---|---|---|---|
text | string | undefined | Der anzuzeigende Informationstext |
cancelable | boolean | undefined | Anzeige einer Schaltfläche "Abbrechen" |
initialDelay | number | 3 | 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>
storeGlobalConfigFileAsync()
storeGlobalConfigFileAsync(sourceFilePath, targetFilePath): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:972
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
createAsync()
static createAsync(coreCRM?): Promise<CRMApplication>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:131
Parameter
| Parameter | Type |
|---|---|
coreCRM? | CRMApplication |
Rückgabewert
Promise<CRMApplication>