Client-API-Initialisierung

Microsoft. PowerPages.onPagesClientApiReady

Power Pages Client-API-Initialisierung tritt nicht sofort auf, wenn die Seite geladen wird. Verwenden Sie die Microsoft.PowerPages.onPagesClientApiReady Funktion, um das API-Objekt zuzuweisen $pages , wenn es bereit ist, damit Ihre Skripts erst nach Abschluss der Initialisierung auf Seiten-APIs zugreifen können. Sie können sie auf zwei Arten initialisieren.

Wichtig

Der Microsoft.Dynamic365.Portal.onPagesClientApiReady Alias ist veraltet. Es funktioniert weiterhin, damit vorhandene Skripts weiterhin ausgeführt werden, aber sie schreibt eine einmalige Warnung in die Browserkonsole und wird in einer zukünftigen Version entfernt. Verwenden Sie stattdessen Microsoft.PowerPages.onPagesClientApiReady.

Rückrufbasierte API-Bereitschaft

Verwenden Sie eine Rückruffunktion, die das API-Objekt einer Variablen zuweist, die Sie definieren, wenn sie bereit ist. In zwei Beispielen wird gezeigt, wie:

Mithilfe einer anonymen Funktion:

Microsoft.PowerPages.onPagesClientApiReady(($pages) => {
    const forms = $pages.currentPage.forms.getAll();
    console.log(`Found ${forms.length} forms on the page.`);
});

Mithilfe einer benannten Funktion:

function start($pages){
    const forms = $pages.currentPage.forms.getAll();
    console.log(`Found ${forms.length} forms on the page.`);
}

Microsoft.PowerPages.onPagesClientApiReady(start)

Bereitschaft der zugesagten/await-basierten API

Verwendet await to handle the promise returned by the Microsoft.PowerPages.onPagesClientApiReady function for a cleaner async flow.

let $pages = await Microsoft.PowerPages.onPagesClientApiReady();
const forms = $pages.currentPage.forms.getAll();
console.log(`Found ${forms.length} forms on the page.`);

Wann jeder Ansatz verwendet werden soll

In der folgenden Tabelle wird beschrieben, wann jeder Ansatz verwendet werden soll.

Approach Wann verwenden?
Rückrufbasierte API-Bereitschaft Verwenden Sie diese Option, wenn Sie ältere Browser oder Ältere Skripts unterstützen müssen, die nicht unterstützt async/awaitwerden, oder wenn Sie mehrere Handler registrieren möchten, die ausgeführt werden, wenn die API bereit ist. Ideal für ereignisgesteuerte Muster.
Bereitschaft der zugesagten/await-basierten API Wird in modernen JavaScript-Umgebungen verwendet, die saubereren, sequenziellen Code unterstützen async/await . Am besten, wenn Ihre Logik davon abhängt, dass die API bereit ist, bevor die Ausführung fortgesetzt wird.

Tip

Wenn Ihre Codebasis bereits verwendet wird async/await, bevorzugen Sie den Zusagen-basierten Ansatz für Konsistenz.

Die Beispiele in diesem Artikel und in Client-API-Steuerelementtypen verwenden das rückrufbasierte Muster mit einem async Rückruf, sodass jedes Beispiel verwendet await werden kann, wenn eine asynchrone Methode aufgerufen wird. Lassen Sie das async Schlüsselwort weg, wenn Ihr eigener Code nicht verwendet awaitwird. Jedes Beispiel veranschaulicht einen oder mehrere API-Aufrufe, und die Agentbeispiele basieren auf den Werten, die im vorherigen Beispiel definiert werden. Beispiele, die mehrere APIs kombinieren, um ein vollständiges Szenario zu implementieren, finden Sie unter Power Pages Client-API-Beispiele.