RecordSet
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7142
Extends
ExtendedCRMObjectBase<RecordSet>
Implementiert
Iterable<Record>
Eigenschaften
_instance
protected _instance: RecordSet;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:12
Abgeleitet von
ExtendedCRMObjectBase._instance
className
protected readonly className: string;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:16
Abgeleitet von
ExtendedCRMObjectBase.className
currentRecordAsync
Abfragesignatur
get currentRecordAsync(): Promise<Record>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7263
Liefert den aktuellen Datensatz als Objekt vom Typ Record zurück.
Rückgabewert
Promise<Record>
hasMultipleRecordsAsync
Abfragesignatur
get hasMultipleRecordsAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7164
Gibt true zurück, wenn das RecordSet mehr als einen Datensatz beinhaltet.
Diese Methode ist deutlich effizienter als die Abfrage von RecordSet.recCount, insofern bei einem Filter genau ein Treffer erwartet wird, aber auch der Fall mit mehreren Treffern sauber behandelt werden soll.
Rückgabewert
Promise<boolean>
recCountAsync
Abfragesignatur
get recCountAsync(): Promise<number>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7175
Liefert die Anzahl der Datensätze im aktuellen RecordSet Objekt zurück.
Sollte das RecordSet Objekt zuvor gefiltert worden sein, dann wird die Anzahl der im Filter befindlichen Datensätze zurückgeliefert. Ohne aktiven Filter erhält man die Gesamtzahl der Datensätze.
Rückgabewert
Promise<number>
sortOrderAsync
Abfragesignatur
get sortOrderAsync(): Promise<number>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7186
Gibt die aktuell gesetzte Sortierung zurück
0 = keine Sortierung
Rückgabewert
Promise<number>
viewNameAsync
Abfragesignatur
get viewNameAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7209
Gibt den Namen des übergeordneten View Objektes zurück.
Rückgabewert
Promise<string>
Konstruktoren
Konstruktor
new RecordSet(
recordSet,
combitCRMVersion,
disposeInstance): RecordSet;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7146
Parameter
| Parameter | Type | Default value |
|---|---|---|
recordSet | RecordSet | undefined |
combitCRMVersion | number | CRMVersion | undefined |
disposeInstance | boolean | true |
Rückgabewert
RecordSet
Überschreibt
ExtendedCRMObjectBase<CoreCRM.RecordSet>.constructor
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:93
Rückgabewert
Promise<void>
Abgeleitet von
ExtendedCRMObjectBase.[asyncDispose]
[dispose]()
dispose: void;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:88
Rückgabewert
void
Abgeleitet von
ExtendedCRMObjectBase.[dispose]
[iterator]()
iterator: IterableIterator<Record>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8212
Rückgabewert
IterableIterator<Record>
Implementierung von
Iterable.[iterator]
calcAggregationValuesAsync()
calcAggregationValuesAsync(sqlexpression): Promise<DataItem>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7226
Erlaubt die Berechnung von Aggregationsergebnissen basierend auf dem aktuellen Filter.
Parameter
| Parameter | Type | Description |
|---|---|---|
sqlexpression | string | Übergabe des SQL-Ausdrucks. Ergebnis sollten Spalten sein, die beispielsweise auch bei der Nutzung von SELECT den Rückgabewert darstellen. Etwaige Spaltendatentypen bleiben, soweit möglich, erhalten. Unbenannte Spaltennamen ohne Alias erhalten die Namen $Field1 bis $FieldN. |
Rückgabewert
Promise<DataItem>
Example
const item = calcAggregationValues("count(1) as Counter, min(\"Birthday\") as Oldest, max(\"Birthday\") as Youngest");
createCopyAsync()
createCopyAsync(mode): Promise<RecordSet>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7246
Erstellt eine Kopie des aktuellen RecordSet Objekts, um dieses beispielsweise per Filter weiter einzugrenzen, ohne dafür das zugrundeliegende RecordSet Objekt verändern zu müssen.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
mode | CRMCursorMode | CRMCursorMode.SolutionDefault | Optional Voreinstellung: CRMCursorMode.SolutionDefault- Ermöglicht die Spezifikation des Datenbankcursormodells, das für den zurückgegebenen RecordSet genutzt werden soll. CRMCursorMode.ForwardOnly ist das schnellste Model, hierbei gilt jedoch die Einschränkung das keine Verzögerung durch zum Beispiel Dialoge, MessageBoxen, Mailversand oder Druck bei der Iteration über das RecordSet stattfinden darf. Für diese Anwendungsfälle empfiehlt es sich CRMCursorMode.FullDynamic zu setzen |
Rückgabewert
Promise<RecordSet>
currentRecordBufferedAsync()
currentRecordBufferedAsync(): Promise<Record>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8114
Liefert den aktuellen Datensatz als Objekt vom Typ Record zurück. Diese Methode funktioniert nur, wenn zuvor über eine der Move...-Methoden auf einen gültigen Datensatz gesprungen wurde.Wenn z.B.keine Datensätze im RecordSet enthalten sind, liefert diese Methode kein Record Objekt zurück.
Rückgabewert
Promise<Record>
currentRecordSynchronizedAsync()
currentRecordSynchronizedAsync(): Promise<Record>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8133
Liefert den aktuellen Datensatz als Objekt vom Typ Record zurück. Wenn z. B. keine Datensätze im RecordSet enthalten sind, liefert diese Methode kein Record Objekt zurück.
Rückgabewert
Promise<Record>
Deprecated
Diese Eigenschaft ist aus Kompatibilitätsgründen enthalten, siehe die Methode CurrentRecord für den empfohlenen Weg
deleteAllRecordsAsync()
deleteAllRecordsAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7281
Löscht alle Datensätze im Filter des aktuellen RecordSet-Objektes
Rückgabewert
Promise<boolean>
dialogEditFormulaAsync()
dialogEditFormulaAsync(
windowTitle,
formula,
options?): Promise<CRMDialogResultExt<string>>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7294
Stellt den Formel-Assistenten basierend auf den Feldern des aktuellen RecordSet dar
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Titel des Dialogs inklusive des Anhangs" bearbeiten". Wenn eine leere Zeichenkette übergeben wird, wird "Formel bearbeiten" verwendet. |
formula | string | Zu bearbeitende Formel |
options? | { allowedResultType?: FormulaResultType; parentHandle?: number; useRealData?: boolean; } | Optionale Optionen |
options.allowedResultType? | FormulaResultType | Voreinstellung: FormulaResultType.Numeric |
options.parentHandle? | number | Voreinstellung: Aktuell aktives cRMFenster Ermöglicht die Übergabe eines Handles für das Elternfenster |
options.useRealData? | boolean | Voreinstellung: false true - Es wird in der Formelergebnis-Vorschau mit den aktuellen Werten des aktuellen Datensatzes gearbeitet. false - Es werden keine Echtdaten verwendet. |
Rückgabewert
Promise<CRMDialogResultExt<string>>
dialogFilterAssistantAsync()
dialogFilterAssistantAsync(
windowTitle,
filterStatementFile,
options?): Promise<CRMDialogResultExt<string>>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7340
Stellt den Dialog des Filter-Assistenten dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
options? | { disableAskString?: boolean; parentHandle?: number; } | Optional Optionen |
options.disableAskString? | boolean | Voreinstellung: false Benutzereingabe als Filter-Element wird nicht angeboten. |
options.parentHandle? | number | Voreinstellung: Aktuell aktives cRMFenster Ermöglicht die Übergabe eines Handles für das Elternfenster |
Rückgabewert
Promise<CRMDialogResultExt<string>>
dialogFilterGeneralAsync()
dialogFilterGeneralAsync(
windowTitle,
filterStatementFile,
options?): Promise<CRMDialogResultExt<string>>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7379
Stellt den Dialog des Filter-Allgemein dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
options? | { disableAskString?: boolean; parentHandle?: number; } | Optional Optionen |
options.disableAskString? | boolean | Voreinstellung: false Benutzereingabe als Filter-Element wird nicht angeboten. |
options.parentHandle? | number | Voreinstellung: Aktuell aktives cRMFenster Ermöglicht die Übergabe eines Handles für das Elternfenster |
Rückgabewert
Promise<CRMDialogResultExt<string>>
dialogFilterSQLQueryAsync()
dialogFilterSQLQueryAsync(
windowTitle,
filterStatementFile,
options): Promise<CRMDialogResultExt<string>>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7418
Stellt den Dialog des Filter-SQL-Abfrage dar. Es besteht die Möglichkeit eine .crmshare-Datei zu übergeben, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Als Rückgabewert erhält man eine .crmshare-Datei, welche den zusammengestellten Filterausdruck enthält. Das anschließende Bereinigen der erstellten .crmshare-Datei wird nicht vom cRM durchgeführt.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
filterStatementFile | string | Pfad zu einer .crmshare-Datei, welche einen bereits erstellten, zum Dialog passenden, Filterausdruck enthält. Falls eine solche Datei nicht vorhanden ist kann eine leere Zeichenkette übergeben werden. |
options | { disableAskString?: boolean; parentHandle?: number; } | Optionale Optionen |
options.disableAskString? | boolean | Voreinstellung: false Benutzereingabe als Filter-Element wird nicht angeboten. |
options.parentHandle? | number | Voreinstellung: Aktuell aktives cRMFenster Ermöglicht die Übergabe eines Handles für das Elternfenster |
Rückgabewert
Promise<CRMDialogResultExt<string>>
dialogSelectRecordAsync()
dialogSelectRecordAsync(windowTitle, options?): Promise<Record>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7456
Ermöglicht die Auswahl eines Datensatzes basierend auf dem aktuellen Filter des RecordSet Objektes. Das Ergebnis ist ein Objekt vom Typ Record.
Wenn kein Datensatz ausgewählt wurde, wird null zurückgegeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | Fenster Titel. Aktuell reserviert |
options? | { allowUserDefinedSortOrder?: boolean; parentHandle?: number; } | Optionale Optionen |
options.allowUserDefinedSortOrder? | boolean | Voreinstellung: false |
options.parentHandle? | number | Voreinstellung: Aktuell aktives cRMFenster Ermöglicht die Übergabe eines Handles für das Elternfenster |
Rückgabewert
Promise<Record>
dialogSelectRecordMultipleAsync()
dialogSelectRecordMultipleAsync(windowTitle, options?): Promise<RecordSet>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7484
Parameter
| Parameter | Type | Description |
|---|---|---|
windowTitle | string | - |
options? | { allowUserDefinedSortOrder?: boolean; parentHandle?: number; } | - |
options.allowUserDefinedSortOrder? | boolean | Voreinstellung: false |
options.parentHandle? | number | Voreinstellung: Aktuell aktives cRMFenster Ermöglicht die Übergabe eines Handles für das Elternfenster |
Rückgabewert
Promise<RecordSet>
dispose()
dispose(): void;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:72
Rückgabewert
void
Abgeleitet von
ExtendedCRMObjectBase.dispose
disposeAsync()
disposeAsync(): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:56
Rückgabewert
Promise<void>
Abgeleitet von
ExtendedCRMObjectBase.disposeAsync
executeInstantReportByNameAsync()
executeInstantReportByNameAsync(name): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7516
Führt einen abgespeicherten Sofortbericht anhand seines Namens aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name des Sofortberichts. Groß- / Kleinschreibung wird beachtet! |
Rückgabewert
Promise<void>
exportAsync()
exportAsync(format): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7531
Startet den Export-Assistenten und führt das übergebene Benutzerformat aus. Es werden alle Einstellungen dieses Formates verwendet.
Parameter
| Parameter | Type | Description |
|---|---|---|
format | string | Name des Exportformates. Es kann sich dabei um einen kompletten Dateipfad auf eine .etp Format-Datei handeln, alternativ um den Formatnamen, so wie er im Assistenten dargestellt wird, dabei werden zuerst die benutzerspezifischen Formate durchsucht, anschließend die globalen Formate. Bitte beachten Sie die Großkleinschreibung. |
Rückgabewert
Promise<boolean>
findRecordByDupeCheckCriteriaAsync()
findRecordByDupeCheckCriteriaAsync(
recordId,
fieldContent1,
options?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7544
Führt den Online-Dublettencheck anhand der übergebenen Werte und den definierten Kriterien für Dubletten aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
recordId | string | ID des Datensatzes, welcher vom DublettenCheck ausgeschlossen werden soll. Wenn dieser Parameter leer übergeben wird, dann werden alle Datensätze einbezogen. |
fieldContent1 | string | Inhalt des ersten Kriteriums für den Dublettencheck. |
options? | { fieldContent2?: string; fieldContent3?: string; fieldContent4?: string; fieldContent5?: string; fieldContent6?: string; fieldContent7?: string; fieldContent8?: string; useCurrentQuery?: boolean; } | Optionale Optionen |
options.fieldContent2? | string | Inhalt des zweiten Kriteriums für den Dublettencheck. |
options.fieldContent3? | string | Inhalt des dritten Kriteriums für den Dublettencheck. |
options.fieldContent4? | string | Inhalt des vierten Kriteriums für den Dublettencheck. |
options.fieldContent5? | string | Inhalt des fünften Kriteriums für den Dublettencheck. |
options.fieldContent6? | string | Inhalt des sechsten Kriteriums für den Dublettencheck. |
options.fieldContent7? | string | Inhalt des siebten Kriteriums für den Dublettencheck. |
options.fieldContent8? | string | Inhalt des achten Kriteriums für den Dublettencheck. |
options.useCurrentQuery? | boolean | Voreinstellung: false gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
findRecordByEmailAsync()
findRecordByEmailAsync(
email,
reduceEmail,
useCurrentQuery): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7604
Sucht alle Datensätze, bei denen in einem eMail-Feld eine bestimmte eMail-Adresse vorhanden ist. Diese unscharfe Suche findet auch eMail-Adressen derselben Domain falls kein direkter Treffer vorhanden ist.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
email | string | undefined | Die eMail-Adresse, nach der in allen eMail-Feldern gesucht werden soll. |
reduceEmail | boolean | undefined | Wenn true, dann wird die eMail-Adresse schrittweise in bis zu vier Durchläufen durch Auslassen von Top-Level-Domain, Domain, Lokalteil gesucht, falls es nicht bereits Treffer gab. So können auch eMails unterschiedlicher Domains gefunden werden |
useCurrentQuery | boolean | false | Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
true - Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv.
findRecordByPhoneNumberAsync()
findRecordByPhoneNumberAsync(
phoneNumber,
reducePhoneNumber,
useCurrentQuery): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7618
Sucht alle Datensätze, bei denen in einem Telefon-Feld eine bestimmte Telefonnummer vorhanden ist, analog zur Rufnummernerkennung durch den phone manager.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
phoneNumber | string | undefined | Die Telefonnummer, nach der in allen Telefonfeldern gesucht werden soll. Die Telefonnummer darf telefonspez.Sonderzeichen wie zum Beispiel '/', '+', '-' enthalten |
reducePhoneNumber | boolean | undefined | Wenn true, dann wird die Telefonnummer schrittweise um bis zu 4 Stellen verkürzt, falls es nicht bereits Treffer gab.So können auch unterschiedliche Durchwahl-Nummern gefunden werden. |
useCurrentQuery | boolean | false | Optional Voreinstellung: true - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
true - Es gab Treffer, für das RecordSet ist nun der entsprechende Filter aktiv.
guardDisposed()
protected guardDisposed(): void;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:29
Wift einen Error, wenn die Instanz bereits freigegeben wurde.
Rückgabewert
void
Throws
Error wenn die Instanz bereits freigegeben wurde.
Abgeleitet von
ExtendedCRMObjectBase.guardDisposed
importAsync()
importAsync(format): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7631
Startet den Import-Assistenten und führt das übergebene Benutzerformat aus. Es werden alle Einstellungen dieses Formates verwendet.
Parameter
| Parameter | Type | Description |
|---|---|---|
format | string | Name des Importformates. Es kann sich dabei um einen kompletten Dateipfad auf eine .itp Format-Datei handeln, alternativ um den Formatnamen, so wie er im Assistenten dargestellt wird, dabei werden zuerst die benutzerspezifischen Formate durchsucht, anschließend die globalen Formate. Bitte beachten Sie die Großkleinschreibung. |
Rückgabewert
Promise<boolean>
isDisposed()
isDisposed(): boolean;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:51
Gibt an, ob die Instanz bereits freigegeben wurde.
Rückgabewert
boolean
true wenn die Instanz bereits freigegeben wurde, andernfalls false.
Abgeleitet von
ExtendedCRMObjectBase.isDisposed
moveFirstAsync()
moveFirstAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7642
Bewegt den Datensatz-Zeiger auf den ersten Record des RecordSet.
Rückgabewert
Promise<boolean>
true wenn der Pointer auf den ersten Datensatz(Record) gewechselt werden konnte, andernfalls false.
moveLastAsync()
moveLastAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7653
Bewegt den Datensatz-Zeiger auf den letzten Record des RecordSet.
Rückgabewert
Promise<boolean>
true wenn der Pointer auf den letzten Datensatz(Record) gewechselt werden konnte, andernfalls false.
moveNextAsync()
moveNextAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7664
Bewegt den Datensatz-Zeiger um einen Datensatz(Record) vorwärts.
Rückgabewert
Promise<boolean>
true wenn der Pointer auf den nächsten Datensatz(Record) gewechselt werden konnte, andernfalls false.
movePreviousAsync()
movePreviousAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7678
Bewegt den Datensatz-Zeiger um einen Datensatz(Record) rückwärts.
Rückgabewert
Promise<boolean>
true wenn der Pointer auf den vorherigen Datensatz(Record) gewechselt werden konnte, andernfalls false.
Deprecated
Diese Methode sollte aus Performance Gründen nicht mehr verwendet werden.
Remarks
(combit CRM 12.000) Diese Methode steht nicht zur Verfügung wenn das RecordSet mit CRMCursorMode.ForwardOnly erzeugt wurde.
newRecordAsync()
newRecordAsync(): Promise<Record>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7689
Erzeugt einen neuen Datensatz und liefert diesen als Objekt vom Typ Record zurück.
Rückgabewert
Promise<Record>
printCardAsync()
printCardAsync(
media,
fileName,
silent,
range,
options?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7712
Druckt ein Karteikartenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | PrintOutputMedia | Ausgabemedium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
range | boolean | true: Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false: Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck |
options? | { exportOptions?: string; outputFileName?: string; useModalPreviewWindow?: boolean; } | Optionale Optionen |
options.exportOptions? | string | Export-Optionen für Print-Methoden siehe SDK |
options.outputFileName? | string | Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden. |
options.useModalPreviewWindow? | boolean | Voreinstellung: true Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht(false). |
Rückgabewert
Promise<boolean>
printLabelAsync()
printLabelAsync(
media,
fileName,
silent,
range,
options?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7753
Druckt ein Etikettenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | PrintOutputMedia | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
range | boolean | true: Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false: Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck |
options? | { exportOptions?: string; outputFileName?: string; useModalPreviewWindow?: boolean; } | Optionale Optionen |
options.exportOptions? | string | Export-Optionen für Print-Methoden siehe SDK |
options.outputFileName? | string | Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden. |
options.useModalPreviewWindow? | boolean | Voreinstellung: true Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht(false). |
Rückgabewert
Promise<boolean>
printReportAsync()
printReportAsync(
media,
fileName,
silent,
range,
options?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7794
Druckt ein Listenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | PrintOutputMedia | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
range | boolean | true: Es werden alle Datensätze im aktuellen Filter/Datenbank ausgegeben, entspricht dem Seriendruck. false: Es wird nur der aktuelle Datensatz ausgegeben, entspricht dem Einzeldruck |
options? | { exportOptions?: string; outputFileName?: string; useModalPreviewWindow?: boolean; } | Optionale Optionen |
options.exportOptions? | string | Export-Optionen für Print-Methoden siehe SDK |
options.outputFileName? | string | Evtl. Name und Pfad der zu erzeugenden Ausgabe-Datei bei Ausgabe-Medien wie z.B. "RTF" oder "HTML". In allen anderen Fällen kann ein leerer String übergeben werden. |
options.useModalPreviewWindow? | boolean | Voreinstellung: true Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht(false). |
Rückgabewert
Promise<boolean>
recCountWithoutGeoCoordinatesAsync()
recCountWithoutGeoCoordinatesAsync(aliasName): Promise<number>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7830
Gibt die Anzahl der unkodierten Datensätze für eine Adress-Definition zurück. Die Geokodierung der Adresse ist Voraussetzung für den Umkreis-Filter, siehe auch RecordSet.setFilterByGeo.
Parameter
| Parameter | Type | Description |
|---|---|---|
aliasName | string | Name der Adresse (siehe Ansichtskonfiguration > Adressen) |
Rückgabewert
Promise<number>
relationalAppendAsync()
relationalAppendAsync(name): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7843
Führt eine abgespeicherte Vorlage für relationales Ergänzen über den Namen aus. Diese kann über den Menüpunkt Organisieren > Relational Ergänzen > Allgemein erzeugt werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name der abgespeicherten Vorlage. Hinweis: Bitte beachten Sie, dass nicht die Bezeichnung des Filterausdrucks verwendet wird, sondern der 'Name für Scripte' |
Rückgabewert
Promise<boolean>
relationalAppendDirectAsync()
relationalAppendDirectAsync(relation, parameter): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7857
Direktes relationales Ergänzen in einer Relationsansicht. Die Übergabe der Werte erfolgt in folgendem Format:
{FeldName1}={Inhalt/Formel1}\t{FeldName2}={Inhalt/Formel2}\t...
Parameter
| Parameter | Type | Description |
|---|---|---|
relation | Relation | Relationsobjekt |
parameter | string | Wertepaar |
Rückgabewert
Promise<boolean>
sendBulkMailAsync()
sendBulkMailAsync(
templatePath,
errorTagFilePath,
options?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7875
Sendet eine Serien-eMail. Der Mailversand über diese Methode verhält sich analog zum Serien-Mailversand in der Anwendung.
Parameter
| Parameter | Type | Description |
|---|---|---|
templatePath | string | Pfad zur Mailvorlage |
errorTagFilePath | string | Pfad zur .tag-Datei für manuelles Filtern. Diese wird erstellt, wenn es im RecordSet Datensätze mit leeren eMail-Feldern gibt und enthält alle diese Datensätze. Falls ein leerer String übergeben wird, wird eine Datei im temp-Verzeichnis mit Standardnamen angelegt. |
options? | { files: string[]; mailsSentTagFilePath?: string; showDialog?: boolean; silent?: boolean; } | Optionale Optionen |
options.files? | string[] | - |
options.mailsSentTagFilePath? | string | |
options.showDialog? | boolean | Voreinstellung: false |
options.silent? | boolean | Voreinstellung: false Wenn true, Hinweisdialoge werden ausgeblendet |
Rückgabewert
Promise<boolean>
sendMailDialogAsync()
sendMailDialogAsync(
subject,
content,
options?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7909
Sendet eine eMail. Der Mailversand über diese Methode verhält sich analog zum Kontextmenü.
Parameter
| Parameter | Type | Description |
|---|---|---|
subject | string | Betreff der eMail |
content | string | Text der eMail |
options? | { bccEmailAddresses?: string[]; ccEmailAddresses?: string[]; files?: string[]; toEmailAddresses?: string[]; } | Optionale Optionen |
options.bccEmailAddresses? | string[] | BCC E-Mail-Adressen |
options.ccEmailAddresses? | string[] | CC E-Mail-Adressen |
options.files? | string[] | Liste von eMail-Anhängen. |
options.toEmailAddresses? | string[] | Empfänger E-Mail-Adressen |
Rückgabewert
Promise<boolean>
sendMapiMailAsync()
sendMapiMailAsync(
subject,
content,
options?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7950
Sendet eine eMail über die MAPI-Schnittstelle.
Parameter
| Parameter | Type | Description |
|---|---|---|
subject | string | Betreff der eMail |
content | string | Text der eMail |
options? | { bccEmailAddresses?: string[]; ccEmailAddresses?: string[]; files?: string[]; showDialog?: boolean; toEmailAddresses?: string[]; } | Optionale Optionen |
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 | Voreinstellung: true Gibt an ob der Dialog angezeigt wird |
options.toEmailAddresses? | string[] | Empfänger E-Mail-Adressen |
Rückgabewert
Promise<boolean>
setFilterAsync()
setFilterAsync(filter, useCurrentQuery): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7998
Erstellt einen Filter auf Basis des übergebenen Filter-Ausdruckes.
Der Filter kann immer nur für die jeweilige Ansicht/RecordSet ausgeführt werden.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
filter | string | undefined | Filterausdruck, entspricht den Formeln unter Filtern > Allgemein. Weitere Informationen finden Sie dort. |
useCurrentQuery | boolean | false | Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
setFilterByCurrentSortOrderAsync()
setFilterByCurrentSortOrderAsync(
filterContents,
searchType,
caseSensitive,
useCurrentQuery?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8156
Erzeugt einen Filter basierend auf den Feldern der aktuellen Sortierung.
Parameter
| Parameter | Type | Description |
|---|---|---|
filterContents | string | Filterausdruck |
searchType | SearchType | Suchtyp SearchType |
caseSensitive | CaseSensitive | Groß-/Kleinschreibung CaseSensitive |
useCurrentQuery? | boolean | Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
setFilterByFieldNameAsync()
setFilterByFieldNameAsync(
fieldName,
contents,
searchType,
caseSensitive,
useCurrentQuery?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8172
Setzt einen Filter anhand eines Feldinhalts.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Name des Feldes bzw. mehrere Felder, welche mittels "+" getrennt angegeben werden. Hierbei können auch 1:1-relational oder 1:1:1 relational verknüpfte Felder angegeben werden.Bei 1:1(:1) verknüpften relationalen Feldern muss der vollständige relationale Pfad verwendet werden, z. B. "CompanyID.Firmen.ID.Company". |
contents | string | Suchbegriff(e). Suchbegriffe für mehrere Felder werden per Leerzeichen-Separator übergeben.Wenn ein Suchbegriff ein Leerzeichen enthalten soll, dann werden die Suchbegriffe mit einem Komma getrennt.Das Komma kann zudem verwendet werden, um ein Suchfeld (siehe Parameter fieldName ) auszulassen |
searchType | SearchType | Suchtyp SearchType |
caseSensitive | CaseSensitive | Groß-/Kleinschreibung CaseSensitive |
useCurrentQuery? | boolean | Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
setFilterByGeoAsync()
setFilterByGeoAsync(
filterType,
filterOperation,
notGeocodedRecordAction,
multipleResultAction,
aliasName,
address,
distance,
useCurrentQuery): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8017
Setzt einen Filter anhand eines bestimmten geographischen Punktes.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
filterType | LinearDistance | undefined | Gibt den Suchtyp an |
filterOperation | GeoFilterOperation | undefined | Gibt den Filtertyp an |
notGeocodedRecordAction | NotGeocodedRecordAction | undefined | Wie sollen für die Umkreissuche unkodierte Datensätze behandelt werden |
multipleResultAction | GeoMultipleResultAction | undefined | Gibt die Aktion an wenn mehrere Ergebnisse zurückgeliefert werden |
aliasName | string | undefined | Name der Feldliste der Adresse |
address | string | undefined | Adresse des Umkreispunkt |
distance | number | undefined | Umkreis in Kilometern, in dem gesucht werden soll |
useCurrentQuery | boolean | false | Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
setFilterByNameAsync()
setFilterByNameAsync(filterName, useCurrentQuery): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8032
Führt einen abgespeicherten Filterausdruck über den Namen aus.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
filterName | string | undefined | Name des abgespeicherten Filters. Hinweis: Bitte beachten Sie, dass nicht die Bezeichnung des Filterausdrucks verwendet wird, sondern der 'Name für Scripte'. Alternativ kann der vollständige Pfad zu einer .crmshare-Datei, welche einen Filterausdruck beinhaltet, angegeben werden.Diese Datei kann über die Funktion „Filter teilen“ erstellt werden |
useCurrentQuery | boolean | false | Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
setFilterByPrimaryKeyAsync()
setFilterByPrimaryKeyAsync(primaryKeyContent): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8045
Setzt einen Filter basierend auf dem Primärschlüssel des RecordSets.
Diese Methode funktioniert nur, wenn ein Primärschlüssel vorhanden ist, der genau aus einem Feld besteht.
Parameter
| Parameter | Type | Description |
|---|---|---|
primaryKeyContent | string | Inhalt des Primärschlüsselfeldes. |
Rückgabewert
Promise<boolean>
setFilterByTagFileAsync()
setFilterByTagFileAsync(tagFilePath, options): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8185
Setzt und aktiviert einen manuellen Filter basierend auf einer Datei für eine manuelle Datensatzauswahl (.tag Datei).
Parameter
| Parameter | Type | Description |
|---|---|---|
tagFilePath | string | Pfad zur .tag-Datei |
options | { manFltCombineOption?: ManFltCombineOption; useCurrentQuery?: boolean; } | Optionale Optionen |
options.manFltCombineOption? | ManFltCombineOption | Bestimmt wie die Datensatzauswahl mit einem bereits bestehenden manuellen Filter kombiniert werden soll. |
options.useCurrentQuery? | boolean | Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
setFilterDirectSqlAsync()
setFilterDirectSqlAsync(sqlQuery, useCurrentQuery): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8058
Erstellt einen Filter auf Basis des übergebenen freien Filterausdruckes.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
sqlQuery | string | undefined | Freier SQL Filterausdruck. |
useCurrentQuery | boolean | false | Vorreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
setFilterDynamicAsync()
setFilterDynamicAsync(
type,
filter,
useCurrentQuery): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8072
Erstellt einen Filter auf Basis des übergebenen Filterausdrucks je nach Filtertyp.
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
type | RecordSetFilterType | undefined | Filtertyp |
filter | string | undefined | Filterausdruck |
useCurrentQuery | boolean | false | Voreinstellung: false - gibt an, ob lediglich innerhalb des aktuellen Filters gesucht werden soll. |
Rückgabewert
Promise<boolean>
setSortOrderAsync()
setSortOrderAsync(value): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:7197
Gibt die aktuell gesetzte Sortierung zurück
0 = keine Sortierung
Parameter
| Parameter | Type |
|---|---|
value | number |
Rückgabewert
Promise<void>
synchronizeAsync()
synchronizeAsync(format): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:8103
Startet den Abgleich-Assistenten und führt das übergebene Benutzerformat aus. Es werden alle Einstellungen dieses Formates verwendet.
Parameter
| Parameter | Type | Description |
|---|---|---|
format | string | Name des Abgleichformates. Es kann sich dabei um einen kompletten Dateipfad auf eine .itp Format-Datei handeln, alternativ um den Formatnamen, so wie er im Assistenten dargestellt wird, dabei werden zuerst die benutzerspezifischen Formate durchsucht, anschließend die globalen Formate. Bitte beachten Sie die Großkleinschreibung. |
Rückgabewert
Promise<boolean>