Record

Datensatz

Implementiert

• AsyncDisposable

Eigenschaften

Deletable

get Deletable(): Promise<boolean>

Über diese Eigenschaft kann geprüft werden, ob ein Datensatz aufgrund von Datensatzrechten löschbar wäre.

Rückgabewert

Promise<boolean>

Definiert in

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

---

Editable

get Editable(): Promise<boolean>

Über diese Eigenschaft kann geprüft werden, ob ein Datensatz aufgrund von Datensatzrechten bearbeitbar wäre.

Rückgabewert

Promise<boolean>

Definiert in

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

---

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

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

Methoden

AddToBlacklist()

AddToBlacklist(fieldName): Promise<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

Promise<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

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

---

AddToFavorites()

AddToFavorites(): Promise<boolean>

Fügt den aktuellen Datensatz den Favoriten hinzu.

Rückgabewert

Promise<boolean>

Definiert in

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

---

AddToHistory()

AddToHistory(): Promise<boolean>

Fügt den aktuellen Datensatz dem Verlauf hinzu.

Rückgabewert

Promise<boolean>

Definiert in

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

---

AddToPhoneManager()

AddToPhoneManager(): Promise<boolean>

Fügt den aktuellen Datensatz dem phone manager hinzu.

Rückgabewert

Promise<boolean>

Definiert in

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

---

Delete()

Delete(): Promise<boolean>

Löscht einen Datensatz.

Rückgabewert

Promise<boolean>

Definiert in

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

---

DialNumber()

DialNumber(fieldName): Promise<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

Promise<boolean>

Definiert in

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

---

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

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

---

GetContentsByFormula()

GetContentsByFormula(formula): Promise<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

Promise<string>

Inhalt des Feldes oder '' (Leere Zeichenfolge) wenn das Feld nicht vorhanden ist

Definiert in

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

---

GetContentsByName()

GetContentsByName(name): Promise<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

Promise<string>

Inhalt des Feldes oder '' (Leere Zeichenfolge) wenn das Feld nicht vorhanden ist

Definiert in

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

---

GetContentsByNameToFile()

GetContentsByNameToFile(name, path): Promise<string>

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
path	string	Speicherpfad der angelegten Datei.

Rückgabewert

Promise<string>

Definiert in

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

---

GetContentsValueByFormula()

GetContentsValueByFormula<T>(t, formula): Promise<T>

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.

Type Parameters

Type Parameter
T extends string | number | boolean | Date

Parameter

Parameter	Type	Description
t	CLType<T>	Generischer Parameter. Der Wert muss einem Wert von CLType entsprechen
formula	string	Auszuwertende Formel.

Rückgabewert

Promise<T>

Inhalt des Feldes oder null wenn die Formel ungültig ist

Example

const text : string = record.GetContentsValueByFormula(CLType.String, "Email: <eMail>");

Definiert in

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

---

GetContentsValueByName()

GetContentsValueByName<T>(t, name): Promise<T>

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.

Type Parameters

Type Parameter
T extends string | number | boolean | Date

Parameter

Parameter	Type	Description
t	CLType<T>	Generischer Parameter. Der Wert muss einem Wert von CLType entsprechen
name	string	Physikalischer Name des gewünschten Feldes.

Rückgabewert

Promise<T>

Inhalt des Feldes oder null wenn das Feld nicht vorhanden ist

Example

const dateValue : Date = record.GetContentsValueByName(CLType.Date,"Datumsfeld");

Definiert in

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

---

GetRecordRefDescription()

GetRecordRefDescription(): Promise<string>

Liefert die evaluierte Datensatzverweis-Formel für Kommentar/Betreff zurück. Im Fehlerfall wird ein leerer String zurückgeliefert.

Rückgabewert

Promise<string>

Definiert in

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

---

GetRelationalRecordSet()

GetRelationalRecordSet(relation, cursorMode?): Promise<RecordSet>

Liefert ein RecordSet aufgrund einer relationalen Struktur zurück.

Parameter

Parameter	Type	Description
relation	string	Bezeichnung der Relation, z.B. ID.Kontakte.CompanyID
cursorMode?	CRMCursorMode	Optional Voreinstellung: SolutionDefault - Ermöglicht die Spezifikation des Datenbankcursormodells, das für den zurückgegebenen RecordSet genutzt werden soll. 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 FullDynamic zu setzen

Rückgabewert

Promise<RecordSet>

Remarks

Version 12.0.0

Verhaltensänderung. Der Standardparameter forwardOnly wurde von false auf SolutionDefault geändert

Definiert in

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

---

Lock()

Lock(checkForModifiedFields?): Promise<boolean>

Sperrt den aktuellen Datensatz für die Bearbeitung durch andere Benutzer und sollte vor dem Ändern eines Datensatzes durch SetContents...aufgerufen werden.

Parameter

Parameter	Type	Description
checkForModifiedFields?	boolean	Optional Voreinstellung: false - Steuert, ob beim Sperren eines Datensatzes mit anschließendem Speichern einer Feldänderung überprüft werden soll, ob es Änderungen durch andere Benutzer gibt und das Speichern dann fehlschlagen soll ( true ) oder ob die Überprüfung deaktiviert wird und die letzte Datensatzänderung gewinnt ( false ). Dies ist insbesondere bei Feldänderungen über viele Datensätze innerhalb einer Schleife zu bevorzugen, da eine erhebliche Performance-Steigerung erreicht werden kann.

Rückgabewert

Promise<boolean>

true wenn der Datensatz gesperrt werden konnte, andernfalls false .
Letzteres kann bspw. dadurch bedingt sein, dass der Datensatz bereits gesperrt oder die Bearbeitung aufgrund der aktuellen Berechtigungseinstellung nicht möglich ist.

Remarks

Version 12.0.0

Der Standardwert des Parameters 'checkForModifiedFields' wurde von True auf False geändert

Definiert in

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

---

PrintCard()

PrintCard(
   media, 
   fileName, 
   silent, 
   outputFileName?, 
   useModalPreviewWindow?, 
exportOptions?): Promise<boolean>

Druckt ein Karteikartenprojekt 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.
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	Optional Voreinstellung true - Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ).
exportOptions?	string	Export-Optionen für Print-Methoden siehe SDK

Rückgabewert

Promise<boolean>

Definiert in

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

---

PrintLabel()

PrintLabel(
   media, 
   fileName, 
   silent, 
   outputFileName?, 
   useModalPreviewWindow?, 
exportOptions?): Promise<boolean>

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.
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	Optional Voreinstellung true - Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ).
exportOptions?	string	Export-Optionen für Print-Methoden siehe SDK

Rückgabewert

Promise<boolean>

Definiert in

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

---

PrintReport()

PrintReport(
   media, 
   fileName, 
   silent, 
   outputFileName?, 
   useModalPreviewWindow?, 
exportOptions?): Promise<boolean>

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.
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	Optional Voreinstellung true - Legt fest, ob der Druck auf Vorschau (PRV) in das normale Vorschaufenster gedruckt wird oder in die Berichtsansicht( false ).
exportOptions?	string	Export-Optionen für Print-Methoden siehe SDK

Rückgabewert

Promise<boolean>

Definiert in

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

---

RemoveFromBlacklist()

RemoveFromBlacklist(fieldName): Promise<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

Promise<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

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

---

Save()

Save(): Promise<boolean>

Speichert einen mit Hilfe von SetContents... geänderten Datensatz in die Datenbank; zuvor sollte der Datensatz immer mit Lock(checkForModifiedFields?: boolean) gesperrt werden.

Rückgabewert

Promise<boolean>

true wenn der Datensatz gespeichert werden konnte, andernfalls false

Definiert in

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

---

SaveRecordRef()

SaveRecordRef(fileName): Promise<boolean>

Speichert einen Datensatzverweis.

Parameter

Parameter	Type	Description
fileName	string	Pfad + Dateiname + Dateiendung des zu speichernden Adressverweises.

Rückgabewert

Promise<boolean>

Definiert in

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

---

SendMailDirect()

SendMailDirect(emailAddress, subject, content, files)

SendMailDirect(
   emailAddress, 
   subject, 
   content, 
files?): Promise<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.
content	string	Text der eMail.
files?	string[]	Optional - Liste von eMail-Anhängen. 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

Promise<boolean>

Definiert in

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

SendMailDirect(subject, content, toEmailAddresses, ccEmailAddresses, bccEmailAddresses, files)

SendMailDirect(
   subject, 
   content, 
   toEmailAddresses?, 
   ccEmailAddresses?, 
   bccEmailAddresses?, 
files?): Promise<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
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. 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

Promise<boolean>

Remarks

Version 12.4.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:11114

---

SendRecordRef()

SendRecordRef(
   emailAddress, 
   subject, 
content): Promise<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

Promise<boolean>

Definiert in

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

---

SendSingleMail()

SendSingleMail(templatePath, files?): Promise<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[]	Optional. Kann eine Liste von eMail-Anhängen beinhalten. 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

Promise<boolean>

Definiert in

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

---

SendSingleMailDialog()

SendSingleMailDialog(templatePath, files?): Promise<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[]	Optional. Kann eine Liste von eMail-Anhängen beinhalten. 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

Promise<boolean>

Definiert in

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

---

SetContentsByFormula()

SetContentsByFormula(name, formula): Promise<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
name	string	Physikalischer Name des gewünschten Feldes.
formula	string	Feldinhalt aus einer Formel.

Rückgabewert

Promise<boolean>

Definiert in

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

---

SetContentsByName()

SetContentsByName(name, contents): Promise<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
name	string	Physikalischer Name des gewünschten Feldes.
contents	string	(Neuer) Feldinhalt

Rückgabewert

Promise<boolean>

true wenn der Wert gesetzt werden konnte, andernfalls false

Definiert in

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

---

SetContentsByNameFromFile()

SetContentsByNameFromFile(name, filePath): Promise<boolean>

Die angegebene Datei wird in das übergebene BLOB-Feld eingebettet.

Parameter

Parameter	Type	Description
name	string	Physikalischer Name des gewünschten (BLOB)-Felds.
filePath	string	Dateipfad

Rückgabewert

Promise<boolean>

Remarks

Version 12.0.0

Verhaltensänderung. Die Datei darf nun erst nach dem Speichern des Datensatzes gelöscht werden.

Definiert in

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

---

SetContentsByNameToNull()

SetContentsByNameToNull(name): Promise<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
name	string	Physikalischer Name des gewünschten (BLOB)-Felds.

Rückgabewert

Promise<boolean>

Definiert in

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

---

SetContentsValueByFormula()

SetContentsValueByFormula(name, formula): Promise<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
name	string	Physikalischer Name des gewünschten Feldes.
formula	string	Feldinhalt aus einer Formel.

Rückgabewert

Promise<boolean>

Definiert in

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

---

SetContentsValueByName()

SetContentsValueByName(name, contents): Promise<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
name	string	Physikalischer Name des gewünschten Feldes.
contents	string	(Neuer) Feldinhalt

Rückgabewert

Promise<boolean>

true wenn der Wert gesetzt werden konnte, andernfalls false

Definiert in

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

---

Unlock()

Unlock(): Promise<boolean>

Entsperrt einen zuvor mit Lock(checkForModifiedFields?: boolean) gesperrten Datensatz wieder und ermöglicht somit die Änderung durch andere Benutzer.

Rückgabewert

Promise<boolean>

true wenn der Datensatz entsperrt werden konnte, andernfalls false

Definiert in

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

---

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

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

---

[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:11287