Zum Hauptinhalt springen
Version: 1.24.334.1201

ViewConfig

Ansicht

Implementiert​

  • AsyncDisposable
  • Disposable

Eigenschaften​

AddressInfos​

get AddressInfos(): Promise<ListAddressInfos>

Liefert ein Objekt vom Typ ListAddressInfos zurück

Rückgabewert​

Promise<ListAddressInfos>

Definiert in​

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


DBTableName​

get DBTableName(): string

Liefert den Datenbank-Tabellennamen der Ansicht zurück

Rückgabewert​

string

Definiert in​

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


DBTableType​

get DBTableType(): DBTableType

Liefert den Typ der Datenquelle die als Basis der Ansicht verwendet wird zurück.

Rückgabewert​

DBTableType

Definiert in​

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


FamilyName​

get FamilyName(): string

Liefert den definierten Familiennamen der Ansicht zurück.

Rückgabewert​

string

Definiert in​

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


FldCount​

get FldCount(): number

Liefert die Anzahl der Felder zurück.

Rückgabewert​

number

Definiert in​

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


IsDisposed​

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert​

boolean

Definiert in​

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


Name​

get Name(): string

Liefert den Namen der definierten Ansicht zurück.

Rückgabewert​

string

Definiert in​

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


PrimaryKeyFldName​

get PrimaryKeyFldName(): string

Liefert den Namen des Primärschlüsselfeldes, sofern der Primärschlüssel aus genau einem Feld besteht.

Rückgabewert​

string

Definiert in​

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


Relations​

get Relations(): Promise<ListRelations>

Liefert ein Objekt vom Typ ListRelations zurück

Rückgabewert​

Promise<ListRelations>

Definiert in​

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


RowIDFldName​

get RowIDFldName(): string

Liefert die echte RowID-Spalte zurück.

Rückgabewert​

string

Definiert in​

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


SortOrderCount​

get SortOrderCount(): number

Liefert die Anzahl der definierten Sortierungen zurück.

Rückgabewert​

number

Definiert in​

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


SupportsRecycleBin​

get SupportsRecycleBin(): boolean

Liefert zurück, ob die Ansicht den Papierkorb unterstützt.

Rückgabewert​

boolean

Definiert in​

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

Methoden​

CodeDefinitions()​

CodeDefinitions(fieldName): Promise<ListCodeDefinitions>

Liefert für das übergebene Feld eine Collection ListCodeDefinitions der dafür hinterlegten Codedefinitionen.

Parameter​

ParameterTypeDescription
fieldNamestringPhysikalischer Feldname des gewünschten Feldes

Rückgabewert​

Promise<ListCodeDefinitions>

Definiert in​

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


CreateRecordSet()​

CreateRecordSet(sortOrder, cursorMode)​

CreateRecordSet(sortOrder?, cursorMode?): Promise<RecordSet>

Erzeugt ein Objekt vom Typ RecordSet . Es wird daher keine Ansicht visuell geöffnet.
Sollte es möglich sein die benötigten Daten per Filter einzuschränken sollte die Funktion CreateRecordSet(type: RecordSetFilterType, filter: string, sortOrder?: number, cursorMode?: CRMCursorMode) stattdessen verwendet werden.

Parameter​
ParameterTypeDescription
sortOrder?numberOptional Voreinstellung:0 (Keine Sortierung) - Angabe einer Sortierung die ausgeführt werden soll.
cursorMode?CRMCursorModeOptional 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>

Rückgabe: ViewConfig wenn der Zugriff möglich ist, andernfalls null

Remarks​

Version 12.0.0​

Verhaltensänderung. Der Standardparameter forwardOnly wurde von false auf SolutionDefault geändert.
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:16814

CreateRecordSet(type, filter, sortOrder, cursorMode)​

CreateRecordSet(
type,
filter,
sortOrder?,
cursorMode?): Promise<RecordSet>

Erzeugt ein Objekt vom Typ RecordSet . Es wird daher keine Ansicht visuell geöffnet.

Parameter​
ParameterTypeDescription
typeRecordSetFilterTypeFiltertyp
filterstringFiltercontext
sortOrder?numberOptional Voreinstellung:0 (Keine Sortierung) - Angabe einer Sortierung die ausgeführt werden soll.
cursorMode?CRMCursorModeOptional 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>

Rückgabe: ViewConfig wenn der Zugriff möglich ist, andernfalls null

Remarks​

Version 12.0.0​

Verhaltensänderung. Der Standardparameter forwardOnly wurde von false auf SolutionDefault geändert.
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:16833


Dispose()​

Dispose(): void

Standardimplementierung des Dispose

Rückgabewert​

void

Definiert in​

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


DisposeAsync()​

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert​

Promise<void>

Definiert in​

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


DupeCheckCriteria()​

DupeCheckCriteria(): Promise<string>

Liefert die Felder, welche für die Dublettenprüfung verwenden werden, als TAB-separierte Liste zurück.

Rückgabewert​

Promise<string>

Definiert in​

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


FldAlias()​

FldAlias(index): Promise<string>

Liefert den Aliasnamen des Feldes zurück, das als fortlaufende Nummer übergeben wurde. Ist der Aliasname leer, wird der entsprechende physikalische Feldname zurückgegeben.

Parameter​

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert​

Promise<string>

Definiert in​

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


FldAliasByName()​

FldAliasByName(name): Promise<string>

Liefert den Aliasnamen des Feldes zurück, dessen physikalischer Feldname übergeben wurde. Ist der Aliasname leer, wird der entsprechende physikalische Feldname zurückgegeben.

Parameter​

ParameterTypeDescription
namestringPhysikalischer Feldname des gewünschten Feldes.

Rückgabewert​

Promise<string>

Definiert in​

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


FldCaseSensitive()​

FldCaseSensitive(index): Promise<boolean>

Überprüft, ob bei einem übergebenen Feld die Groß- und Kleinschreibung beachtet wird.

Parameter​

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert​

Promise<boolean>

Remarks​

Version 12.0.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:16943


FldDec()​

FldDec(index): Promise<number>

Liefert die Anzahl der Dezimalstellen des Feldes zurück, das als fortlaufende Nummer übergeben wurde.

Parameter​

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert​

Promise<number>

Definiert in​

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


FldExists()​

FldExists(name): Promise<boolean>

Überprüft, ob ein Feld in der Ansicht existiert.

Parameter​

ParameterTypeDescription
namestringÜbergabe des zu überprüfenden Feldnamens.

Rückgabewert​

Promise<boolean>

Definiert in​

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


FldGDPRActive()​

FldGDPRActive(index): Promise<boolean>

Liefert den Datenschutz-Status des Feldes zurück, das als fortlaufende Nummer übergeben wurde.

Parameter​

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert​

Promise<boolean>

Definiert in​

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


FldIndex()​

FldIndex(fieldName): Promise<number>

Liefert den Index des Feldes zurück.

Parameter​

ParameterTypeDescription
fieldNamestringPhysikalischer Name des Feldes.

Rückgabewert​

Promise<number>

Remarks​

Version 12.0.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:16987


FldLen()​

FldLen(index): Promise<number>

Liefert die Zeichenlänge des Feldes zurück, das als fortlaufende Nummer übergeben wurde.

Parameter​

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert​

Promise<number>

Definiert in​

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


FldName()​

FldName(index): Promise<string>

Liefert den Namen des Feldes zurück, das als fortlaufende Nummer übergeben wurde.

Parameter​

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert​

Promise<string>

Definiert in​

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


FldReadOnly()​

FldReadOnly(index): Promise<boolean>

Überprüft, ob ein Feld gesetzt (verändert) werden darf.

Parameter​

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert​

Promise<boolean>

Definiert in​

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


FldType()​

FldType(index): Promise<FldType>

Liefert den internen Typ des Feldes zurück.

Parameter​

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert​

Promise<FldType>

Definiert in​

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


FldTypePhys()​

FldTypePhys(index): Promise<FldTypePhys>

Liefert den physikalischen Feldtyp zurück.

Parameter​

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert​

Promise<FldTypePhys>

Definiert in​

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


FldTypePhysNative()​

FldTypePhysNative(index): Promise<string>

Liefert den physikalischen Namen des Feldtyps des übergebenen Feldes zurück.

Parameter​

ParameterTypeDescription
indexnumberDie fortlaufende Nummer des gewünschten Feldes in der Datenbankstruktur von 1 bis FldCount .

Rückgabewert​

Promise<string>

Definiert in​

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


SortOrderName()​

SortOrderName(index): Promise<string>

Liefert anhand der übergebenen Sortierung den Namen der Sortierung zurück.

Parameter​

ParameterTypeDescription
indexnumberÜbergabe der Sortierung 0= {ohne Sortierung}

Rückgabewert​

Promise<string>

Definiert in​

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


[asyncDispose]()​

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert​

Promise<void>

Implementierung von​

AsyncDisposable.[asyncDispose]

Definiert in​

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


[dispose]()​

dispose: void

Standardimplementierung des Dispose Symbols

Rückgabewert​

void

Implementierung von​

Disposable.[dispose]

Definiert in​

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


[hasInstance]()​

static hasInstance: boolean

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

Parameter​

ParameterType
valueany

Rückgabewert​

boolean

Definiert in​

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