Condividi tramite

WebResource class

  • Riferimento
Pacchetto:
@azure/ms-rest-js

Crea un nuovo oggetto WebResource.

Questa classe fornisce un'astrazione su una chiamata REST mediante la libreria/implementazione agnostica e il wrapping delle proprietà necessarie per avviare una richiesta.

Costruttori

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)

Proprietà

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress

Callback che viene attivato al download dello stato di avanzamento.
onUploadProgress

Callback che viene attivato al caricamento dello stato di avanzamento.
operationResponseGetter

Funzione che restituisce la combinazione OperationResponse appropriata per la combinazione OperationSpec e HttpOperationResponse appropriata. Se questa operazione non è definita, verrà usata una semplice ricerca del codice di stato.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize

Indipendentemente dal fatto che httpOperationResponse debba essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.
streamResponseBody

Se il corpo di HttpOperationResponse deve essere considerato come flusso.
timeout
url
withCredentials

Metodi

clone()

Clonare questo oggetto richiesta HTTP WebResource.
prepare(RequestPrepareOptions)

Prepara la richiesta.
validateRequestProperties()

Verifica che le proprietà necessarie, ad esempio metodo, URL, intestazioni["Content-Type"], le intestazioni["accept-language"] siano definite. Genererà un errore se una delle proprietà indicate in precedenza non è definita.

Dettagli costruttore

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)

Parametri

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

Dettagli proprietà

abortSignal 

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

agentSettings 

agentSettings?: AgentSettings

Valore della proprietà

AgentSettings

body 

body?: any

Valore della proprietà

any

formData 

formData?: any

Valore della proprietà

any

headers 

headers: HttpHeadersLike

Valore della proprietà

HttpHeadersLike

keepAlive 

keepAlive?: boolean

Valore della proprietà

boolean

method 

method: HttpMethods

Valore della proprietà

HttpMethods

onDownloadProgress

Callback che viene attivato al download dello stato di avanzamento.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

onUploadProgress

Callback che viene attivato al caricamento dello stato di avanzamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valore della proprietà

(progress: TransferProgressEvent) => void

operationResponseGetter

Funzione che restituisce la combinazione OperationResponse appropriata per la combinazione OperationSpec e HttpOperationResponse appropriata. Se questa operazione non è definita, verrà usata una semplice ricerca del codice di stato.

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

Valore della proprietà

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

operationSpec 

operationSpec?: OperationSpec

Valore della proprietà

OperationSpec

proxySettings 

proxySettings?: ProxySettings

Valore della proprietà

ProxySettings

query 

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

Valore della proprietà

{[key: string]: any}

redirectLimit 

redirectLimit?: number

Valore della proprietà

number

shouldDeserialize

Indipendentemente dal fatto che httpOperationResponse debba essere deserializzato. Se non è definito, httpOperationResponse deve essere deserializzato.

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

Valore della proprietà

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Se il corpo di HttpOperationResponse deve essere considerato come flusso.

streamResponseBody?: boolean

Valore della proprietà

boolean

timeout 

timeout: number

Valore della proprietà

number

url 

url: string

Valore della proprietà

string

withCredentials 

withCredentials: boolean

Valore della proprietà

boolean

Dettagli metodo

clone()

Clonare questo oggetto richiesta HTTP WebResource.

function clone(): WebResource

Restituisce

WebResource

Clone di questo oggetto richiesta HTTP WebResource.

prepare(RequestPrepareOptions)

Prepara la richiesta.

function prepare(options: RequestPrepareOptions): WebResource

Parametri

options
RequestPrepareOptions

Opzioni da fornire per preparare la richiesta.

Restituisce

WebResource

Restituisce l'oggetto WebResource (richiesta HTTP) preparato che deve essere assegnato alla pipeline di richiesta.

validateRequestProperties()

Verifica che le proprietà necessarie, ad esempio metodo, URL, intestazioni["Content-Type"], le intestazioni["accept-language"] siano definite. Genererà un errore se una delle proprietà indicate in precedenza non è definita.

function validateRequestProperties()