WebMasterService N3rds@Work

Psource Mediathek API-Handbuch

Du siehst derzeit eine Revision mit dem Titel "Psource Mediathek API-Handbuch", die von DerN3rd auf 8. September 2021 um 17:11 gespeichert wurde.
Titel
Psource Mediathek API-Handbuch
Inhalt
Willkommen beim Lifecycle-Leitfaden für MediaPress-Uploader-Ereignisse. Der Leitfaden richtet sich an Entwickler, die ihre eigene Upload-Erfahrung mit MediaPress erstellen möchten. MediaPress verwendet plupload.Uploader zum Hochladen von Dateien. Es ist die gleiche Bibliothek, die von WordPress verwendet (und damit gebündelt) wird. Wir haben eine Container-Klasse psmt.Uploader. Die verschiedenen Instanzen von psmt.Uploader ermöglichen uns das Hochladen von Dateien. Hinweis:  Alle auf dieser Seite aufgelisteten Ereignisse werden vom MediaPress-Uploader (psmt.Uploader) für das Dokumentobjekt ausgelöst. Liste der Phasen, in die Sie sich einklinken können.
  • Auf Dateiauswahl
  • Beim Upload-Start
  • Beim Upload-Fortschritt
  • Bei erfolgreichem Upload
  • Bei allen Upload abgeschlossen
  • Bei Fehler
Für alle auf dieser Seite aufgeführten Ereignisse erhält jeder gebundene Ereignis-Listener-Callback das Event-Objekt als ersten Parameter (Du wirst es meistens ignorieren) und eine Instanz von psmt.Uploader als zweiten Parameter. Der Rest der Parameter wird durch die Ereignisse bestimmt, an die Du Dich anschließen musst. Außerdem werden die Ereignisse auf dem Dokumentobjekt  ausgelöst. Die Ereignis-Listener sollten an das Dokumentobjekt gebunden sein, um das Ereignis korrekt abzufangen.

Bei Dateiauswahl:

Sobald der Benutzer eine oder mehrere Dateien auswählt, werden die Dateien unserer Upload-Warteschlange hinzugefügt. psmt.Uploader löst nach der Dateiauswahl zwei Ereignisse aus.
  • psmt:uploader:file.added : Wird ausgelöst, wenn eine Datei zur Upload-Warteschlange hinzugefügt wird. Es wird für jede Datei der Auswahl ausgelöst (bei Mehrfachauswahl)
  • psmt:uploader:files.added : Dieses Ereignis wird ausgelöst, wenn alle Dateien aus der Auswahl erfolgreich zur Upload-Warteschlange hinzugefügt wurden.

psmt:uploader:file.added :

Ein an dieses Ereignis gebundener Zuhörer erhält 3 Argumente
  • Ereignisobjekt.
  • psmt.Uploader-Instanz
  • Datei Backbone.Model-Instanz
Beispiel: Anhängen eines Listeners mit Javascript. Wenn Du wissen möchtest, welcher Uploader dies ausgelöst hat (z. B. arbeiten wir mit Aktivitäts-Upload oder Galerie-Upload oder Shortcode-Upload usw.), lies bitte die Anleitung, um dies zu bestimmen .

psmt:uploader:files.added :

Es wird ausgelöst, wenn alle ausgewählten Dateien zur Upload-Warteschlange hinzugefügt wurden. Ein an dieses Ereignis gebundener Zuhörer erhält die folgenden Argumente
  • Ereignisobjekt
  • psmt.Uploader-Objekt
  • plupload.Uploader-Instanz
Beispiel:

Beim Hochladen-Start:

Bevor der Upload für jede der Dateien beginnt, wird das folgende Ereignis ausgelöst
  • psmt:uploader:before.upload
Der gebundene Hörer erhält folgende Argumente
  • Ereignisobjekt
  • psmt.Uploader-Instanz
  • plupload.Uploader-Instanz
  • Datei Backbone.Model-Instanz
Du kannst diesen Hook verwenden, um das Hochladen einer Datei zu stoppen. Beispiel:  

Beim Upload-Fortschritt:

Wenn Du Hooks benötigst, um den Fortschritt hochzuladen und etwas zu tun, kannst Du das Ereignis verwenden:
  • psmt:uploader:upload.progress
Der gebundene Listener erhält folgende Argumente:
  • Ereignisobjekt
  • psmt.Uploader-Instanz
  • Anhang: - Backbone-Modellobjekt, das Details zur hochgeladenen Datei enthält.
Das Ereignis gibt Dir Zugriff auf psmt.Uploader und das Attachment-Objekt. Im Anhang kannst Du nach den Eigenschaften "loaded", "percent" suchen, um den Upload-Fortschritt zu überprüfen. Beispiel:  

Bei erfolgreichem Upload:

Wenn eine Datei erfolgreich hochgeladen wurde, wird das folgende Ereignis dafür ausgelöst
  •  psmt:uploader:upload.success
Dies wird sogar für jede Datei einzeln ausgelöst. Der an dieses Ereignis angehängte Listener erhält folgende Argumente
  • Ereignisobjekt
  • psmt.Uploader-Instanz
  • Anhang: - Backbone-Modellobjekt, das Details zur hochgeladenen Datei enthält.
Beispiel:

Bei allen Upload abgeschlossen:

Wenn alle Dateien aus der aktuellen Warteschlange hochgeladen wurden, löst der Uploader das Ereignis aus:
  • psmt:uploader:upload.complete
Ein daran angeschlossener Zuhörer erhält 4 Argumente
  • Ereignisobjekt
  • psmt.Uploader-Instanz
  • plupload.Uploader-Instanz
  • Backbone-Sammlung von Dateien.
Beispiel:

Bei Fehler:

Bei allen Arten von Fehlern (möglicherweise ein Fehler bei der Dateiauswahl oder beim Upload-Fehler) löst PS Mediathek ' psmt:uploader:error ' aus. Der an dieses Ereignis angehängte Listener erhält 4 Argumente
  • Ereignisobjekt
  • psmt.Uploader-Instanz
  • Nachrichtenzeichenfolge
  • Datenobjekt
  • Dateiobjekt
Beispiel:  

Überprüfung des Uploader-Typs:

In allen Listenern erhältst Du als zweites Argument die Instanz des aktuellen MediaPress-Uploaders. Du musst Dich nicht um die Uploader-Prüfung kümmern, wenn Du bei allen Uploads eine Aktion ausführen möchtest, unabhängig davon, ob sie gerade hochgeladen werden. Es kann vorkommen, dass Du feststellen möchtest, welcher Uploader verwendet wurde (war es ein Galerie-Upload oder geschah es auf Aktivität?). Bevor wir es bestimmen, musst Du die Art der psmt.Uploader-Instanzen kennen, die von PS Mediathek verwendet werden. InPS Mediathek erstellen wir mehrere Instanzen des psmt.Uploader zum Hochladen in Aktivität, einzelne Galerie, mit Shortcode, Cover-Upload. Hier ist die Liste des Instanzobjekts.
  • psmt.activity_uploader : unser Aktivitäts-Uploader.
  • psmt.guploader : Galerie-Uploader
  • psmt.shortcode_uploader : Shortcode-Uploader
  • psmt.cover_uploader : Cover-Uploader
Um den Typ des Uploaders zu bestimmen, vergleiche das 2. Argument mit einem der obigen Argumente. Wenn ich beispielsweise überprüfen möchte, ob der Upload von der Aktivität abgeschlossen ist, gehe ich wie folgt vor:

Auszug


Alt Neu Datum erstellt Author Actions
8. September 2021 um 15:57 DerN3rd
8. September 2021 um 15:25 DerN3rd
8. September 2021 um 15:11 DerN3rd
8. September 2021 um 14:56 DerN3rd
6. Januar 2021 um 00:20 DerN3rd