WebResource class

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

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, 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

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
proxySettings
query
redirectLimit
shouldDeserialize

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

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

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, 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 de Propriedade

abortSignal 

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

agentSettings 

agentSettings?: AgentSettings

Valor de Propriedade

AgentSettings

body 

body?: any

Valor de Propriedade

any

formData 

formData?: any

Valor de Propriedade

any

headers 

headers: HttpHeadersLike

Valor de Propriedade

HttpHeadersLike

keepAlive 

keepAlive?: boolean

Valor de Propriedade

boolean

method 

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 

operationSpec?: OperationSpec

Valor de Propriedade

OperationSpec

proxySettings 

proxySettings?: ProxySettings

Valor de Propriedade

ProxySettings

query 

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

Valor de Propriedade

{[key: string]: any}

redirectLimit 

redirectLimit?: number

Valor de Propriedade

number

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

streamResponseBody

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

streamResponseBody?: boolean

Valor de Propriedade

boolean

timeout 

timeout: number

Valor de Propriedade

number

url 

url: string

Valor de Propriedade

string

withCredentials 

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