Module AjaxUploadManager

Namensraum mit Typen und Schnittstellen für das Hochladen von Dateien über AJAX.

Index

Interfaces

Type aliases

Properties

Type aliases

ElementReference

ElementReference: string | HTMLElement | Document | JQuery<HTMLElement> | JQuery<Document>

Referenz auf ein DOM-Element. Ein String wird als CSS-Selektor interpretiert.

EventListener

EventListener: function

Eine Rückruffunktion zum Lauschen auf Ereignisse, welche einen einzelnen Parameter nimmt und keinen Rückgabewert haben sollte.

param

Daten, welche von der Ereignisquelle bereit gestellt werden.

Type declaration

    • (data: Data): void

    • Parameters

      • data: Data

      Returns void

FileItemState

FileItemState: UploadStateEntry<"pending", UploadPendingData> | UploadStateEntry<"pendingRemoval", UploadPendingRemovalData> | UploadStateEntry<"success", UploadSuccessData> | UploadStateEntry<"failure", UploadErrorData>

Mögliche Zustände eines Hochladevorgangs.

  • pending - Wenn die Datei dabei ist, hochgeladen zu werden.
  • success - Wenn die file erfolgreich hochgeladen wurde.
  • failure - Wenn das Hochladen nicht erfolgreich war.
  • pendingRemoval - Wenn eine bereits hochgeladene Datei entfernt wird.

Properties

abortAll

abortAll: function
param

Behälter mit den Dateien zum Hochladen über AJAX, in der Regel das xm-form.

returns

Ein Versprechen, welches vollfüllt wird, sobald alle hochgeladenen Dateien fertig abgebrochen sind.

Type declaration

addUpload

addUpload: function
param

Ein oder mehrere Element zum Hochladen von Dateien.

param

Daten der Datei.

param

Name der Datei.

returns

Ein Versprechen, welches erfüllt wird, wenn alle Dateien erfolgreich hochgeladen wurden.

Type declaration

    • Parameters

      Returns Promise<void>

awaitAll

awaitAll: function
param

Behälter mit den Dateien zum Hochladen über AJAX, in der Regel das xm-form.

returns

Ein Versprechen, welches erfüllt wird, sobald alle hochgeladenen Dateien fertig sind.

Type declaration

disable

disable: function

Deaktiviert das Hochladen von Dateien über AJAX. Bricht ausstehende Hochladeprozesse ab, entfernt bereits hochgeladene Dateien und startet keine neuen Hochladeprozesse mehr.

Muss mit dem gleichen Behälter aufgerufen werden, der auch AjaxUploadManager.enable. übergeben wurde.

param

Behälter mit den Dateien zum Hochladen über AJAX, in der Regel das xm-form.

returns

Ein Versprechen, welches erfüllt wird, sobald alle Dateien fertig hochgeladen sind.

Type declaration

enable

enable: function

Aktiviert das Hochladen von Dateien über AJAX. Es wird Ereignisdelegation verwendet, sodass innerhalb des Containers nach dem Aufrufen dieser Funktion dynamisch hinzugefügt werden können.

param

Behälter mit den Dateien zum Hochladen über AJAX, in der Regel das xm-form.

Type declaration

events

events: object

Objekt mit Ereignissen, auf die mithilfe einer Rückruffunktion gelauscht werden kann.

Type declaration

getPendingUploadCount

getPendingUploadCount: function
param

Behälter mit den Dateien zum Hochladen über AJAX, in der Regel das xm-form.

returns

Die Anzahl ausstehender hochzuladender Dateien.

Type declaration

getUpload

getUpload: function
param

Behälter mit den Dateien zum Hochladen über AJAX, in der Regel das xm-form.

returns

Das erste Element einer hochzuladenden Datei im übergebenen Behältern, oder undefined falls kein solches Element existiert.

Type declaration

getUploads

getUploads: function
param

Behälter mit den Dateien zum Hochladen über AJAX, in der Regel das xm-form.

returns

Alle Elemente hochzuladender Dateien im übergebenen Behälter.

Type declaration

isAjaxUploadEnabled

isAjaxUploadEnabled: function

Prüft, ob die AJAX-Funktionalität für das gegebene Element zum Hochladen von Dateien verfügbar ist. Wenn diese Methode false zurückliefert, sollten andere Methodes wie etwa getUpload nicht verwendet werden.

param

Behälter mit den Dateien zum Hochladen über AJAX, in der Regel das xm-form.

returns

true wenn es sich bei dem Element um ein Element zum Hochladen von Dateien handelt und die AJAX-Funktionalität aktiviert ist; andernfalls wird false zurückgeliefert.

Type declaration

removeUpload

removeUpload: function

Stoppt den Hochladevorgang, falls einer solche gerade läuft, oder entfernt die hochgeladene Datei vom Server, falls schon eine hochgeladene Datei existiert.

param

Ein oder mehrere Element zum Hochladen von Dateien.

returns

Ein Versprechen, welches erfüllt wird, wenn alle Dateien erfolgreich entfernt wurden.

Type declaration

restoreUploads

restoreUploads: function
param

Behälter mit den Dateien zum Hochladen über AJAX, in der Regel das xm-form.

Type declaration

stop

stop: function

Deaktiviert das Hochladen von Dateien über AJAX, aber lässt ausstehende Hochladeprozesse und bereits hochgeladene Dateien unberührt.

Muss mit dem gleichen Behälter aufgerufen werden, der auch AjaxUploadManager.enable. übergeben wurde.

param

Behälter mit den Dateien zum Hochladen über AJAX, in der Regel das xm-form.

Type declaration