Partilhar via

WebResource class

  • Referência
Pacote:
@azure/core-http

Cria um novo objeto WebResource.

Esta classe fornece uma abstração sobre uma chamada REST ao ser agnóstica de biblioteca/implementação e encapsular as propriedades necessárias para iniciar um pedido.

Construtores

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

Propriedades

abortSignal

Sinal de um controlador de abortar. Pode ser utilizado para abortar o envio de um pedido de rede e aguardar uma resposta.
body

Corpo do pedido.
decompressResponse

Se pretende ou não descomprimir a resposta de acordo com Accept-Encoding cabeçalho (apenas obtenção de nó)
formData

Dados de formulário, utilizados para criar o corpo do pedido.
headers

Cabeçalhos HTTP.
keepAlive

Se pretende manter as ligações HTTP ativas ao longo dos pedidos.
method

Método HTTP a utilizar.
onDownloadProgress

Chamada de retorno que é acionada após o progresso da transferência.
onUploadProgress

Chamada de retorno que é acionada após o progresso do carregamento.
operationResponseGetter

Uma função que devolve o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse especificada. Se não estiver definido, será utilizada uma pesquisa de código de estado simples.
operationSpec

Especificação do pedido HTTP.
proxySettings

Que proxy utilizar, se necessário.
query

Consulta adicionada ao URL.
requestId

Identificador exclusivo do pedido de saída.
shouldDeserialize

Se o HttpOperationResponse deve ou não ser desserializado. Se isto não estiver definido, o HttpOperationResponse deve ser desserializado.
spanOptions

Rastreio: opções utilizadas para criar um intervalo quando o rastreio está ativado.
streamResponseBody

Se o corpo de HttpOperationResponse deve ou não ser tratado como um fluxo.
streamResponseStatusCodes

Uma lista de códigos de estado cujo corpo httpOperationResponse correspondente deve ser tratado como um fluxo.
timeout

Quanto tempo demora a aguardar em milissegundos antes de abortar o pedido.
tracingContext

Rastreio: contexto utilizado ao criar Spans.
url

URL do pedido de saída.
withCredentials

Se pretende enviar credenciais (através de cookies, cabeçalhos de autorização ou certificados de cliente TLS) ao fazer um pedido no browser para um destino entre sites.

Métodos

clone()

Clone este objeto de pedido HTTP webResource.
prepare(RequestPrepareOptions)

Prepara o pedido.
validateRequestProperties()

Valida que as propriedades necessárias, como o método, url, cabeçalhos["Tipo de Conteúdo"], cabeçalhos["accept-language"] estão definidos. Emitirá um erro se uma das propriedades mencionadas acima não estiver definida.

Detalhes do Construtor

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>) 

new WebResource(url?: string, method?: HttpMethods, body?: unknown, query?: {[key: string]: any}, headers?: {[key: string]: any} | HttpHeadersLike, streamResponseBody?: boolean, withCredentials?: boolean, abortSignal?: AbortSignalLike, timeout?: number, onUploadProgress?: (progress: TransferProgressEvent) => void, onDownloadProgress?: (progress: TransferProgressEvent) => void, proxySettings?: ProxySettings, keepAlive?: boolean, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

Parâmetros

url

string

method
HttpMethods
body

unknown

query

{[key: string]: any}

headers

{[key: string]: any} | HttpHeadersLike

streamResponseBody

boolean

withCredentials

boolean

abortSignal
AbortSignalLike
timeout

number

onUploadProgress

(progress: TransferProgressEvent) => void

onDownloadProgress

(progress: TransferProgressEvent) => void

proxySettings
ProxySettings
keepAlive

boolean

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

Detalhes de Propriedade

abortSignal

Sinal de um controlador de abortar. Pode ser utilizado para abortar o envio de um pedido de rede e aguardar uma resposta.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

body

Corpo do pedido.

body?: any

Valor de Propriedade

any

decompressResponse

Se pretende ou não descomprimir a resposta de acordo com Accept-Encoding cabeçalho (apenas obtenção de nó)

decompressResponse?: boolean

Valor de Propriedade

boolean

formData

Dados de formulário, utilizados para criar o corpo do pedido.

formData?: any

Valor de Propriedade

any

headers

Cabeçalhos HTTP.

headers: HttpHeadersLike

Valor de Propriedade

HttpHeadersLike

keepAlive

Se pretende manter as ligações HTTP ativas ao longo dos pedidos.

keepAlive?: boolean

Valor de Propriedade

boolean

method

Método HTTP a utilizar.

method: HttpMethods

Valor de Propriedade

HttpMethods

onDownloadProgress

Chamada de retorno que é acionada após o progresso da transferência.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

Chamada de retorno que é acionada após o progresso do carregamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

operationResponseGetter

Uma função que devolve o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse especificada. Se não estiver definido, será utilizada uma pesquisa de código de estado simples.

operationResponseGetter?: (operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

Valor de Propriedade

(operationSpec: OperationSpec, response: HttpOperationResponse) => undefined | OperationResponse

operationSpec

Especificação do pedido HTTP.

operationSpec?: OperationSpec

Valor de Propriedade

OperationSpec

proxySettings

Que proxy utilizar, se necessário.

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

query

Consulta adicionada ao URL.

query?: {[key: string]: any}

Valor de Propriedade

{[key: string]: any}

requestId

Identificador exclusivo do pedido de saída.

requestId: string

Valor de Propriedade

string

shouldDeserialize

Se o HttpOperationResponse deve ou não ser desserializado. Se isto não estiver definido, o HttpOperationResponse deve ser desserializado.

shouldDeserialize?: boolean | (response: HttpOperationResponse) => boolean

Valor de Propriedade

boolean | (response: HttpOperationResponse) => boolean

spanOptions

Rastreio: opções utilizadas para criar um intervalo quando o rastreio está ativado.

spanOptions?: SpanOptions

Valor de Propriedade

@azure/core-tracing.SpanOptions

streamResponseBody

Aviso

Esta API foi preterida.

Use streamResponseStatusCodes property instead.

Se o corpo de HttpOperationResponse deve ou não ser tratado como um fluxo.

streamResponseBody?: boolean

Valor de Propriedade

boolean

streamResponseStatusCodes

Uma lista de códigos de estado cujo corpo httpOperationResponse correspondente deve ser tratado como um fluxo.

streamResponseStatusCodes?: Set<number>

Valor de Propriedade

Set<number>

timeout

Quanto tempo demora a aguardar em milissegundos antes de abortar o pedido.

timeout: number

Valor de Propriedade

number

tracingContext

Rastreio: contexto utilizado ao criar Spans.

tracingContext?: Context

Valor de Propriedade

@azure/core-tracing.Context

url

URL do pedido de saída.

url: string

Valor de Propriedade

string

withCredentials

Se pretende enviar credenciais (através de cookies, cabeçalhos de autorização ou certificados de cliente TLS) ao fazer um pedido no browser para um destino entre sites.

withCredentials: boolean

Valor de Propriedade

boolean

Detalhes de Método

clone()

Clone este objeto de pedido HTTP webResource.

function clone(): WebResource

Devoluções

WebResource

O clone deste objeto de pedido HTTP webResource.

prepare(RequestPrepareOptions)

Prepara o pedido.

function prepare(options: RequestPrepareOptions): WebResource

Parâmetros

options
RequestPrepareOptions

Opções para fornecer para preparar o pedido.

Devoluções

WebResource

Devolve o objeto WebResource (Pedido HTTP) preparado que tem de ser atribuído ao pipeline de pedido.

validateRequestProperties()

Valida que as propriedades necessárias, como o método, url, cabeçalhos["Tipo de Conteúdo"], cabeçalhos["accept-language"] estão definidos. Emitirá um erro se uma das propriedades mencionadas acima não estiver definida.

function validateRequestProperties()