WebResource class

Pakket:

@azure/ms-rest-js

Hiermee maakt u een nieuw WebResource-object.

Deze klasse biedt een abstractie over een REST-aanroep door bibliotheek-/implementatieneutraal te zijn en de benodigde eigenschappen te verpakken om een aanvraag te starten.

Constructors

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)

Eigenschappen

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress	Callback die wordt geactiveerd bij de voortgang van het downloaden.
onUploadProgress	Callback die wordt geactiveerd bij de uploadvoortgang.
operationResponseGetter	Een functie die de juiste OperationResponse retourneert voor de opgegeven combinatie van OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige opzoekactie voor statuscodes gebruikt.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize	Of de HttpOperationResponse moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.
streamResponseBody	Of de hoofdtekst van de HttpOperationResponse moet worden behandeld als een stroom.
timeout
url
withCredentials

Methoden

clone()	Kloon dit WebResource HTTP-aanvraagobject.
prepare(RequestPrepareOptions)	Bereidt de aanvraag voor.
validateRequestProperties()	Valideert of de vereiste eigenschappen, zoals methode, URL, headers["Content-Type"], headers["accept-language"] zijn gedefinieerd. Er wordt een fout gegenereerd als een van de bovenstaande eigenschappen niet is gedefinieerd.

Constructordetails

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)

Parameters

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

Eigenschapdetails

abortSignal

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

agentSettings

agentSettings?: AgentSettings

Waarde van eigenschap

AgentSettings

body

body?: any

Waarde van eigenschap

any

formData

formData?: any

Waarde van eigenschap

any

headers

headers: HttpHeadersLike

Waarde van eigenschap

HttpHeadersLike

keepAlive

keepAlive?: boolean

Waarde van eigenschap

boolean

method

method: HttpMethods

Waarde van eigenschap

HttpMethods

onDownloadProgress

Callback die wordt geactiveerd bij de voortgang van het downloaden.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

onUploadProgress

Callback die wordt geactiveerd bij de uploadvoortgang.

onUploadProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

operationResponseGetter

Een functie die de juiste OperationResponse retourneert voor de opgegeven combinatie van OperationSpec en HttpOperationResponse. Als dit niet is gedefinieerd, wordt een eenvoudige opzoekactie voor statuscodes gebruikt.

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

Waarde van eigenschap

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

operationSpec

operationSpec?: OperationSpec

Waarde van eigenschap

OperationSpec

proxySettings

proxySettings?: ProxySettings

Waarde van eigenschap

ProxySettings

query

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

Waarde van eigenschap

{[key: string]: any}

redirectLimit

redirectLimit?: number

Waarde van eigenschap

number

shouldDeserialize

Of de HttpOperationResponse moet worden gedeserialiseerd. Als dit niet is gedefinieerd, moet httpOperationResponse worden gedeserialiseerd.

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

Waarde van eigenschap

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Of de hoofdtekst van de HttpOperationResponse moet worden behandeld als een stroom.

streamResponseBody?: boolean

Waarde van eigenschap

boolean

timeout

timeout: number

Waarde van eigenschap

number

url

url: string

Waarde van eigenschap

string

withCredentials

withCredentials: boolean

Waarde van eigenschap

boolean

Methodedetails

clone()

Kloon dit WebResource HTTP-aanvraagobject.

function clone(): WebResource

Retouren

WebResource

De kloon van dit WebResource HTTP-aanvraagobject.

prepare(RequestPrepareOptions)

Bereidt de aanvraag voor.

function prepare(options: RequestPrepareOptions): WebResource

Parameters

options

RequestPrepareOptions

Opties voor het voorbereiden van de aanvraag.

Retouren

WebResource

Retourneert het voorbereide WebResource-object (HTTP-aanvraag) dat moet worden opgegeven aan de aanvraagpijplijn.

validateRequestProperties()

Valideert of de vereiste eigenschappen, zoals methode, URL, headers["Content-Type"], headers["accept-language"] zijn gedefinieerd. Er wordt een fout gegenereerd als een van de bovenstaande eigenschappen niet is gedefinieerd.

function validateRequestProperties()