Inicialização da API do cliente

Microsoft. PowerPages.onPagesClientApiReady

Power Pages inicialização da API do Cliente não ocorre imediatamente quando a página é carregada. Use a Microsoft.PowerPages.onPagesClientApiReady função para atribuir o objeto de API ao $pages qual ele está pronto, para que seus scripts possam acessar APIs de página somente após a conclusão da inicialização. Você pode inicializá-lo de duas maneiras.

Importante

O Microsoft.Dynamic365.Portal.onPagesClientApiReady alias foi preterido. Ele ainda funciona para que os scripts existentes continuem em execução, mas ele grava um aviso único no console do navegador e é removido em uma versão futura. Use Microsoft.PowerPages.onPagesClientApiReady em seu lugar.

Preparação da API baseada em retorno de chamada

Use uma função de retorno de chamada que atribua o objeto de API a uma variável que você definir quando estiver pronta. Dois exemplos mostram como:

Usando uma função anônima:

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

Usando uma função nomeada:

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

Microsoft.PowerPages.onPagesClientApiReady(start)

Preparação da API baseada em promessa/espera

Usa await para lidar com a promessa retornada pela Microsoft.PowerPages.onPagesClientApiReady função para um fluxo assíncrono mais limpo.

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

Quando usar cada abordagem

A tabela a seguir descreve quando usar cada abordagem.

Approach Quando usar
Preparação da API baseada em retorno de chamada Use quando precisar dar suporte a navegadores mais antigos ou scripts herdados que não dão suporte async/awaitou quando desejar registrar vários manipuladores executados quando a API estiver pronta. Ideal para padrões controlados por eventos.
Preparação da API baseada em promessa/espera Use em ambientes JavaScript modernos que dão suporte async/await a código sequencial e mais limpo. Melhor quando sua lógica depende da API estar pronta antes de continuar a execução.

Dica

Se a base de código já usar async/await, prefira a abordagem baseada em Promessa para consistência.

Os exemplos neste artigo e nos tipos de controle de API do Cliente usam o padrão baseado em retorno de chamada com um async retorno de chamada, para que cada exemplo possa ser usado await quando ele chama um método assíncrono. Omita a async palavra-chave quando seu próprio código não usa await. Cada exemplo demonstra uma ou mais chamadas de API e os exemplos de agente se baseiam nos valores definidos pelo exemplo anterior. Para obter exemplos que combinam várias APIs para implementar um cenário completo, consulte Power Pages exemplos de API do Cliente.

  • Última atualização em