Partilhar via


Shell.Utilities.js

 

Aplica-se a: Windows Azure Pack

Contém um conjunto de métodos de utilidade geral.

Widgets

Nenhum.

Tipos

Shell.Promise (init, cancele)

A Promise fornece um mecanismo para agendar trabalhos a serem feitos sobre um valor que ainda não foi calculado. É uma abstração conveniente para gerir interações com APIs assíncronos.

Nome

Tipo

Description

init

Função

Função chamada durante a construção da Promessa. A função é dada três argumentos (completo, erro, progresso).

cancelar

Função

Opcional. Função para ligar se um consumidor em baixo desta Promessa quiser tentar cancelar o seu trabalho desfeito. As promessas não são necessárias para serem canceladas.

Propriedades

Nenhum.

Métodos

Nome

Descrição

Devoluções

Parâmetros

Shell.Promise.addEventListener

Adiciona um ouvinte do evento ao controlo.

Nenhumas

EventType: O tipo (nome) do evento.

ouvinte: O ouvinte a invocar quando o evento é levantado.

captura: Especifica se deve ou não iniciar a captura.

Shell.Promise.qualquer

Devolve uma Promessa que é cumprida quando uma das promessas de entrada foi cumprida.

Promessa

valores (Matriz): Matriz de valores, incluindo objetos Promise ou Objeto cujos valores de propriedade incluem objetos Promise.

Shell.Promise.as

Devolve uma Promessa, se o valor já for uma Promessa é devolvida caso contrário o valor está envolto numa Promessa.

Promessa

Valor: Valor a ser tratado como uma Promessa.

Shell.Promise.cancela

Tentativas de cancelar a realização de um valor prometido. Se a Promessa ainda não tiver sido cumprida e o cancelamento for suportado, a Promessa entrará no estado de erro com o valor do novo Erro("Cancelado").

Nenhumas

Nenhuma

Shell.Utilities.deepEquals

Compara dois objetos profundamente e retorna verdadeiros se forem iguais. Compara duas matrizes profundamente e retorna verdadeiras se forem iguais.

Booleano

a (Objeto):

b (Objeto):

a (Matriz):

b (Matriz):

Shell.Promise.dispatchEvent

Eleva um evento do tipo especificado e com propriedades adicionais. Devoluções verdadeiras se prevenir ODefault foi chamado para o evento.

Booleano

EventType: O tipo (nome) do evento.

Detalhes: O conjunto de propriedades adicionais a ser anexado ao objeto do evento quando o evento é levantado.

Shell.Utilities.download

Descarrega conteúdo para o navegador. O objeto devolvido é o iFrame que irá hospedar o download.

Objeto

uri (String): URI do conteúdo a ser descarregado

Shell.Utilities.getAntiForgeryId

Obtém a identificação anti-falsificação.

String

Nenhuma

Shell.Promise.is

Determinar se um valor cumpre o contrato Promessa. A verdade é devolvida se o valor for uma Promessa.

Booleano

Valor:Um valor que pode ser uma Promessa.

Shell.Promise.join

Cria uma Promessa que é cumprida quando todos os valores são realizados.

Return é uma Promessa cujo valor é um registo com os mesmos nomes de campo que a entrada onde cada campo é um valor realizado.

Promessa

valores (Objeto): Registo cujos campos contêm valores, alguns dos quais podem ser Promessas.

Shell.Utilities.newGuid

Devolve um novo GUID.

String

Nenhuma

Shell.Promise.removeEventListener

Remove um ouvinte do evento do controlo.

Nenhumas

EventType: O tipo (nome) do evento.

O ouvinte a remover da lista de invocação.

Captura: Especifica se deve ou não iniciar a captura.

Shell.Promise.then

Então, o encaminhador estático para o método de instância Promise(). Devoluções Promessa cujo valor será o resultado da execução da função fornecida.

Promessa

completar (Função): Função a ser chamada se a Promessa for cumprida com sucesso com um valor. Se for nulo, a Promessa fornecerá uma implementação padrão que simplesmente devolve o valor. O valor será passado como argumento único.

erro (Função): Função a chamar se a Promessa for cumprida com um erro. O erro será passado como um único argumento.

progresso (Função): Função a ser chamada se o Relatório Promessa reportar progressos. Os dados sobre o progresso serão aprovados como o único argumento. Não são necessárias promessas para apoiar o progresso.

Shell.Promise.thenEach

Executa uma operação em todas as promessas de entrada e devolve uma Promessa que está na forma da entrada e contém o resultado da operação tendo sido realizada em cada entrada.

Devolve uma Promessa que é o resultado de chamar Promessa.Junte-se aos valores do parâmetro.

Promessa

completar (Função): Função a ser chamada se a Promessa for cumprida com sucesso com um valor. Se for nulo, a Promessa fornecerá uma implementação padrão que simplesmente devolve o valor. O valor será passado como argumento único.

erro (Função): Função a chamar se a Promessa for cumprida com um erro. O erro será passado como um único argumento.

progresso (Função): Função a ser chamada se o Relatório Promessa reportar progressos. Os dados sobre o progresso serão aprovados como o único argumento. Não são necessárias promessas para apoiar o progresso.

Shell.Promise.timeout

Crie uma promessa que seja cumprida após o período de tempo de tempo fornecido. Devolve uma Promessa que é concluída assíncronamente após os milissegundos indicados por timeout.

Shell.Promise

tempo limite (Número): Período de tempo, se 0 ou não especificado, este é implementado através do msSetImmediate, de outra forma utilizando o setTimeout.

Shell.Promise.wrap

Embrulhe um valor não-Promessa numa promessa, isto é útil se precisar passar um valor para uma função que requer uma Promessa. Devolve uma Promessa que é cumprida com sucesso com o valor especificado.

Shell.Promise

Valor: Um valor não-Promessa para embrulhar numa promessa.

Shell.Promise.wrapError

Embrulhe um valor de erro não-Promessa numa promessa, isto é útil se precisar passar um erro para uma função que requer uma Promessa. Devolve uma Promessa que é cumprida num estado de erro com o valor especificado.

Shell.Promise

Erro: Um erro não-promessa a ser embrulhado numa Promessa.

Consulte também

Windows referência da biblioteca da extensão do pacote Azure