Compartilhar via

WebResource class

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

Cria um novo objeto WebResource.

Essa classe fornece uma abstração em uma chamada REST sendo independente de biblioteca/implementação e encapsulando as propriedades necessárias para iniciar uma solicitação.

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 anulação. Pode ser usado para anular o envio de uma solicitação de rede e aguardar uma resposta.
body

Corpo da solicitação.
decompressResponse

Se a resposta deve ser descompactada de acordo com Accept-Encoding cabeçalho (somente node-fetch)
formData

Dados de formulário, usados para criar o corpo da solicitação.
headers

Cabeçalhos HTTP.
keepAlive

Se deseja manter as conexões HTTP ativas em todas as solicitações.
method

Método HTTP a ser usado.
onDownloadProgress

Retorno de chamada que é disparado após o progresso do download.
onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.
operationResponseGetter

Uma função que retorna o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse fornecida. Se isso for indefinido, uma pesquisa de código de status simples será usada.
operationSpec

Especificação da solicitação HTTP.
proxySettings

Qual proxy usar, se necessário.
query

Consulta adicionada à URL.
requestId

Identificador exclusivo da solicitação de saída.
shouldDeserialize

Se o HttpOperationResponse deve ou não ser desserializado. Se isso for indefinido, o HttpOperationResponse deverá ser desserializado.
spanOptions

Rastreamento: opções usadas para criar um intervalo quando o rastreamento está habilitado.
streamResponseBody

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

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

Quanto tempo aguardar em milissegundos antes de anular a solicitação.
tracingContext

Rastreamento: contexto usado ao criar intervalos.
url

URL da solicitação de saída.
withCredentials

Se deseja enviar credenciais (por meio de cookies, cabeçalhos de autorização ou certificados de cliente TLS) ao fazer uma solicitação no navegador para um destino entre sites.

Métodos

clone()

Clone este objeto de solicitação HTTP WebResource.
prepare(RequestPrepareOptions)

Prepara a solicitação.
validateRequestProperties()

Valida se as propriedades necessárias, como método, url, cabeçalhos["Content-Type"], cabeçalhos["accept-language"] são definidas. Ele gerará 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 da propriedade

abortSignal

Sinal de um controlador de anulação. Pode ser usado para anular o envio de uma solicitação de rede e aguardar uma resposta.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

body

Corpo da solicitação.

body?: any

Valor da propriedade

any

decompressResponse

Se a resposta deve ser descompactada de acordo com Accept-Encoding cabeçalho (somente node-fetch)

decompressResponse?: boolean

Valor da propriedade

boolean

formData

Dados de formulário, usados para criar o corpo da solicitação.

formData?: any

Valor da propriedade

any

headers

Cabeçalhos HTTP.

headers: HttpHeadersLike

Valor da propriedade

HttpHeadersLike

keepAlive

Se deseja manter as conexões HTTP ativas em todas as solicitações.

keepAlive?: boolean

Valor da propriedade

boolean

method

Método HTTP a ser usado.

method: HttpMethods

Valor da propriedade

HttpMethods

onDownloadProgress

Retorno de chamada que é disparado após o progresso do download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

operationResponseGetter

Uma função que retorna o OperationResponse adequado para a combinação OperationSpec e HttpOperationResponse fornecida. Se isso for indefinido, uma pesquisa de código de status simples será usada.

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

Valor da propriedade

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

operationSpec

Especificação da solicitação HTTP.

operationSpec?: OperationSpec

Valor da propriedade

OperationSpec

proxySettings

Qual proxy usar, se necessário.

proxySettings?: ProxySettings

Valor da propriedade

ProxySettings

query

Consulta adicionada à URL.

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

Valor da propriedade

{[key: string]: any}

requestId

Identificador exclusivo da solicitação de saída.

requestId: string

Valor da propriedade

string

shouldDeserialize

Se o HttpOperationResponse deve ou não ser desserializado. Se isso for indefinido, o HttpOperationResponse deverá ser desserializado.

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

Valor da propriedade

boolean | (response: HttpOperationResponse) => boolean

spanOptions

Rastreamento: opções usadas para criar um intervalo quando o rastreamento está habilitado.

spanOptions?: SpanOptions

Valor da propriedade

@azure/core-tracing.SpanOptions

streamResponseBody

Aviso

Essa API foi preterida.

Use streamResponseStatusCodes property instead.

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

streamResponseBody?: boolean

Valor da propriedade

boolean

streamResponseStatusCodes

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

streamResponseStatusCodes?: Set<number>

Valor da propriedade

Set<number>

timeout

Quanto tempo aguardar em milissegundos antes de anular a solicitação.

timeout: number

Valor da propriedade

number

tracingContext

Rastreamento: contexto usado ao criar intervalos.

tracingContext?: Context

Valor da propriedade

@azure/core-tracing.Context

url

URL da solicitação de saída.

url: string

Valor da propriedade

string

withCredentials

Se deseja enviar credenciais (por meio de cookies, cabeçalhos de autorização ou certificados de cliente TLS) ao fazer uma solicitação no navegador para um destino entre sites.

withCredentials: boolean

Valor da propriedade

boolean

Detalhes do método

clone()

Clone este objeto de solicitação HTTP WebResource.

function clone(): WebResource

Retornos

WebResource

O clone desse objeto de solicitação HTTP WebResource.

prepare(RequestPrepareOptions)

Prepara a solicitação.

function prepare(options: RequestPrepareOptions): WebResource

Parâmetros

options
RequestPrepareOptions

Opções a serem fornecidas para preparar a solicitação.

Retornos

WebResource

Retorna o objeto WebResource (Solicitação HTTP) preparado que precisa ser fornecido ao pipeline de solicitação.

validateRequestProperties()

Valida se as propriedades necessárias, como método, url, cabeçalhos["Content-Type"], cabeçalhos["accept-language"] são definidas. Ele gerará um erro se uma das propriedades mencionadas acima não estiver definida.

function validateRequestProperties()