Compartilhar via

WebResource class

  • Referência
Pacote:
@azure/ms-rest-js

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, any, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, AgentSettings, number)

Propriedades

abortSignal
agentSettings
body
formData
headers
keepAlive
method
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
proxySettings
query
redirectLimit
shouldDeserialize

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

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

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, any, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, AgentSettings, number) 

new WebResource(url?: string, method?: HttpMethods, body?: any, 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, agentSettings?: AgentSettings, redirectLimit?: number)

Parâmetros

url

string

method
HttpMethods
body

any

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

agentSettings
AgentSettings
redirectLimit

number

Detalhes da propriedade

abortSignal 

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

agentSettings 

agentSettings?: AgentSettings

Valor da propriedade

AgentSettings

body 

body?: any

Valor da propriedade

any

formData 

formData?: any

Valor da propriedade

any

headers 

headers: HttpHeadersLike

Valor da propriedade

HttpHeadersLike

keepAlive 

keepAlive?: boolean

Valor da propriedade

boolean

method 

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 

operationSpec?: OperationSpec

Valor da propriedade

OperationSpec

proxySettings 

proxySettings?: ProxySettings

Valor da propriedade

ProxySettings

query 

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

Valor da propriedade

{[key: string]: any}

redirectLimit 

redirectLimit?: number

Valor da propriedade

number

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

streamResponseBody

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

streamResponseBody?: boolean

Valor da propriedade

boolean

timeout 

timeout: number

Valor da propriedade

number

url 

url: string

Valor da propriedade

string

withCredentials 

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()