ScriptContext

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4266

ScriptContext. Dient dem Austausch von Daten zwischen mehreren Scripten.

Implementiert

• AsyncDisposable
• Disposable

Eigenschaften

IsDisposed

Abfragesignatur

get IsDisposed(): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4286

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

---

PropertyCount

Abfragesignatur

get PropertyCount(): number;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4280

Gibt die Anzahl der im ScriptContext hinterlegten Eigenschaften zurück.

Rückgabewert

number

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4411

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

---

[dispose]()

dispose: void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4422

Standardimplementierung des Dispose Symbols

Rückgabewert

void

Implementierung von

Disposable.[dispose]

---

ClearProperties()

ClearProperties(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4309

Entfernt alle Eigenschaften aus dem ScriptContext.

Rückgabewert

void

---

Dispose()

Dispose(): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4416

Standardimplementierung des Dispose

Rückgabewert

void

---

DisposeAsync()

DisposeAsync(): Promise<void>;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4405

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

---

ExecuteScriptByCode()

ExecuteScriptByCode(code): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4319

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

---

ExecuteScriptByFileName()

ExecuteScriptByFileName(scriptFilePath): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4329

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

---

GetProperty()

Aufrufsignatur

GetProperty(key, defaultValue?): unknown;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4340

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

Aufrufsignatur

GetProperty(index, defaultValue?): unknown;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4348

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

---

GetPropertyKey()

GetPropertyKey(index): string;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4368

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

---

RemoveProperty()

Aufrufsignatur

RemoveProperty(key): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4378

Entfernt die Eigenschaft mit dem Identifikator 'key', falls vorhanden.

Parameter

Parameter	Type	Description
key	string	Identifikator der Eigenschaft.

Rückgabewert

boolean

Aufrufsignatur

RemoveProperty(index): boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4385

Entfernt die Eigenschaft mit dem Index 'index', falls vorhanden.

Parameter

Parameter	Type	Description
index	number	Identifikator der Eigenschaft.

Rückgabewert

boolean

---

SetProperty()

SetProperty(key, value): void;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4399

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

---

[hasInstance]()

static hasInstance: boolean;

Definiert in: sdk/combitCRM.SDK.WindowsClient.v13.ts:4430

Symbol.hasInstance welches eine benutzerdefinierte Überprüfung der 'instanceof'-Operation für Objekte ermöglicht.

Parameter

Parameter	Type
value	any

Rückgabewert

boolean