AjaxUploadManager | FORMCYCLE 7.2.1 - JavaScript für Formulare

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

- (container?: Formcycle.AjaxUploadManager.ElementReference): Promise<void>
- Parameters
  - Optional container: Formcycle.AjaxUploadManager.ElementReference
  Returns Promise<void>

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

- (element: ElementReference, data: Blob, fileName: string): Promise<void>
- Parameters
  - element: ElementReference
  - data: Blob
  - fileName: string
  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

- (container?: Formcycle.AjaxUploadManager.ElementReference): Promise<void>
- Parameters
  - Optional container: Formcycle.AjaxUploadManager.ElementReference
  Returns Promise<void>

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

- (container: Formcycle.AjaxUploadManager.ElementReference): Promise<void>
- Parameters
  - container: Formcycle.AjaxUploadManager.ElementReference
  Returns Promise<void>

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

- (container: Formcycle.AjaxUploadManager.ElementReference): void
- Parameters
  - container: Formcycle.AjaxUploadManager.ElementReference
  Returns void

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

- (container?: ElementReference): number
- Parameters
  - Optional container: ElementReference
  Returns number

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

- (container?: ElementReference): FileItem | undefined
- Parameters
  - Optional container: ElementReference
  Returns FileItem | undefined

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

- (container?: ElementReference): FileItem[]
- Parameters
  - Optional container: ElementReference
  Returns FileItem[]

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

- (container: Formcycle.AjaxUploadManager.ElementReference): boolean
- Parameters
  - container: Formcycle.AjaxUploadManager.ElementReference
  Returns boolean

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

- (element: ElementReference): Promise<void>
- Parameters
  - element: ElementReference
  Returns Promise<void>

restoreUploads

restoreUploads: function

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

Type declaration

- (container: Formcycle.AjaxUploadManager.ElementReference): void
- Parameters
  - container: Formcycle.AjaxUploadManager.ElementReference
  Returns void

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

- (container: Formcycle.AjaxUploadManager.ElementReference): void
- Parameters
  - container: Formcycle.AjaxUploadManager.ElementReference
  Returns void

Index

Interfaces

Type aliases

Properties

Type aliases

ElementReference

EventListener

Type declaration

Parameters

data: Data

Returns void

FileItemState

Properties

abortAll

Type declaration

Parameters

Optional container: Formcycle.AjaxUploadManager.ElementReference

Returns Promise<void>

addUpload

Type declaration

Parameters

element: ElementReference

data: Blob

fileName: string

Returns Promise<void>

awaitAll

Type declaration

Parameters

Optional container: Formcycle.AjaxUploadManager.ElementReference

Returns Promise<void>

disable

Type declaration

Parameters

container: Formcycle.AjaxUploadManager.ElementReference

Returns Promise<void>

enable

Type declaration

Parameters

container: Formcycle.AjaxUploadManager.ElementReference

Returns void

events

Type declaration

getPendingUploadCount

Type declaration

Parameters

Optional container: ElementReference

Returns number

getUpload

Type declaration

Parameters

Optional container: ElementReference

Returns FileItem | undefined

getUploads

Type declaration

Parameters

Optional container: ElementReference

Returns FileItem[]

isAjaxUploadEnabled

Type declaration

Parameters

container: Formcycle.AjaxUploadManager.ElementReference

Returns boolean

removeUpload

Type declaration

Parameters

element: ElementReference

Returns Promise<void>

restoreUploads

Type declaration

Parameters

container: Formcycle.AjaxUploadManager.ElementReference

Returns void

stop

Type declaration

Parameters

container: Formcycle.AjaxUploadManager.ElementReference

Returns void