Project

Projekt

Implementiert

• AsyncDisposable
• Disposable

Eigenschaften

ActiveViews

get ActiveViews(): Promise<ListViews>

Gibt die aktiven geöffneten Ansichten als Objekt vom Typ ListViews zurück

Rückgabewert

Promise<ListViews>

Definiert in

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

---

CompanyInfo

get CompanyInfo(): Promise<CompanyInfo>

Liefert die Firmenstammdaten zurück

Rückgabewert

Promise<CompanyInfo>

Definiert in

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

---

CurrentUser

get CurrentUser(): string

Liefert den aktiven Benutzer der Anwendung.

Rückgabewert

string

Definiert in

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

---

DatabaseName

get DatabaseName(): string

Gibt den Datenbanknamen des Projektes zurück.

Rückgabewert

string

Definiert in

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

---

Description

get Description(): string

Gibt die Beschreibung des Projektes zurück.

Rückgabewert

string

Definiert in

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

---

DocMngr

get DocMngr(): Promise<DocMngr>

Mit Hilfe des DocMngr -Objekts können Dateien im konfigurierten Dokumentencontainer bzw. Dokumentenfeldern abgelegt werden.

Rückgabewert

Promise<DocMngr>

Definiert in

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

---

EmailTool

get EmailTool(): Promise<EmailTool>

Mit Hilfe des EmailTool -Objekts besteht Zugriff auf ein im cRM integriertes externes Tool für professionelles und leistungsfähiges Kampagnenmanagement
Hinweis: Wenn in der Projekt Konfiguration der eMail-Versand über "Integrierte eMail-Anbindung" eingestellt ist, liefert die Eigenschaft null zurück.

Rückgabewert

Promise<EmailTool>

Definiert in

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

---

FilePath

get FilePath(): string

Gibt den Verzeichnispfad des Projektes zurück.

Rückgabewert

string

Definiert in

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

---

ID

get ID(): string

Gibt die eindeutige ID des Projektes zurück.

Rückgabewert

string

Definiert in

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

---

IsDirty

get IsDirty(): boolean

Liefert zurück, ob es zurzeit noch ungespeicherte Änderungen an der Projektdatei gibt.

Rückgabewert

boolean

Definiert in

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

---

IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

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

---

Name

get Name(): string

Gibt den Projektnamen des aktiven Projektes zurück.

Rückgabewert

string

Definiert in

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

---

ProjectDir

get ProjectDir(): string

Gibt das Projektverzeichnis des aktiven Projektes mit abschließendem Backslash zurück.

Rückgabewert

string

Definiert in

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

---

TimeManager

get TimeManager(): Promise<TimeManager>

Liefert ein Termin-Objekt vom Typ TimeManager zurück

Rückgabewert

Promise<TimeManager>

Definiert in

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

---

Title

get Title(): string

Gibt den Titel des Projektes zurück.

Rückgabewert

string

Definiert in

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

---

Users

get Users(): Promise<Users>

Liefert das Users -Objekt für den Zugriff auf die Benutzerstammdaten zurück

Rückgabewert

Promise<Users>

Definiert in

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

---

ViewConfigs

get ViewConfigs(): Promise<ListViewConfigs>

Gibt die konfigurierten Ansichten im aktuellen Projekt als Objekt vom Typ ListViewConfigs zurück.

Rückgabewert

Promise<ListViewConfigs>

Definiert in

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

Methoden

CheckVATID()

CheckVATID(
   vatID1, 
   vatID2, 
   company, 
   city, 
   zip?, 
   street?, 
print?): Promise<VATIDResult>

Führt online beim Bundeszentralamt für Steuern eine qualifizierte Bestätigungsanfrage einer ausländischen Umsatzsteuer-Identifikationsnummer durch(vgl. §6a Ziff. 3 UstG). Beachten Sie dazu die Hinweise auf der Website des Bundeszentralamt für Steuern.

Parameter

Parameter	Type	Description
vatID1	string	Ihre deutsche Ust-IdNr
vatID2	string	Anzufragende ausländische Ust-IdNr
company	string	Name der anzufragenden Firma einschl. Rechtsform
city	string	Ort der anzufragenden Firma
zip?	string	Postleitzahl der anzufragenden Firma
street?	string	Optional - Straße und Hausnummer der anzufragenden Firma
print?	boolean	Optional Voreinstellung: false - true : Mit schriftlicher amtlicher Bestätigungsmitteilung

Rückgabewert

Promise<VATIDResult>

Gibt ein VATIDResult -Objekt zurück. Im Feld Result wird angegeben ob die Abfrage erfolgreich ausgeführt werden konnte.
Der tatsächliche Rückgabe Status befindet sich in der Eigenschaft ErrorCode

Definiert in

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

---

Dispose()

Dispose(): void

Standardimplementierung des Dispose

Rückgabewert

void

Definiert in

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

---

DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

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

---

ExecuteInstantReportByDescription()

ExecuteInstantReportByDescription(
   media, 
   reportDescription, 
   outputFileName?, 
   silent?, 
exportOptions?): Promise<boolean>

Führt einen abgespeicherten Sofortbericht anhand seiner Beschreibung aus.

Parameter

Parameter	Type	Description
media	PrintOutputMedia	Ausgabe-Medium
reportDescription	string	Beschreibung des Sofortberichts. Groß- / Kleinschreibung wird beachtet!
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.
silent?	boolean	Optional Voreinstellung: true - Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
exportOptions?	string	Export-Optionen für Print-Methoden siehe SDK

Rückgabewert

Promise<boolean>

Definiert in

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

---

ExecuteInstantReportByName()

ExecuteInstantReportByName(
   media, 
   reportName, 
   outputFileName?, 
   silent?, 
exportOptions?): Promise<boolean>

Führt einen abgespeicherten Sofortbericht anhand seines Namens aus.

Parameter

Parameter	Type	Description
media	PrintOutputMedia	Ausgabe-Medium
reportName	string	Name des Sofortberichts. Groß- / Kleinschreibung wird beachtet!
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.
silent?	boolean	Optional Voreinstellung: true - Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll.
exportOptions?	string	Export-Optionen für Print-Methoden siehe SDK

Rückgabewert

Promise<boolean>

Definiert in

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

---

ExecuteScriptByCode()

ExecuteScriptByCode(code): Promise<boolean>

Führt den übergebenen Scriptcode als internes Script aus.

Parameter

Parameter	Type	Description
code	string	Scriptcode

Rückgabewert

Promise<boolean>

Definiert in

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

---

ExecuteScriptByFilename()

ExecuteScriptByFilename(filePath): Promise<boolean>

Führt das übergebene Script aus.

Parameter

Parameter	Type	Description
filePath	string	Dateiname inkl. Pfad des Scripts

Rückgabewert

Promise<boolean>

Definiert in

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

---

ExecuteWorkflowByFilename()

ExecuteWorkflowByFilename(filePath): Promise<boolean>

Führt den übergebenen Workflow aus.

Parameter

Parameter	Type	Description
filePath	string	Dateiname inkl. Pfad des Scripts

Rückgabewert

Promise<boolean>

Definiert in

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

---

FetchConfigFile()

FetchConfigFile(sourceFilePath, targetFilePath): Promise<boolean>

Holt die projektspezifischen Konfigurationsdateien.

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>

false wenn der Befehl nicht ausgeführt werden konnte weil z.B. der Dateiname nicht gefunden wurde oder der Speicherort ungültig ist, andernfalls true

Definiert in

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

---

GetGlobalProperty()

GetGlobalProperty(name, defaultValue): Promise<string>

Liest eine globale Script-Einstellung aus, die zuvor mit SetGlobalProperty(name: string, value: string) gesetzt wurde oder gibt den Standardwert zurück

Parameter

Parameter	Type	Description
name	string	Der Name der Einstellung.
defaultValue	string	Der Standardwert der Einstellung, der zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert.

Rückgabewert

Promise<string>

Definiert in

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

---

GetMessageText()

GetMessageText(
   resourceFileName, 
   id, 
   param1?, 
   param2?, 
   param3?, 
   param4?, 
param5?): Promise<string>

Lädt Texte aus einer Messages.txt im Projektverzeichnis. Falls die Oberflächen-Sprache auf Englisch eingestellt ist, dann aus der "Messages.0009.lng.txt".

Parameter

Parameter	Type	Description
resourceFileName	string	Reserviert - Es kann eine leere Zeichenkette übergeben werden
id	string	Name des Eintrags aus der Messages.txt
param1?	string	Optional - Erster Parameter, um Informationen für den Platzhalter {0} innerhalb der des Textes zu befüllen.
param2?	string	Optional - Zweiter Parameter, um Informationen für den Platzhalter {1} innerhalb der des Textes zu befüllen.
param3?	string	Optional - Dritter Parameter, um Informationen für den Platzhalter {2} innerhalb der des Textes zu befüllen.
param4?	string	Optional - Vierter Parameter, um Informationen für den Platzhalter {3} innerhalb der des Textes zu befüllen.
param5?	string	Optional - Fünfter Parameter, um Informationen für den Platzhalter {4} innerhalb der des Textes zu befüllen.

Rückgabewert

Promise<string>

Definiert in

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

---

GetSessionProperty()

GetSessionProperty(name, defaultValue): Promise<string>

Liest eine Session-Variable aus, die zuvor mit SetSessionProperty(name: string, value: string) gesetzt wurde oder gibt den Standardwert zurück

Parameter

Parameter	Type	Description
name	string	Der Name der Einstellung
defaultValue	string	Der Standardwert der Einstellung, der zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert.

Rückgabewert

Promise<string>

Der Wert oder defaultValue falls die Einstellung noch nicht gesetzt wurde

Definiert in

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

---

GetUserProperty()

GetUserProperty(name, defaultValue): Promise<string>

Liest eine benutzerspezifische Script-Einstellung aus, die zuvor mit SetUserProperty(name: string, value: string) gesetzt wurde oder gibt den Standardwert zurück

Parameter

Parameter	Type	Description
name	string	Der Name der Einstellung
defaultValue	string	Der Standardwert der Einstellung, der zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert.

Rückgabewert

Promise<string>

Der Wert oder defaultValue falls die Einstellung noch nicht gesetzt wurde

Definiert in

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

---

IsValueBlacklisted()

IsValueBlacklisted(value): Promise<boolean>

Gibt zurück, ob sich der übergebene Wert auf der Sperrliste befindet.

Parameter

Parameter	Type	Description
value	string	Der zu prüfende Inhalt (eMail-Adressen, Fax und Telefonnummern).

Rückgabewert

Promise<boolean>

Definiert in

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

---

OpenActiveViewByName()

OpenActiveViewByName(viewName): Promise<View>

Liefert eine aktive Ansicht über den Ansichtennamen.

Parameter

Parameter	Type	Description
viewName	string	Name der aktiven Ansicht in der Anwendung

Rückgabewert

Promise<View>

Definiert in

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

---

OpenNewViewByName()

OpenNewViewByName(viewName, sortOrder)

OpenNewViewByName(viewName, sortOrder?): Promise<View>

Öffnet eine neue Ansicht über den Ansichtennamen.
Sollte es möglich sein die benötigten Daten per Filter einzuschränken sollte die Funktion OpenNewViewByName(viewName: string, type: RecordSetFilterType, filter: string, sortOrder?: number) stattdessen verwendet werden.

Parameter

Parameter	Type	Description
viewName	string	Name der neuen Ansicht
sortOrder?	number	Optional Voreinstellung:0 (Keine Sortierung) - Angabe einer Sortierung die ausgeführt werden soll.

Rückgabewert

Promise<View>

Rückgabe: View wenn der Zugriff erfolgreich war, andernfalls null

Remarks

Version 12.0.0

Verhaltensänderung. Die Sortierung wird ab dieser Version direkt im SQL ausgeführt und löst keine erneute Datenbankabfrage mehr aus.

Definiert in

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

OpenNewViewByName(viewName, type, filter, sortOrder)

OpenNewViewByName(
   viewName, 
   type, 
   filter, 
sortOrder?): Promise<View>

Öffnet eine neue Ansicht über den Ansichtennamen.

Parameter

Parameter	Type	Description
viewName	string	Name der neuen Ansicht
type	RecordSetFilterType	Filtertyp
filter	string	Filtercontext
sortOrder?	number	Optional Voreinstellung:0 (Keine Sortierung) - Angabe einer Sortierung die ausgeführt werden soll.

Rückgabewert

Promise<View>

Rückgabe: View wenn der Zugriff erfolgreich war, andernfalls null

Remarks

Version 12.0.0

Verhaltensänderung. Die Sortierung wird ab dieser Version direkt im SQL ausgeführt und löst keine erneute Datenbankabfrage mehr aus.
RecordSetFilterType.SetFilter wird ab dieser Version direkt ausgeführt und erfordert keine erneute Datenbankabfrage.

Definiert in

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

---

RemoveSessionProperty()

RemoveSessionProperty(name): Promise<void>

Entfernt eine zuvor per SetSessionProperty(name: string, value: string) angelegte Variable im Unterzweig "cRM.Project.Session"

Parameter

Parameter	Type	Description
name	string	Name der Session-Variable

Rückgabewert

Promise<void>

Definiert in

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

---

SetGlobalProperty()

SetGlobalProperty(name, value): Promise<void>

Setzt eine globale Script-Einstellung. Die Speicherung erfolgt in der Datei "global.ini" in der "cmbt_Files" Tabelle.

Parameter

Parameter	Type	Description
name	string	Der Name der Einstellung.
value	string	Der (neue) Wert der Einstellung.

Rückgabewert

Promise<void>

Definiert in

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

---

SetSessionProperty()

SetSessionProperty(name, value): Promise<void>

Setzt eine Session-Variable im Formeleditor im Unterzweig "cRM.Project.Session".

Parameter

Parameter	Type	Description
name	string	Name der Session-Variable
value	string	Inhalt der Session-Variable.

Rückgabewert

Promise<void>

Definiert in

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

---

SetUserProperty()

SetUserProperty(name, value): Promise<void>

Setzt eine benutzerspezifische Script-Einstellung. Die Speicherung erfolgt in der Datei "BENUTZER\user_scriptvars.ini" in der "cmbt_Files" Tabelle

Parameter

Parameter	Type	Description
name	string	Name der Session-Variable
value	string	Inhalt der Session-Variable.

Rückgabewert

Promise<void>

Definiert in

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

---

StoreConfigFile()

StoreConfigFile(filePath, localFilePath): Promise<boolean>

Speichert die projektspezifischen Konfigurationsdateien der Anwendung.

Parameter

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

Rückgabewert

Promise<boolean>

false wenn der Befehl nicht ausgeführt werden konnte weil z.B. der Dateiname nicht gefunden wurde oder der Speicherort ungültig ist, andernfalls true

Definiert in

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

---

[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

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

---

[dispose]()

dispose: void

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

Definiert in

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

---

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