Record
Datensatz
Implementiert
AsyncDisposableDisposable
Eigenschaften
Deletable
get Deletable(): boolean
Über diese Eigenschaft kann geprüft werden, ob ein Datensatz aufgrund von Datensatzrechten löschbar wäre.
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8495
Editable
get Editable(): boolean
Über diese Eigenschaft kann geprüft werden, ob ein Datensatz aufgrund von Datensatzrechten bearbeitbar wäre.
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8504
IsDisposed
get IsDisposed(): boolean
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8510
Methoden
AddToBlacklist()
AddToBlacklist(fieldName): boolean
Nimmt den Inhalt des übergebenen Feldes in die Sperrliste auf. Dabei wird die zugehörige Auto-Protokoll Aktion "In Sperrliste aufnehmen" ausgelöst.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Feldname, dessen Inhalt in die Sperrliste aufgenommen werden soll. |
Rückgabewert
boolean
false wenn der Inhalt nicht in die Sperrliste aufgenommen werden konnte weil z.B. der interne Feldtyp nicht unterstützt wird, andernfalls true
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8536
AddToFavorites()
AddToFavorites(): boolean
Fügt den aktuellen Datensatz den Favoriten hinzu.
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8545
AddToHistory()
AddToHistory(): boolean
Fügt den aktuellen Datensatz dem Verlauf hinzu.
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8554
AddToPhoneManager()
AddToPhoneManager(fieldName): boolean
Fügt den aktuellen Datensatz dem phone manager hinzu.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Feldname mit der Nummer, die hinzugefügt werden soll. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8564
Delete()
Delete(): boolean
Löscht einen Datensatz.
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8573
DialNumber()
DialNumber(fieldName): boolean
Wählt die übergebene Telefonnummer und entspricht insofern der manuellen Wahl.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Feldname mit der zu wählenden Nummer |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8583
Dispose()
Dispose(): void
Standardimplementierung des Dispose
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:9015
DisposeAsync()
DisposeAsync(): Promise<void>
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:9004
GetContentsByFormula()
GetContentsByFormula(formula): string
Liefert das Ergebnis einer Formel auf Basis des aktuellen Datensatzes zurück. Die Felder des Datensatzes stehen dabei als Variablen zur Verfügung.
Parameter
| Parameter | Type | Description |
|---|---|---|
formula | string | Auszuwertende Formel. |
Rückgabewert
string
Inhalt des Feldes oder '' (Leere Zeichenfolge) wenn das Feld nicht vorhanden ist
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8595
GetContentsByName()
GetContentsByName(name): string
Liefert den Inhalt des Feldes als Zeichenkette zurück, dessen physikalischer Feldname übergeben wurde.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Physikalischer Name des gewünschten Feldes. |
Rückgabewert
string
Inhalt des Feldes oder '' (Leere Zeichenfolge) wenn das Feld nicht vorhanden ist
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8607
GetContentsByNameToFile()
GetContentsByNameToFile(name, file): boolean
Das angegebene BLOB-Feld wird ausgelesen und dessen Inhalt unter dem angegebenen Dateinamen gespeichert.
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Physikalischer Name des gewünschten (BLOB)-Feldes |
file | string | Speicherpfad der angelegten Datei. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8618
GetContentsValueByFormula()
GetContentsValueByFormula(formula): unknown
Liefert das Ergebnis einer Formel auf Basis des aktuellen Datensatzes entsprechend des zurückgelieferten Datentyps der Formel zurück.Die Felder des Datensatzes stehen dabei als Variablen zur Verfügung.
Parameter
| Parameter | Type | Description |
|---|---|---|
formula | string | Auszuwertende Formel. |
Rückgabewert
unknown
Inhalt des Feldes oder null wenn die Formel ungültig ist
Example
const text = record.GetContentsValueByFormula("Email: <eMail>");
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8636
GetContentsValueByName()
GetContentsValueByName(fieldName): unknown
Liefert den Inhalt entsprechend des Feldtyps des Feldes zurück, dessen Feldname übergeben wurde, z.B. Datumzeit-Typen als Datumsvariable, numerische Typen als numerische Variable etc.Somit werden bspw. Lokalisierungsprobleme (Komma oder Punkt als Dezimalzeichen? Datumsformatierung?) bei der Weiterverarbeitung des Wertes vermieden.
Parameter
| Parameter | Type |
|---|---|
fieldName | string |
Rückgabewert
unknown
Inhalt des Feldes oder null wenn das Feld nicht vorhanden ist
Example
const dateValue = record.GetContentsValueByName("Datumsfeld");
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8653
GetRecordRefDescription()
GetRecordRefDescription(): string
Liefert die evaluierte Datensatzverweis-Formel für Kommentar/Betreff zurück. Im Fehlerfall wird ein leerer String zurückgeliefert.
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8662
GetRelationalRecordSet()
GetRelationalRecordSet(relationField): RecordSet
Liefert ein RecordSet aufgrund einer relationalen Struktur zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
relationField | string | Bezeichnung der Relation, z.B. |
Rückgabewert
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8672
Lock()
Lock(): boolean
Sperrt den aktuellen Datensatz für die Bearbeitung durch andere Benutzer und sollte vor dem Ändern eines Datensatzes durch SetContents...aufgerufen werden.
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8689
PrintCard()
PrintCard(media, fileName, silent, outputFileName)
PrintCard(
media,
fileName,
silent,
outputFileName): boolean
Druckt ein Karteikartenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
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. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8702
PrintCard(media, fileName, silent, outputFileName, useModalPreviewWindow)
PrintCard(
media,
fileName,
silent,
outputFileName,
useModalPreviewWindow): boolean
Druckt ein Karteikartenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
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. |
useModalPreviewWindow | boolean | Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ). |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8713
PrintLabel()
PrintLabel(media, fileName, silent, outputFileName)
PrintLabel(
media,
fileName,
silent,
outputFileName): boolean
Druckt ein Etikettenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
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. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8736
PrintLabel(media, fileName, silent, outputFileName, useModalPreviewWindow)
PrintLabel(
media,
fileName,
silent,
outputFileName,
useModalPreviewWindow): boolean
Druckt ein Etikettenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
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. |
useModalPreviewWindow | boolean | Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ). |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8747
PrintReport()
PrintReport(media, fileName, silent, outputFileName)
PrintReport(
media,
fileName,
silent,
outputFileName): boolean
Druckt ein Listenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
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. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8770
PrintReport(media, fileName, silent, outputFileName, useModalPreviewWindow)
PrintReport(
media,
fileName,
silent,
outputFileName,
useModalPreviewWindow): boolean
Druckt ein Listenprojekt aus. Neben dem Druckziel muss u.a. der Name des gewünschten Druckprojektes angegeben werden.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | string | Ausgabe-Medium |
fileName | string | Dateiname inkl. Pfad der Druckvorlage |
silent | boolean | Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
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. |
useModalPreviewWindow | boolean | Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ). |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8781
RemoveFromBlacklist()
RemoveFromBlacklist(fieldName): boolean
Entfernt den Inhalt des übergebenen Feldes aus der Sperrliste. Dabei wird die zugehörige Auto-Protokoll Aktion "Aus Sperrliste entfernen" ausgelöst.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Feldname, dessen Inhalt in die Sperrliste entfernt werden soll. |
Rückgabewert
boolean
false wenn der Inhalt nicht aus der Sperrliste entfernt werden konnte weil z.B. der interne Feldtyp nicht unterstützt wird, andernfalls true
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8803
Save()
Save(): boolean
Speichert einen mit Hilfe von SetContents... geänderten Datensatz in die Datenbank; zuvor sollte der Datensatz immer mit Lock() gesperrt werden.
Rückgabewert
boolean
true wenn der Datensatz gespeichert werden konnte, andernfalls false
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8814
SaveRecordRef()
SaveRecordRef(fileName): boolean
Speichert einen Datensatzverweis.
Parameter
| Parameter | Type | Description |
|---|---|---|
fileName | string | Pfad + Dateiname + Dateiendung des zu speichernden Adressverweises. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8824
SendMailDirect()
SendMailDirect(
eMailAddress,
subject,
contents,
files): boolean
Sendet eine eMail mit Anhang entsprechend den Einstellungen unter "Konfigurieren > Allgemein" ohne Benutzer-Interaktion. Die automatische eMail-Ablage wird bei dieser Methode aktiviert. Die eMail wird, sofern konfiguriert, im Kontext des aktuellen Datensatz hinterlegt, bzw. verknüpft.
Parameter
| Parameter | Type | Description |
|---|---|---|
eMailAddress | string | Empfänger eMail-Adresse |
subject | string | Betreff der eMail. |
contents | string | Text der eMail. |
files | string | Kann eine Liste von E-Mail-Anhängen beinhalten. Diese müssen dann per Semikolon separiert übergeben werden. Hinweis: Wenn in den allgemeinen Einstellungen "Mail per Kontextmenü über" auf "auf 'mailto:' registrierten Mail-Client" gestellt ist, hat dieser Parameter keine Auswirkung. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8838
SendRecordRef()
SendRecordRef(
emailAddress,
subject,
content): boolean
Sendet eine eMail mit dem Datensatzverweis des aktuellen Datensatzes.
Parameter
| Parameter | Type | Description |
|---|---|---|
emailAddress | string | Empfänger eMail-Adresse. |
subject | string | Betreff der eMail. |
content | string | Text der eMail. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8850
SendSingleMail()
SendSingleMail(templatePath)
SendSingleMail(templatePath): boolean
Sendet eine Einzelmail ohne Dialog. Es wird der vollständige Pfad der Vorlagedatei übergeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
templatePath | string | Vollständiger Pfad der Vorlagedatei. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8860
SendSingleMail(templatePath, files)
SendSingleMail(templatePath, files): boolean
Sendet eine Einzelmail ohne Dialog. Es wird der vollständige Pfad der Vorlagedatei übergeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
templatePath | string | Vollständiger Pfad der Vorlagedatei. |
files | string | Kann eine Liste von E-Mail-Anhängen beinhalten.Diese müssen dann per Semikolon separiert übergeben werden. Beachten Sie bitte, dass die übergebenen Anhänge stets zusätzlich zu den evtl. bereits in einer über den Parameter " templatePath " definierten Mailvorlage hinterlegten Anhängen versendet werden. Dies gilt auch dann, wenn ein übergebener eMail Anhang denselben Pfad hat wie in der Mailvorlage. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8869
SendSingleMailDialog()
SendSingleMailDialog(templatePath)
SendSingleMailDialog(templatePath): boolean
Sendet eine Einzelmail mit vorherigem Dialog. Es wird der vollständige Pfad der Vorlagedatei übergeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
templatePath | string | Vollständiger Pfad der Vorlagedatei. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8889
SendSingleMailDialog(templatePath, files)
SendSingleMailDialog(templatePath, files): boolean
Sendet eine Einzelmail mit vorherigem Dialog. Es wird der vollständige Pfad der Vorlagedatei übergeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
templatePath | string | Vollständiger Pfad der Vorlagedatei. |
files | string | Kann eine Liste von E-Mail-Anhängen beinhalten.Diese müssen dann per Semikolon separiert übergeben werden. Beachten Sie bitte, dass die übergebenen Anhänge stets zusätzlich zu den evtl. bereits in einer über den Parameter " templatePath " definierten Mailvorlage hinterlegten Anhängen versendet werden. Dies gilt auch dann, wenn ein übergebener eMail Anhang denselben Pfad hat wie in der Mailvorlage. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8898
SetContentsByFormula()
SetContentsByFormula(fieldName, formula): boolean
Legt den Inhalt des Feldes mit einer Formel fest, dessen Feldname übergeben wurde. Das Setzen eines Primärschlüssels ist möglich, sofern das Schreiben erlaubt ist.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Physikalischer Name des gewünschten Feldes. |
formula | string | Feldinhalt aus einer Formel. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8919
SetContentsByName()
SetContentsByName(fieldName, contents): boolean
Legt den Inhalt des Feldes fest, dessen physikalischer Feldname übergeben wurde. Das Setzen eines Primärschlüssels ist möglich, sofern das Schreiben erlaubt ist.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Physikalischer Name des gewünschten Feldes. |
contents | string | (Neuer) Feldinhalt |
Rückgabewert
boolean
true wenn der Wert gesetzt werden konnte, andernfalls false
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8932
SetContentsByNameFromFile()
SetContentsByNameFromFile(fieldName, fileName): boolean
Die angegebene Datei wird in das übergebene BLOB-Feld eingebettet.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Physikalischer Name des gewünschten (BLOB)-Felds. |
fileName | string | Dateipfad |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8943
SetContentsByNameToNull()
SetContentsByNameToNull(fieldName): boolean
Setzt Feld auf null . Bitte beachten Sie, dass die Methode nicht prüft, ob ein Feld in der Datenbank überhaupt null sein darf!
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Physikalischer Name des gewünschten (BLOB)-Felds. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8953
SetContentsValueByFormula()
SetContentsValueByFormula(fieldName, formula): boolean
Legt den Inhalt des Feldes mit einer Formel fest, dessen Feldname übergeben wurde. Das Setzen eines Primärschlüssels ist möglich, sofern das Schreiben erlaubt ist.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Physikalischer Name des gewünschten Feldes. |
formula | any | Feldinhalt aus einer Formel. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8964
SetContentsValueByName()
SetContentsValueByName(fieldName, content): boolean
Legt den Inhalt des Feldes fest, dessen physikalischer Feldname übergeben wurde. Die übergebene Variable für den Inhalt kann dabei einen zum Feldtyp korrespondierenden Typ haben und muss nicht vorher in eine Zeichenkette umgewandelt werden.Somit werden bspw. Lokalisierungsprobleme (Komma oder Punkt als Dezimalzeichen? Datumsformatierung?) bei der Weiterverarbeitung des Wertes vermieden. Das Setzen eines Primärschlüssels ist möglich, sofern das Schreiben erlaubt ist.
Parameter
| Parameter | Type | Description |
|---|---|---|
fieldName | string | Physikalischer Name des gewünschten Feldes. |
content | any | (Neuer) Feldinhalt |
Rückgabewert
boolean
true wenn der Wert gesetzt werden konnte, andernfalls false
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8977
TransferData()
TransferData(transferTemplate): boolean
Führt die Einzelübernahme mit einer als Parameter übergebenen Übernahmemaske durch.
Parameter
| Parameter | Type | Description |
|---|---|---|
transferTemplate | string | Pfad und Dateiname der Übernahmemaske. Die Platzhalter %APPDIR% und %PRJDIR% werden unterstützt. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8987
Unlock()
Unlock(): boolean
Entsperrt einen zuvor mit Lock() gesperrten Datensatz wieder und ermöglicht somit die Änderung durch andere Benutzer.
Rückgabewert
boolean
true wenn der Datensatz entsperrt werden konnte, andernfalls false
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:8998
[asyncDispose]()
asyncDispose: Promise<void>
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:9010
[dispose]()
dispose: void
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
Definiert in
combitCRM.SDK.WindowsClient.v11.ts:9021
[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
combitCRM.SDK.WindowsClient.v11.ts:9029