Zum Hauptinhalt springen
Version: 1.24.291.1343

ViewConfig

Ansicht

Implementiert

  • AsyncDisposable

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:15519


DBTableName

get DBTableName(): string

Liefert den Datenbank-Tabellennamen der Ansicht zurück

Rückgabewert

string

Definiert in

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


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:15550


FamilyName

get FamilyName(): string

Liefert den definierten Familiennamen der Ansicht zurück.

Rückgabewert

string

Definiert in

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


FldCount

get FldCount(): number

Liefert die Anzahl der Felder zurück.

Rückgabewert

number

Definiert in

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


IsDisposed

get IsDisposed(): boolean

Gibt an, ob das Objekt bereits Freigegeben wurde

Rückgabewert

boolean

Definiert in

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


Name

get Name(): string

Liefert den Namen der definierten Ansicht zurück.

Rückgabewert

string

Definiert in

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


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:15587


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:15596


RowIDFldName

get RowIDFldName(): string

Liefert die echte RowID-Spalte zurück.

Rückgabewert

string

Definiert in

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


SortOrderCount

get SortOrderCount(): number

Liefert die Anzahl der definierten Sortierungen zurück.

Rückgabewert

number

Definiert in

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


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:15627

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:15658


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:15687

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:15706


DisposeAsync()

DisposeAsync(): Promise<void>

Standardimplementierung des AsyncDispose

Rückgabewert

Promise<void>

Definiert in

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


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:15787


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:15797


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:15807


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:15821


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:15831


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:15841


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:15851


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:15865


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:15885


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:15875


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:15895


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:15905


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:15916


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:15927


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:15938


[asyncDispose]()

asyncDispose: Promise<void>

Standardimplementierung des AsyncDispose Symbols

Rückgabewert

Promise<void>

Implementierung von

AsyncDisposable.[asyncDispose]

Definiert in

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


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