API-Referenzseitenvorlage

Hinweis: Entfernen Sie diese gesamte erklärende Notiz vor der Veröffentlichung.

Seiten-Frontmatter:

Das Frontmatter am oberen Rand der Seite wird verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten entsprechend der speziellen Eigenschaft aktualisiert werden.

---
title: NameOfTheInterface
slug: Web/API/NameOfTheInterface
page-type: web-api-interface
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheInterface
---

title: Titelüberschrift, die oben auf der Seite angezeigt wird. Dies ist nur der Name der Schnittstelle. Zum Beispiel hat die Request Interface-Seite einen title von Request.
slug: Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/). Dies wird formatiert wie Web/API/NameOfTheParentInterface. Zum Beispiel ist der Request Slug "Web/API/Request".
page-type: Der page-type Schlüssel für Web/API-Schnittstellen ist immer web-api-interface.
status: Kennzeichen, die den Status dieses Features beschreiben. Ein Array, das eines oder mehrere der folgenden enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: Er wird automatisch basierend auf den Werten in den Kompatibilitätsdaten des Browsers für das Feature gesetzt. Siehe "Wie Feature-Status hinzugefügt oder aktualisiert werden".
browser-compat: Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheMethod durch den Abfragezeichenfolgewert der Methode im Browser compat data repo. Die Toolchain verwendet den Schlüssel automatisch, um die Abschnitte Kompatibilität und Spezifikation zu füllen (ersetzt die {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für die API-Methode in unserem Browser compat data repo erstellen/aktualisieren müssen, und der Eintrag für die API wird Spezifikationsinformationen enthalten müssen.

Siehe unseren Leitfaden, wie man dies macht.

Makros am oberen Rand der Seite

Eine Reihe von Makroaufrufen erscheinen am oberen Rand des Inhaltsbereichs (unmittelbar unter dem Seiten-Frontmatter).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es besteht keine Notwendigkeit, hinzuzufügen/zu entfernen):

{{SeeCompatTable}} — Dies erzeugt ein Dies ist eine experimentelle Technologie-Banner, das anzeigt, dass die Technologie experimentell ist. Wenn sie experimentell ist und die Technologie hinter einem Pref in Firefox verborgen ist, sollten Sie auch einen Eintrag dafür auf der Experimental features in Firefox Seite ausfüllen.
{{Deprecated_Header}} — Dies erzeugt ein Veraltet-Banner, das anzeigt, dass die Technologie veraltet ist.
{{Non-standard_Header}} — Dies erzeugt ein Nicht-standard-Banner, das anzeigt, dass das Feature nicht Teil einer Spezifikation ist.

Sie sollten die folgenden Makros gemäß den untenstehenden Hinweisen aktualisieren oder löschen:

{{SecureContext_Header}} — Dies erzeugt ein Sicherer Kontext-Banner, das anzeigt, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn nicht, können Sie den Makroaufruf entfernen. Wenn doch, sollten Sie auch einen Eintrag dafür auf der Features restricted to secure contexts Seite ausfüllen.
{{AvailableInWorkers}} — Dies erzeugt eine Verfügbar in Workern-Notiz, die anzeigt, dass die Technologie in einem Worker-Kontext verfügbar ist. Wenn sie nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn sie auch oder nur im Worker-Kontext verfügbar ist, müssen Sie möglicherweise einen Parameter hinzufügen, da sie aufgrund ihrer Verfügbarkeit (siehe {{AvailableInWorkers}} Makroquellcode für alle verfügbaren Werte) möglicherweise auf der Web APIs available in workers Seite einen Eintrag ausfüllen.
{{APIRef("GroupDataName")}} — Dies erzeugt die linke Referenz-Sidebar mit schnellen Referenzlinks, die mit der aktuellen Seite zusammenhängen. Zum Beispiel hat jede Seite in der WebVR API die gleiche Sidebar, die auf die anderen Seiten in der API verweist. Um die richtige Sidebar für Ihre API zu generieren, müssen Sie einen GroupData-Eintrag hinzufügen und den Namen des Eintrags im Makroaufruf anstelle von GroupDataName eintragen. Siehe unsere API-Referenz-Sidebars Anleitung für Informationen, wie dies zu tun ist.

Stellen Sie Statusheader-Makros nicht manuell bereit. Beziehen Sie sich auf den Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status zur Seite hinzuzufügen.

Muster der Sicherer Kontext, Verfügbar in Workern, Experimentell, Veraltet und Nicht-standard Banner werden direkt nach diesem Hinweisblock gezeigt.

Denken Sie daran, diese gesamte erklärende Notiz vor der Veröffentlichung zu entfernen.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, könnte sie bereits aus den relevanten Webstandards entfernt worden sein, in Kürze entfernt werden oder nur noch aus Kompatibilitätsgründen bestehen. Vermeiden Sie die Verwendung und aktualisieren Sie vorhandenen Code, falls möglich; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu unterstützen. Beachten Sie, dass diese Funktion jederzeit aufhören könnte zu funktionieren.

Nicht standardisiert: Diese Funktion ist nicht standardisiert. Wir raten davon ab, nicht-standardisierte Funktionen auf produktiven Webseiten zu verwenden, da sie nur von bestimmten Browsern unterstützt werden und sich in Zukunft ändern oder entfernt werden können. Unter Umständen kann sie jedoch eine geeignete Option sein, wenn es keine standardisierte Alternative gibt.

Der Zusammenfassungsabsatz — beginnen Sie damit, die Schnittstelle zu benennen, anzugeben, zu welchem API sie gehört, und zu sagen, was sie macht. Dies sollte idealerweise ein oder zwei kurze Sätze sein. Sie können den größten Teil hiervon von der Zusammenfassung der Schnittstelle auf der entsprechenden API-Übersichtsseite übernehmen.

{{InheritanceDiagram}}

Um das domxref-Makro in den folgenden Abschnitten zu verwenden, entfernen Sie die Backticks und den Backslash in der Markdown-Datei.

Konstruktor

{{DOMxRef("NameOfTheInterface.NameOfTheInterface", "NameOfTheInterface()")}}: Erstellt eine neue Instanz des NameOfTheInterface Objekts.

Statische Eigenschaften

Erbt außerdem Eigenschaften von seiner Elterschnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese gesamte Zeile.)

Fügen Sie für jede Eigenschaft einen Begriff und eine Definition hinzu.

{{DOMxRef("NameOfTheInterface.staticProperty1")}} Schreibgeschützt Experimentell Veraltet Nicht standardisiert: Fügen Sie eine kurze Beschreibung der Eigenschaft und ihrer Funktion hier ein. Wenn die Eigenschaft nicht readonly/experimentell/veraltet/nicht-standard ist, entfernen Sie die zugehörigen Makroaufrufe.
{{DOMxRef("NameOfTheInterface.staticProperty2")}}: Fügen Sie eine kurze Beschreibung der Eigenschaft und ihrer Funktion hier ein. Wenn die Eigenschaft nicht readonly/experimentell/veraltet/nicht-standard ist, entfernen Sie die zugehörigen Makroaufrufe.

Instanz-Eigenschaften

Fügen Sie für jede Eigenschaft einen Begriff und eine Definition hinzu.

{{DOMxRef("NameOfTheInterface.property1")}} Schreibgeschützt Experimentell Veraltet Nicht standardisiert: Fügen Sie eine kurze Beschreibung der Eigenschaft und ihrer Funktion hier ein. Wenn die Eigenschaft nicht readonly/experimentell/veraltet/nicht-standard ist, entfernen Sie die zugehörigen Makroaufrufe.
{{DOMxRef("NameOfTheInterface.property2")}}: Fügen Sie eine kurze Beschreibung der Eigenschaft und ihrer Funktion hier ein. Wenn die Eigenschaft nicht readonly/experimentell/veraltet/nicht-standard ist, entfernen Sie die zugehörigen Makroaufrufe.

Statische Methoden

Erbt außerdem Methoden von seiner Elterschnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese gesamte Zeile.)

Fügen Sie für jede Methode einen Begriff und eine Definition hinzu.

{{DOMxRef("NameOfTheInterface.staticMethod1()")}} Experimentell Veraltet Nicht standardisiert: Fügen Sie eine kurze Beschreibung der Methode und ihrer Funktion hier ein. Wenn die Methode nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die zugehörigen Makroaufrufe.
{{DOMxRef("NameOfTheInterface.staticMethod2()")}}: Fügen Sie eine kurze Beschreibung der Methode und ihrer Funktion hier ein. Wenn die Methode nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die zugehörigen Makroaufrufe.

Instanz-Methoden

Fügen Sie für jede Methode einen Begriff und eine Definition hinzu.

{{DOMxRef("NameOfTheInterface.method1()")}} Experimentell Veraltet Nicht standardisiert: Fügen Sie eine kurze Beschreibung der Methode und ihrer Funktion hier ein. Wenn die Methode nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die zugehörigen Makroaufrufe.
{{DOMxRef("NameOfTheInterface.method2()")}}: Fügen Sie eine kurze Beschreibung der Methode und ihrer Funktion hier ein. Wenn die Methode nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die zugehörigen Makroaufrufe.

Ereignisse

Erbt außerdem Ereignisse von seiner Elterschnittstelle, {{DOMxRef("NameOfParentInterface")}}. (Hinweis: Wenn die Schnittstelle nicht von einer anderen Schnittstelle erbt, entfernen Sie diese gesamte Zeile.)

Diese Ereignisse können mit addEventListener() gehört oder indem ein Ereignislistener der oneventname-Eigenschaft dieser Schnittstelle zugewiesen wird.

{{DOMxRef("NameOfTheInterface.event1", "event1")}} Experimentell Veraltet Nicht standardisiert: Ausgelöst, wenn (fügen Sie die Beschreibung ein, wann das Ereignis ausgelöst wird). Auch über die oneventname1-Eigenschaft verfügbar. Wenn das Ereignis nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die zugehörigen Makroaufrufe.
{{DOMxRef("NameOfTheInterface.event2", "event2")}}: Ausgelöst, wenn (fügen Sie die Beschreibung ein, wann das Ereignis ausgelöst wird). Auch über die oneventname2-Eigenschaft verfügbar. Wenn das Ereignis nicht experimentell/veraltet/nicht-standard ist, entfernen Sie die zugehörigen Makroaufrufe.

Beispiele

Beachten Sie, dass wir den Plural "Beispiele" verwenden, selbst wenn die Seite nur ein Beispiel enthält.

Eine beschreibende Überschrift

Jedes Beispiel muss eine H3-Überschrift (###) mit einem Namen für das Beispiel haben. Die Überschrift sollte beschreiben, was das Beispiel macht. Zum Beispiel sagt "Ein einfaches Beispiel" nichts über das Beispiel aus und ist daher keine gute Überschrift. Die Überschrift sollte prägnant sein. Für eine längere Beschreibung verwenden Sie den Absatz nach der Überschrift.

Siehe unsere Anleitung, wie man Codebeispiele hinzufügt für weitere Informationen.

Hinweis: Manchmal möchten Sie auf Beispiele auf einer anderen Seite verlinken.

Szenario 1: Wenn Sie einige Beispiele auf dieser Seite haben und einige weitere Beispiele auf einer anderen Seite:

Fügen Sie eine H3-Überschrift (###) für jedes Beispiel auf dieser Seite hinzu und dann eine letzte H3-Überschrift (###) mit dem Text "Weitere Beispiele", unter dem Sie die Beispiele auf anderen Seiten verlinken können. Zum Beispiel:

## Beispiele

### Verwendung der Fetch-API

Beispiel für Fetch

### Weitere Beispiele

Links zu weiteren Beispielen auf anderen Seiten

Szenario 2: Wenn Sie nur Beispiele auf einer anderen Seite und keine auf dieser Seite haben:

Fügen Sie keine H3-Überschriften hinzu; fügen Sie die Links direkt unter der H2-Überschrift "Beispiele" hinzu. Zum Beispiel:

## Beispiele

Für Beispiele zu dieser API, siehe [die Seite zu fetch()](https://example.org/).

link1
link2
external_link (year)

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.

Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden