Project
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1090
Projekt
Extends
ExtendedCRMObjectBase<Project>
Eigenschaften
_instance
protected _instance: Project;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:12
Abgeleitet von
ExtendedCRMObjectBase._instance
className
protected readonly className: string;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:16
Abgeleitet von
ExtendedCRMObjectBase.className
activeViewsAsync
Abfragesignatur
get activeViewsAsync(): Promise<ListViews>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1119
Gibt die aktiven geöffneten Ansichten als Objekt vom Typ ListViews zurück
Rückgabewert
Promise<ListViews>
CompanyInfoAsync
Abfragesignatur
get CompanyInfoAsync(): Promise<CompanyInfo>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1129
Liefert die Firmenstammdaten zurück
Rückgabewert
Promise<CompanyInfo>
currentUserAsync
Abfragesignatur
get currentUserAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1139
Liefert den LoginName des aktiven Benutzer der Anwendung.
Rückgabewert
Promise<string>
databaseNameAsync
Abfragesignatur
get databaseNameAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1149
Gibt den Datenbanknamen des Projektes zurück.
Rückgabewert
Promise<string>
dbSystemTypeAsync
Abfragesignatur
get dbSystemTypeAsync(): Promise<DBSystemType>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1219
Liefert das eingestellte Datenbanksystem zurück.
Rückgabewert
Promise<DBSystemType>
dbSystemVersion
Abfragesignatur
get dbSystemVersion(): Promise<number>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1232
Rückgabe der Datenbankserver-Version der installierten Anwendung.
HIWORD Hauptversion (Dividiert durch 65535)
LOWORD Nebenversion(Modulo 0xFFFF0000)
Rückgabewert
Promise<number>
descriptionAsync
Abfragesignatur
get descriptionAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1159
Gibt die Beschreibung des Projektes zurück.
Rückgabewert
Promise<string>
docMngrAsync
Abfragesignatur
get docMngrAsync(): Promise<DocMngr>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1169
Mit Hilfe des DocMngr-Objekts können Dateien im konfigurierten Dokumentencontainer bzw. Dokumentenfeldern abgelegt werden.
Rückgabewert
Promise<DocMngr>
emailToolAsync
Abfragesignatur
get emailToolAsync(): Promise<EmailTool>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1284
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>
filePathAsync
Abfragesignatur
get filePathAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1179
Gibt den Verzeichnispfad des Projektes zurück.
Rückgabewert
Promise<string>
idAsync
Abfragesignatur
get idAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1189
Gibt die eindeutige ID des Projektes zurück.
Rückgabewert
Promise<string>
isDirtyAsync
Abfragesignatur
get isDirtyAsync(): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1199
Liefert zurück, ob es zurzeit noch ungespeicherte Änderungen an der Projektdatei gibt.
Rückgabewert
Promise<boolean>
nameAsync
Abfragesignatur
get nameAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1209
Gibt den Projektnamen des aktiven Projektes zurück.
Rückgabewert
Promise<string>
projectDirAsync
Abfragesignatur
get projectDirAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1242
Gibt das Projektverzeichnis des aktiven Projektes mit abschließendem Backslash zurück.
Rückgabewert
Promise<string>
timeManagerAsync
Abfragesignatur
get timeManagerAsync(): Promise<TimeManager>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1262
Liefert ein Termin-Objekt vom Typ TimeManager zurück
Rückgabewert
Promise<TimeManager>
titleAsync
Abfragesignatur
get titleAsync(): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1294
Gibt den Titel des Projektes zurück.
Rückgabewert
Promise<string>
usersAsync
Abfragesignatur
get usersAsync(): Promise<Users>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1252
Liefert das Users -Objekt für den Zugriff auf die Benutzerstammdaten zurück
Rückgabewert
Promise<Users>
viewConfigsAsync
Abfragesignatur
get viewConfigsAsync(): Promise<ListViewConfigs>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1272
Gibt die konfigurierten Ansichten im aktuellen Projekt als Objekt vom Typ ListViewConfigs zurück.
Rückgabewert
Promise<ListViewConfigs>
Konstruktoren
Konstruktor
new Project(
project,
combitCRMVersion,
disposeInstance): Project;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1102
Parameter
| Parameter | Type | Default value |
|---|---|---|
project | Project | undefined |
combitCRMVersion | number | CRMVersion | undefined |
disposeInstance | boolean | true |
Rückgabewert
Project
Überschreibt
ExtendedCRMObjectBase<CoreCRM.Project>.constructor
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:93
Rückgabewert
Promise<void>
Abgeleitet von
ExtendedCRMObjectBase.[asyncDispose]
[dispose]()
dispose: void;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:88
Rückgabewert
void
Abgeleitet von
ExtendedCRMObjectBase.[dispose]
checkVATIDAsync()
checkVATIDAsync(
ownVATID,
searchedVATID,
company,
city,
options?): Promise<VATIDResult>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1312
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 |
|---|---|---|
ownVATID | string | Ihre deutsche Ust-IdNr |
searchedVATID | string | Anzufragende ausländische Ust-IdNr |
company | string | Name der anzufragenden Firma einschl. Rechtsform |
city | string | Ort der anzufragenden Firma |
options? | { print?: boolean; street?: string; zip?: string; } | Optionen |
options.print? | boolean | - |
options.street? | string | - |
options.zip? | string | - |
Rückgabewert
Promise<VATIDResult>
Gibt ein VATIDResult-Objekt zurück. Im Feld VATIDResult.result wird angegeben ob die Abfrage erfolgreich ausgeführt werden konnte.
Der tatsächliche Rückgabe Status befindet sich in der Eigenschaft VATIDResult.errorCode.
dispose()
dispose(): void;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:72
Rückgabewert
void
Abgeleitet von
ExtendedCRMObjectBase.dispose
disposeAsync()
disposeAsync(): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:56
Rückgabewert
Promise<void>
Abgeleitet von
ExtendedCRMObjectBase.disposeAsync
executeInstantReportByDescriptionAsync()
executeInstantReportByDescriptionAsync(
media,
reportDescription,
options?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1328
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! |
options? | { exportOptions?: string; outputFileName?: string; silent?: 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.silent? | boolean | Optional Voreinstellung: true- Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
Rückgabewert
Promise<boolean>
executeInstantReportByNameAsync()
executeInstantReportByNameAsync(
media,
reportName,
options?): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1363
Führt einen abgespeicherten Sofortbericht anhand seines Names aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
media | PrintOutputMedia | Ausgabe-Medium |
reportName | string | Name des Sofortberichts. Groß- / Kleinschreibung wird beachtet! |
options? | { exportOptions?: string; outputFileName?: string; silent?: 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.silent? | boolean | Optional Voreinstellung: true- Legt fest, ob der Druck (nach Möglichkeit) ohne Benutzerinteraktion erfolgen soll. |
Rückgabewert
Promise<boolean>
executeScriptByCodeAsync()
executeScriptByCodeAsync(scriptCode): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1396
Führt den übergebenen Scriptcode als internes Script aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
scriptCode | string | Scriptcode |
Rückgabewert
Promise<boolean>
executeScriptByFilenameAsync()
executeScriptByFilenameAsync(filePath): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1408
Führt das übergebene Script aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Dateiname inkl. Pfad des Scripts |
Rückgabewert
Promise<boolean>
executeWorkflowByFilenameAsync()
executeWorkflowByFilenameAsync(filePath): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1420
Führt den übergebenen Workflow aus.
Parameter
| Parameter | Type | Description |
|---|---|---|
filePath | string | Dateiname inkl. Pfad des Workflows |
Rückgabewert
Promise<boolean>
fetchConfigFileAsync()
fetchConfigFileAsync(sourceFilePath, targetFilePath): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1433
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
getGlobalPropertyAsync()
getGlobalPropertyAsync(name, defaultValue): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1446
Liest eine globale Script-Einstellung aus, die zuvor mit Project.setGlobalProperty gesetzt wurde oder gibt den Standardwert zurück
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
name | string | undefined | Der Name der Einstellung. |
defaultValue | string | '' | Optional: Der Standardwert der Einstellung, der zurückgegeben wird, wenn keine Einstellung mit dem angegebenen Namen existiert. |
Rückgabewert
Promise<string>
getMessageTextAsync()
getMessageTextAsync(
resourceFileName,
id,
options?): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1460
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 |
options? | { param1?: string; param2?: string; param3?: string; param4?: string; param5?: string; } | Optionale Optionen |
options.param1? | string | Erster Parameter, um Informationen für den Platzhalter {0} innerhalb der des Textes zu befüllen. |
options.param2? | string | Zweiter Parameter, um Informationen für den Platzhalter {1} innerhalb der des Textes zu befüllen. |
options.param3? | string | Dritter Parameter, um Informationen für den Platzhalter {2} innerhalb der des Textes zu befüllen. |
options.param4? | string | Vierter Parameter, um Informationen für den Platzhalter {3} innerhalb der des Textes zu befüllen. |
options.param5? | string | Fünfter Parameter, um Informationen für den Platzhalter {4} innerhalb der des Textes zu befüllen. |
Rückgabewert
Promise<string>
getSessionPropertyAsync()
getSessionPropertyAsync(name, defaultValue): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1494
Liest eine Session-Variable aus, die zuvor mit Project.setSessionProperty gesetzt wurde oder gibt den Standardwert zurück
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
name | string | undefined | Der Name der Einstellung. |
defaultValue | string | '' | Optional: 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
getUserPropertyAsync()
getUserPropertyAsync(name, defaultValue): Promise<string>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1507
Liest eine benutzerspezifische Script-Einstellung aus, die zuvor mit Project.setUserProperty gesetzt wurde oder gibt den Standardwert zurück
Parameter
| Parameter | Type | Default value | Description |
|---|---|---|---|
name | string | undefined | Der Name der Einstellung. |
defaultValue | string | '' | Optional: 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
guardDisposed()
protected guardDisposed(): void;
Definiert in: lib/combitCRM.SDK.v12.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
isDisposed()
isDisposed(): boolean;
Definiert in: lib/combitCRM.SDK.v12.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
isValueBlacklistedAsync()
isValueBlacklistedAsync(value): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1518
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>
openActiveViewByNameAsync()
openActiveViewByNameAsync(viewName): Promise<View>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1530
Liefert eine aktive Ansicht über den Ansichtennamen.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der aktiven Ansicht in der Anwendung |
Rückgabewert
Promise<View>
openNewViewByNameAsync()
openNewViewByNameAsync(viewName, options): Promise<View>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1543
Öffnet eine neue Ansicht über den Ansichtennamen.
Parameter
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht |
options | { filter?: { text: string; type: RecordSetFilterType; }; sortOrder?: number; } | Optionale Optionen: Zum Beispiel Initialer Filter, Sortierung, etc. |
options.filter? | { text: string; type: RecordSetFilterType; } | - |
options.filter.text | string | - |
options.filter.type | RecordSetFilterType | - |
options.sortOrder? | number | - |
Rückgabewert
Promise<View>
removeSessionPropertyAsync()
removeSessionPropertyAsync(name): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1612
Entfernt eine zuvor per Project.setSessionProperty angelegte Variable im Unterzweig "cRM.Project.Session"
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Name der Session-Variable |
Rückgabewert
Promise<void>
setGlobalPropertyAsync()
setGlobalPropertyAsync(name, value): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1626
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>
setSessionPropertyAsync()
setSessionPropertyAsync(name, value): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1640
Setzt eine Session-Variable im Formeleditor im Unterzweig "cRM.Project.Session".
Parameter
| Parameter | Type | Description |
|---|---|---|
name | string | Der Name der Session-Variable. |
value | string | Der (neue) Wert der Session-Variable. |
Rückgabewert
Promise<void>
setUserPropertyAsync()
setUserPropertyAsync(name, value): Promise<void>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1654
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 | Der Name der Einstellung. |
value | string | Der (neue) Wert der Einstellung. |
Rückgabewert
Promise<void>
storeConfigFileAsync()
storeConfigFileAsync(sourceFilePath, targetFilePath): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v12.Extended.ts:1669
Speichert die projektspezifischen Konfigurationsdateien der Anwendung.
Parameter
| Parameter | Type | Description |
|---|---|---|
sourceFilePath | string | Dateiname unter dem die Datei in der cmbt_Files Tabelle in der System-Datenbank abgelegt werden soll. |
targetFilePath | string | Dateiname der lokalen Datei, die verwendet werden soll. |
Rückgabewert
Promise<boolean>
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