Zum Hauptinhalt springen
Version: 25.143.1202.1

DocMngr

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:2245

Dokumentenzugriff

Extends

Eigenschaften

_instance

protected _instance: DocMngr;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:11

Abgeleitet von

ExtendedCRMObjectBase._instance

className

protected readonly className: string;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:15

Abgeleitet von

ExtendedCRMObjectBase.className

lastErrorAsync

Abfragesignatur

get lastErrorAsync(): Promise<OLEError>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:2268

Liefert ein OLEError -Objekt zurück.
32 - Schreibzugriff verweigert
33 - Kopieren der Datei fehlgeschlagen

Rückgabewert

Promise<OLEError>

Konstruktoren

Konstruktor

new DocMngr(
docMngr,
combitCRMVersion,
disposeInstance): DocMngr;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:2249

Parameter

ParameterTypeDefault value
docMngrDocMngrundefined
combitCRMVersionnumber | CRMVersionundefined
disposeInstancebooleantrue

Rückgabewert

DocMngr

Überschreibt

ExtendedCRMObjectBase<CoreCRM.DocMngr>.constructor

Methoden

[asyncDispose]()

asyncDispose: Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:92

Rückgabewert

Promise<void>

Abgeleitet von

ExtendedCRMObjectBase.[asyncDispose]

[dispose]()

dispose: void;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:87

Rückgabewert

void

Abgeleitet von

ExtendedCRMObjectBase.[dispose]

appendFileAsync()

appendFileAsync(
record,
relation,
filePath,
docDescriptionConfig): Promise<boolean>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:2285

Fügt einen neuen relationalen Datensatz mit einer Datei hinzu. Die Datei wird in das erste gefundene Dokumentenfeld der relationalen Ansicht geschrieben. Alle weiteren Felder werden ignoriert.
Dokumentenfelder: (eingebettete) Datei, (eingebettete) Grafik oder DMS Dokument.

Parameter

ParameterTypeDescription
recordRecordDatensatz-Objekt, zu dem ein relationaler Datensatz angehängt werden soll
relationRelationRelations-Objekt, in dem der neue relationale Datensatz mit der angehängten Datei eingefügt wird
filePathstringDatei, welche hinzugefügt werden soll (gesamter Pfad + Dateiname).
docDescriptionConfigstringDateiendung der zu verwendeten Dokumentenkonfiguration oder mit

Rückgabewert

Promise<boolean>

true wenn der relationale Datensatz mit der eingefügten Datei geschrieben werden konnte, andernfalls false


appendFileExt2Async()

appendFileExt2Async(
viewName,
recordId,
relationToken,
filePath,
docDescriptionConfig): Promise<Record>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:2330

Fügt einen neuen relationalen Datensatz mit einer Datei hinzu. Die Datei wird in das erste gefundene Dokumentenfeld der relationalen Ansicht geschrieben. Alle weiteren Felder werden ignoriert.
Dokumentenfelder: (eingebettete) Datei, (eingebettete) Grafik oder DMS Dokument.

Parameter

ParameterTypeDescription
viewNamestringName der Ansicht, zu der ein relationaler Datensatz angehängt werden soll, z.B. Firmen
recordIdstringDatensatz-ID, zu der ein relationaler Datensatz angehängt werden soll.
relationTokenstringRelation, zu der ein neuer relationaler Datensatz mit der angehängten Datei eingefügt werden soll, z.B.ID.Aktivitäten.ContactID
filePathstringDatei, welche hinzugefügt werden soll (gesamter Pfad + Dateiname).
docDescriptionConfigstringDateiendung der zu verwendeten Dokumentenkonfiguration oder mit

Rückgabewert

Promise<Record>

Rückgabe: Record des erstellten relationalen Datensatzes wenn der Datensatz angelegt werden konnte, andernfalls null


appendFileExtAsync()

appendFileExtAsync(
record,
relation,
filePath,
docDescriptionConfig): Promise<Record>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:2307

Fügt einen neuen relationalen Datensatz mit einer Datei hinzu. Die Datei wird in das erste gefundene Dokumentenfeld der relationalen Ansicht geschrieben. Alle weiteren Felder werden ignoriert.
Dokumentenfelder: (eingebettete) Datei, (eingebettete) Grafik oder DMS Dokument.

Parameter

ParameterTypeDescription
recordRecordDatensatz-Objekt, zu dem ein relationaler Datensatz angehängt werden soll
relationRelationRelations-Objekt, in dem der neue relationale Datensatz mit der angehängten Datei eingefügt wird
filePathstringDatei, welche hinzugefügt werden soll (gesamter Pfad + Dateiname).
docDescriptionConfigstringDateiendung der zu verwendeten Dokumentenkonfiguration oder mit

Rückgabewert

Promise<Record>

Rückgabe: Record des erstellten relationalen Datensatzes wenn der Datensatz angelegt werden konnte, andernfalls null


dispose()

dispose(): void;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:71

Rückgabewert

void

Abgeleitet von

ExtendedCRMObjectBase.dispose

disposeAsync()

disposeAsync(): Promise<void>;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:55

Rückgabewert

Promise<void>

Abgeleitet von

ExtendedCRMObjectBase.disposeAsync

guardDisposed()

protected guardDisposed(): void;

Definiert in: lib/combitCRM.SDK.v13.Extended.ts:28

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.v13.Extended.ts:50

Gibt an, ob die Instanz bereits freigegeben wurde.

Rückgabewert

boolean

true wenn die Instanz bereits freigegeben wurde, andernfalls false.

Abgeleitet von

ExtendedCRMObjectBase.isDisposed