ScriptContext
ScriptContext. Dient dem Austausch von Daten zwischen mehreren Scripten.
Implementiert
AsyncDisposableDisposable
Eigenschaften
IsDisposed
get IsDisposed(): boolean
Gibt an, ob das Objekt bereits Freigegeben wurde
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4187
PropertyCount
get PropertyCount(): number
Gibt die Anzahl der im ScriptContext hinterlegten Eigenschaften zurück.
Rückgabewert
number
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4181
Methoden
ClearProperties()
ClearProperties(): void
Entfernt alle Eigenschaften aus dem ScriptContext.
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4210
Dispose()
Dispose(): void
Standardimplementierung des Dispose
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4317
DisposeAsync()
DisposeAsync(): Promise<void>
Standardimplementierung des AsyncDispose
Rückgabewert
Promise<void>
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4306
ExecuteScriptByCode()
ExecuteScriptByCode(code): boolean
Führt den übergebenen Scriptcode als internes Script aus und stellt den aktuellen ScriptKontext im auszuführenden Script zur Verfügung.
Parameter
| Parameter | Type | Description |
|---|---|---|
code | string | Scriptcode |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4220
ExecuteScriptByFileName()
ExecuteScriptByFileName(scriptFilePath): boolean
Führt das übergebene Script aus und stellt den aktuellen ScriptKontext im auszuführenden Script zur Verfügung.
Parameter
| Parameter | Type | Description |
|---|---|---|
scriptFilePath | string | Dateiname inkl. Pfad des Scripts. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4230
GetProperty()
GetProperty(key, defaultValue)
GetProperty(key, defaultValue?): unknown
Gibt die Eigenschaft zurück, welche mit dem Parameter 'key' zuvor gespeichert wurde. Ist keine Eigenschaft mit dem übergebenen 'key' vorhanden, wird der 'defaultValue' zurückgegeben.
Parameter
| Parameter | Type | Description |
|---|---|---|
key | string | Identifikator der Eigenschaft. Achtung: Wenn der String ausschließlich Nummern enthält wird der Parameter stattdessen als Index verwendet. |
defaultValue? | any | Standardwert der zurückgegeben wird, falls keine Eigenschaft mit dem übergebenen 'key' existiert. |
Rückgabewert
unknown
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4241
GetProperty(index, defaultValue)
GetProperty(index, defaultValue?): unknown
Gibt die Eigenschaft mit dem Index 'index' zurück.
Parameter
| Parameter | Type | Description |
|---|---|---|
index | number | Index der Eigenschaft. |
defaultValue? | any | Standardwert der zurückgegeben wird, falls keine Eigenschaft mit dem übergebenen 'index' existiert. |
Rückgabewert
unknown
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4249
GetPropertyKey()
GetPropertyKey(index): string
Gibt den String-Identifikator der Eigenschaft mit dem Index 'index' zurück, falls vorhanden.
Parameter
| Parameter | Type | Description |
|---|---|---|
index | number | Index der Eigenschaft. |
Rückgabewert
string
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4269
RemoveProperty()
RemoveProperty(key)
RemoveProperty(key): boolean
Entfernt die Eigenschaft mit dem Identifikator 'key', falls vorhanden.
Parameter
| Parameter | Type | Description |
|---|---|---|
key | string | Identifikator der Eigenschaft. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4279
RemoveProperty(index)
RemoveProperty(index): boolean
Entfernt die Eigenschaft mit dem Index 'index', falls vorhanden.
Parameter
| Parameter | Type | Description |
|---|---|---|
index | number | Identifikator der Eigenschaft. |
Rückgabewert
boolean
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4286
SetProperty()
SetProperty(key, value): void
Speichert eine Eigenschaft mit dem Identifikator 'key' und dem Wert 'value' im ScriptContext.
Parameter
| Parameter | Type | Description |
|---|---|---|
key | string | Index der Eigenschaft. |
value | any | Wert der Eigenschaft. |
Rückgabewert
void
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4300
[asyncDispose]()
asyncDispose: Promise<void>
Standardimplementierung des AsyncDispose Symbols
Rückgabewert
Promise<void>
Implementierung von
AsyncDisposable.[asyncDispose]
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4312
[dispose]()
dispose: void
Standardimplementierung des Dispose Symbols
Rückgabewert
void
Implementierung von
Disposable.[dispose]
Definiert in
combitCRM.SDK.WindowsClient.v13.ts:4323
[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.v13.ts:4331