Compartir a través de

WebResource class

  • Referencia
Paquete:
@azure/ms-rest-js

Crea un nuevo objeto WebResource.

Esta clase proporciona una abstracción sobre una llamada REST, ya que es independiente de la biblioteca o implementación y ajusta las propiedades necesarias para iniciar una solicitud.

Constructores

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)

Propiedades

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress

Devolución de llamada que se activa tras el progreso de la descarga.
onUploadProgress

Devolución de llamada que se activa tras el progreso de la carga.
operationResponseGetter

Función que devuelve el operationResponse adecuado para la combinación OperationSpec y HttpOperationResponse especificada. Si no está definido, se usará una búsqueda de código de estado simple.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize

Si se debe deserializar o no HttpOperationResponse. Si no está definido, se debe deserializar HttpOperationResponse.
streamResponseBody

Si el cuerpo de HttpOperationResponse debe tratarse como una secuencia.
timeout
url
withCredentials

Métodos

clone()

Clone este objeto de solicitud HTTP de WebResource.
prepare(RequestPrepareOptions)

Prepara la solicitud.
validateRequestProperties()

Valida que se definen las propiedades necesarias, como method, url, headers["Content-Type"], headers["accept-language"]. Se producirá un error si no se define una de las propiedades mencionadas anteriormente.

Detalles del constructor

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

Detalles de las propiedades

abortSignal 

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

agentSettings 

agentSettings?: AgentSettings

Valor de propiedad

AgentSettings

body 

body?: any

Valor de propiedad

any

formData 

formData?: any

Valor de propiedad

any

headers 

headers: HttpHeadersLike

Valor de propiedad

HttpHeadersLike

keepAlive 

keepAlive?: boolean

Valor de propiedad

boolean

method 

method: HttpMethods

Valor de propiedad

HttpMethods

onDownloadProgress

Devolución de llamada que se activa tras el progreso de la descarga.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

onUploadProgress

Devolución de llamada que se activa tras el progreso de la carga.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de propiedad

(progress: TransferProgressEvent) => void

operationResponseGetter

Función que devuelve el operationResponse adecuado para la combinación OperationSpec y HttpOperationResponse especificada. Si no está definido, se usará una búsqueda de código de estado simple.

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

Valor de propiedad

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

operationSpec 

operationSpec?: OperationSpec

Valor de propiedad

OperationSpec

proxySettings 

proxySettings?: ProxySettings

Valor de propiedad

ProxySettings

query 

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

Valor de propiedad

{[key: string]: any}

redirectLimit 

redirectLimit?: number

Valor de propiedad

number

shouldDeserialize

Si se debe deserializar o no HttpOperationResponse. Si no está definido, se debe deserializar HttpOperationResponse.

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

Valor de propiedad

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Si el cuerpo de HttpOperationResponse debe tratarse como una secuencia.

streamResponseBody?: boolean

Valor de propiedad

boolean

timeout 

timeout: number

Valor de propiedad

number

url 

url: string

Valor de propiedad

string

withCredentials 

withCredentials: boolean

Valor de propiedad

boolean

Detalles del método

clone()

Clone este objeto de solicitud HTTP de WebResource.

function clone(): WebResource

Devoluciones

WebResource

Clon de este objeto de solicitud HTTP de WebResource.

prepare(RequestPrepareOptions)

Prepara la solicitud.

function prepare(options: RequestPrepareOptions): WebResource

Parámetros

options
RequestPrepareOptions

Opciones que se proporcionan para preparar la solicitud.

Devoluciones

WebResource

Devuelve el objeto WebResource (solicitud HTTP) preparado que debe proporcionarse a la canalización de solicitudes.

validateRequestProperties()

Valida que se definen las propiedades necesarias, como method, url, headers["Content-Type"], headers["accept-language"]. Se producirá un error si no se define una de las propiedades mencionadas anteriormente.

function validateRequestProperties()