DocMngr
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:2246
Dokumentenzugriff
Extends
ExtendedCRMObjectBase<DocMngr>
Eigenschaften
_instance
protected _instance: DocMngr;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:12
Abgeleitet von
ExtendedCRMObjectBase._instance
className
protected readonly className: string;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:16
Abgeleitet von
ExtendedCRMObjectBase.className
lastErrorAsync
Abfragesignatur
get lastErrorAsync(): Promise<OLEError>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:2269
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:2250
Parameter
| Parameter | Type | Default value |
|---|---|---|
docMngr | DocMngr | undefined |
combitCRMVersion | number | CRMVersion | undefined |
disposeInstance | boolean | true |
Rückgabewert
DocMngr
Überschreibt
ExtendedCRMObjectBase<CoreCRM.DocMngr>.constructor
Methoden
[asyncDispose]()
asyncDispose: Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:93
Rückgabewert
Promise<void>
Abgeleitet von
ExtendedCRMObjectBase.[asyncDispose]
[dispose]()
dispose: void;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:88
Rückgabewert
void
Abgeleitet von
ExtendedCRMObjectBase.[dispose]
appendFileAsync()
appendFileAsync(
record,
relation,
filePath,
docDescriptionConfig): Promise<boolean>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:2286
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
| Parameter | Type | Description |
|---|---|---|
record | Record | Datensatz-Objekt, zu dem ein relationaler Datensatz angehängt werden soll |
relation | Relation | Relations-Objekt, in dem der neue relationale Datensatz mit der angehängten Datei eingefügt wird |
filePath | string | Datei, welche hinzugefügt werden soll (gesamter Pfad + Dateiname). |
docDescriptionConfig | string | Dateiendung 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:2331
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
| Parameter | Type | Description |
|---|---|---|
viewName | string | Name der Ansicht, zu der ein relationaler Datensatz angehängt werden soll, z.B. Firmen |
recordId | string | Datensatz-ID, zu der ein relationaler Datensatz angehängt werden soll. |
relationToken | string | Relation, zu der ein neuer relationaler Datensatz mit der angehängten Datei eingefügt werden soll, z.B.ID.Aktivitäten.ContactID |
filePath | string | Datei, welche hinzugefügt werden soll (gesamter Pfad + Dateiname). |
docDescriptionConfig | string | Dateiendung 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:2308
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
| Parameter | Type | Description |
|---|---|---|
record | Record | Datensatz-Objekt, zu dem ein relationaler Datensatz angehängt werden soll |
relation | Relation | Relations-Objekt, in dem der neue relationale Datensatz mit der angehängten Datei eingefügt wird |
filePath | string | Datei, welche hinzugefügt werden soll (gesamter Pfad + Dateiname). |
docDescriptionConfig | string | Dateiendung 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:72
Rückgabewert
void
Abgeleitet von
ExtendedCRMObjectBase.dispose
disposeAsync()
disposeAsync(): Promise<void>;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:56
Rückgabewert
Promise<void>
Abgeleitet von
ExtendedCRMObjectBase.disposeAsync
guardDisposed()
protected guardDisposed(): void;
Definiert in: lib/combitCRM.SDK.v13.Extended.ts:29
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:51
Gibt an, ob die Instanz bereits freigegeben wurde.
Rückgabewert
boolean
true wenn die Instanz bereits freigegeben wurde, andernfalls false.
Abgeleitet von
ExtendedCRMObjectBase.isDisposed