Partager via

WebResource class

  • Référence
Paquet:
@azure/ms-rest-js

Crée un objet WebResource.

Cette classe fournit une abstraction sur un appel REST en étant indépendante de la bibliothèque/de l’implémentation et en encapsulant les propriétés nécessaires pour lancer une requête.

Constructeurs

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)

Propriétés

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.
onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.
operationResponseGetter

Fonction qui retourne l’OpérationResponse appropriée pour la combinaison OperationSpec et HttpOperationResponse donnée. Si ce n’est pas défini, une recherche de code d’état simple est utilisée.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize

Indique si httpOperationResponse doit être désérialisé ou non. Si ce n’est pas défini, httpOperationResponse doit être désérialisé.
streamResponseBody

Indique si le corps de l’objet HttpOperationResponse doit ou non être traité comme un flux.
timeout
url
withCredentials

Méthodes

clone()

Clonez cet objet de requête HTTP WebResource.
prepare(RequestPrepareOptions)

Prépare la demande.
validateRequestProperties()

Vérifie que les propriétés requises telles que method, url, headers["Content-Type"], headers["accept-language"] sont définies. Une erreur est générée si l’une des propriétés mentionnées ci-dessus n’est pas définie.

Détails du constructeur

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)

Paramètres

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

Détails de la propriété

abortSignal 

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

agentSettings 

agentSettings?: AgentSettings

Valeur de propriété

AgentSettings

body 

body?: any

Valeur de propriété

any

formData 

formData?: any

Valeur de propriété

any

headers 

headers: HttpHeadersLike

Valeur de propriété

HttpHeadersLike

keepAlive 

keepAlive?: boolean

Valeur de propriété

boolean

method 

method: HttpMethods

Valeur de propriété

HttpMethods

onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

operationResponseGetter

Fonction qui retourne l’OpérationResponse appropriée pour la combinaison OperationSpec et HttpOperationResponse donnée. Si ce n’est pas défini, une recherche de code d’état simple est utilisée.

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

Valeur de propriété

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

operationSpec 

operationSpec?: OperationSpec

Valeur de propriété

OperationSpec

proxySettings 

proxySettings?: ProxySettings

Valeur de propriété

ProxySettings

query 

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

Valeur de propriété

{[key: string]: any}

redirectLimit 

redirectLimit?: number

Valeur de propriété

number

shouldDeserialize

Indique si httpOperationResponse doit être désérialisé ou non. Si ce n’est pas défini, httpOperationResponse doit être désérialisé.

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

Valeur de propriété

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Indique si le corps de l’objet HttpOperationResponse doit ou non être traité comme un flux.

streamResponseBody?: boolean

Valeur de propriété

boolean

timeout 

timeout: number

Valeur de propriété

number

url 

url: string

Valeur de propriété

string

withCredentials 

withCredentials: boolean

Valeur de propriété

boolean

Détails de la méthode

clone()

Clonez cet objet de requête HTTP WebResource.

function clone(): WebResource

Retours

WebResource

Clone de cet objet de requête HTTP WebResource.

prepare(RequestPrepareOptions)

Prépare la demande.

function prepare(options: RequestPrepareOptions): WebResource

Paramètres

options
RequestPrepareOptions

Options à fournir pour la préparation de la demande.

Retours

WebResource

Retourne l’objet WebResource (requête HTTP) préparé qui doit être donné au pipeline de requête.

validateRequestProperties()

Vérifie que les propriétés requises telles que method, url, headers["Content-Type"], headers["accept-language"] sont définies. Une erreur est générée si l’une des propriétés mentionnées ci-dessus n’est pas définie.

function validateRequestProperties()