formcycle 8.3.6 - JavaScript für Formulare
    Bereite Suchindex vor...

    Schnittstelle AjaxUploadManager

    Hilfsfunktionen für über AJAX hochzuladende Dateien.

    interface AjaxUploadManager {
        abortAll: (container?: ElementReference) => Promise<void>;
        addUpload: (
            element: ElementReference,
            data: Blob,
            fileName: string,
        ) => Promise<void>;
        awaitAll: (container?: ElementReference) => Promise<void>;
        disable: (container: ElementReference) => Promise<void>;
        enable: (container: ElementReference) => void;
        events: {
            begin: EventSource<
                ElementReference,
                { data: Blob; field: JQuery; fileName: string; id: string },
            >;
            cancel: EventSource<ElementReference, { field: JQuery; id: string }>;
            clearError: EventSource<ElementReference, { field: JQuery; id: string }>;
            complete: EventSource<
                ElementReference,
                { container: JQuery; field: JQuery },
            >;
            error: EventSource<
                ElementReference,
                { error: Error; field: JQuery; id: string },
            >;
            progress: EventSource<
                ElementReference,
                { field: JQuery; id: string; progress: UploadRatio },
            >;
            remove: EventSource<ElementReference, { field: JQuery; id: string }>;
            restore: EventSource<
                ElementReference,
                { field: JQuery; id: string; item: FileItem },
            >;
            success: EventSource<
                ElementReference,
                { field: JQuery; id: string; item: FileItem },
            >;
        };
        getPendingUploadCount: (container?: ElementReference) => number;
        getUpload: (container?: ElementReference) => FileItem;
        getUploads: (container?: ElementReference) => FileItem[];
        isAjaxUploadEnabled: (container: ElementReference) => boolean;
        removeUpload: (element: ElementReference) => Promise<void>;
        restoreUploads: (container: ElementReference) => void;
        stop: (container: ElementReference) => void;
    }
    Index

    Eigenschaften

    abortAll addUpload awaitAll disable enable events getPendingUploadCount getUpload getUploads isAjaxUploadEnabled removeUpload restoreUploads stop

    Eigenschaften

    abortAll: (container?: ElementReference) => Promise<void>

    Typendeklaration

      • (container?: ElementReference): Promise<void>

      • Parameter

        • Optionalcontainer: ElementReference

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

        Rückgabewert Promise<void>

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

    addUpload: (
        element: ElementReference,
        data: Blob,
        fileName: string,
    ) => Promise<void>

    Typendeklaration

      • (element: ElementReference, data: Blob, fileName: string): Promise<void>

      • Parameter

        • element: ElementReference

          Ein oder mehrere Element zum Hochladen von Dateien.

        • data: Blob

          Daten der Datei.

        • fileName: string

          Name der Datei.

        Rückgabewert Promise<void>

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

    awaitAll: (container?: ElementReference) => Promise<void>

    Typendeklaration

      • (container?: ElementReference): Promise<void>

      • Parameter

        • Optionalcontainer: ElementReference

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

        Rückgabewert Promise<void>

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

    disable: (container: ElementReference) => Promise<void>

    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.

    Typendeklaration

      • (container: ElementReference): Promise<void>

      • Parameter

        • container: ElementReference

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

        Rückgabewert Promise<void>

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

    enable: (container: ElementReference) => void

    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.

    Typendeklaration

      • (container: ElementReference): void

      • Parameter

        • container: ElementReference

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

        Rückgabewert void

    events: {
        begin: EventSource<
            ElementReference,
            { data: Blob; field: JQuery; fileName: string; id: string },
        >;
        cancel: EventSource<ElementReference, { field: JQuery; id: string }>;
        clearError: EventSource<ElementReference, { field: JQuery; id: string }>;
        complete: EventSource<
            ElementReference,
            { container: JQuery; field: JQuery },
        >;
        error: EventSource<
            ElementReference,
            { error: Error; field: JQuery; id: string },
        >;
        progress: EventSource<
            ElementReference,
            { field: JQuery; id: string; progress: UploadRatio },
        >;
        remove: EventSource<ElementReference, { field: JQuery; id: string }>;
        restore: EventSource<
            ElementReference,
            { field: JQuery; id: string; item: FileItem },
        >;
        success: EventSource<
            ElementReference,
            { field: JQuery; id: string; item: FileItem },
        >;
    }

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

    Typendeklaration

    • begin: EventSource<
          ElementReference,
          { data: Blob; field: JQuery; fileName: string; id: string },
      >

      Wenn eine Datei ausgewählt wurde und das Hochladen begonnen hat.

    • cancel: EventSource<ElementReference, { field: JQuery; id: string }>

      Wenn ein Hochladeprozess abgebrochen wurde.

    • clearError: EventSource<ElementReference, { field: JQuery; id: string }>

      Wenn die Fehlernachricht an einem Element zum Hochladen von Dateien entfernt wurde.

    • complete: EventSource<ElementReference, { container: JQuery; field: JQuery }>

      Wenn alle ausstehenden Hochladeprozesse fertig sind, egal auf welche Art diese beendet wurden (Erfolg oder Misserfolg). Wenn eine Hochladeprozess fertig wird, tritt dieses Ereignis mit dem höchsten übergeordneten Element zum Hochladen von Dateien ein, in dem keine ausstehenden Hochladeprozesse mehr enthalten sind.

    • error: EventSource<ElementReference, { error: Error; field: JQuery; id: string }>

      Wenn ein Hochladeprozess fehlerhaft beendet wurde.

    • progress: EventSource<
          ElementReference,
          { field: JQuery; id: string; progress: UploadRatio },
      >

      Wenn ein Hochladeprozess Fortschritt gemacht hat.

    • remove: EventSource<ElementReference, { field: JQuery; id: string }>

      Wenn eine hochgeladene Datei entfernt wurde.

    • restore: EventSource<ElementReference, { field: JQuery; id: string; item: FileItem }>

      Wenn eine über AJAX hochgeladene Datei wiederhergestellt wurde. Wird etwa verwendet, wenn eine abgsendetes Formular aufgrund der Servervalidierung abgewiesen wurde und wieder ausgeliefert wird.

    • success: EventSource<ElementReference, { field: JQuery; id: string; item: FileItem }>

      Wenn eine Datei erfolgreich hochgeladen wurde.

    getPendingUploadCount: (container?: ElementReference) => number

    Typendeklaration

      • (container?: ElementReference): number

      • Parameter

        • Optionalcontainer: ElementReference

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

        Rückgabewert number

        Die Anzahl ausstehender hochzuladender Dateien.

    getUpload: (container?: ElementReference) => FileItem

    Typendeklaration

      • (container?: ElementReference): FileItem

      • Parameter

        • Optionalcontainer: ElementReference

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

        Rückgabewert FileItem

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

    getUploads: (container?: ElementReference) => FileItem[]

    Typendeklaration

      • (container?: ElementReference): FileItem[]

      • Parameter

        • Optionalcontainer: ElementReference

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

        Rückgabewert FileItem[]

        Alle Elemente hochzuladender Dateien im übergebenen Behälter.

    isAjaxUploadEnabled: (container: ElementReference) => boolean

    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.

    Typendeklaration

      • (container: ElementReference): boolean

      • Parameter

        • container: ElementReference

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

        Rückgabewert boolean

        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.

    removeUpload: (element: ElementReference) => Promise<void>

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

    Typendeklaration

      • (element: ElementReference): Promise<void>

      • Parameter

        Rückgabewert Promise<void>

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

    restoreUploads: (container: ElementReference) => void

    Typendeklaration

      • (container: ElementReference): void

      • Parameter

        • container: ElementReference

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

        Rückgabewert void

    stop: (container: ElementReference) => void

    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.

    Typendeklaration

      • (container: ElementReference): void

      • Parameter

        • container: ElementReference

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

        Rückgabewert void

    Einstellungen

    Member-Sichtbarkeit

    Auf dieser Seite

    Eigenschaften