WebResource class

Csomag:

@azure/ms-rest-js

Létrehoz egy új WebResource-objektumot.

Ez az osztály absztrakciót biztosít egy REST-híváshoz, mivel kódtár/implementáció agnosztikus, és a kérés indításához szükséges tulajdonságokat burkolja.

Konstruktorok

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)

Tulajdonságok

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress	Visszahívás, amely a letöltési folyamat során aktiválódik.
onUploadProgress	Visszahívás, amely a feltöltési folyamat során aktiválódik.
operationResponseGetter	Egy függvény, amely a megfelelő OperationResponse értéket adja vissza az adott OperationSpec és HttpOperationResponse kombinációhoz. Ha ez nincs meghatározva, akkor egy egyszerű állapotkód-keresés lesz használva.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize	Azt, hogy a HttpOperationResponse deszerializálva legyen-e. Ha ez nincs meghatározva, akkor a HttpOperationResponse-t deszerializálni kell.
streamResponseBody	Azt, hogy a HttpOperationResponse törzsét streamként kell-e kezelni.
timeout
url
withCredentials

Metódusok

clone()	Klónozza ezt a WebResource HTTP-kérelemobjektumot.
prepare(RequestPrepareOptions)	Előkészíti a kérést.
validateRequestProperties()	Ellenőrzi, hogy a szükséges tulajdonságok, például a metódus, az URL-cím, a fejlécek["Content-Type"], a fejlécek["accept-language"] definiálva vannak-e. Hiba jelenik meg, ha a fent említett tulajdonságok egyike nincs meghatározva.

Konstruktor adatai

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éterek

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

Tulajdonság adatai

abortSignal

abortSignal?: AbortSignalLike

Tulajdonság értéke

AbortSignalLike

agentSettings

agentSettings?: AgentSettings

Tulajdonság értéke

AgentSettings

body

body?: any

Tulajdonság értéke

any

formData

formData?: any

Tulajdonság értéke

any

headers

headers: HttpHeadersLike

Tulajdonság értéke

HttpHeadersLike

keepAlive

keepAlive?: boolean

Tulajdonság értéke

boolean

method

method: HttpMethods

Tulajdonság értéke

HttpMethods

onDownloadProgress

Visszahívás, amely a letöltési folyamat során aktiválódik.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Tulajdonság értéke

(progress: TransferProgressEvent) => void

onUploadProgress

Visszahívás, amely a feltöltési folyamat során aktiválódik.

onUploadProgress?: (progress: TransferProgressEvent) => void

Tulajdonság értéke

(progress: TransferProgressEvent) => void

operationResponseGetter

Egy függvény, amely a megfelelő OperationResponse értéket adja vissza az adott OperationSpec és HttpOperationResponse kombinációhoz. Ha ez nincs meghatározva, akkor egy egyszerű állapotkód-keresés lesz használva.

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

Tulajdonság értéke

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

operationSpec

operationSpec?: OperationSpec

Tulajdonság értéke

OperationSpec

proxySettings

proxySettings?: ProxySettings

Tulajdonság értéke

ProxySettings

query

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

Tulajdonság értéke

{[key: string]: any}

redirectLimit

redirectLimit?: number

Tulajdonság értéke

number

shouldDeserialize

Azt, hogy a HttpOperationResponse deszerializálva legyen-e. Ha ez nincs meghatározva, akkor a HttpOperationResponse-t deszerializálni kell.

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

Tulajdonság értéke

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Azt, hogy a HttpOperationResponse törzsét streamként kell-e kezelni.

streamResponseBody?: boolean

Tulajdonság értéke

boolean

timeout

timeout: number

Tulajdonság értéke

number

url

url: string

Tulajdonság értéke

string

withCredentials

withCredentials: boolean

Tulajdonság értéke

boolean

Metódus adatai

clone()

Klónozza ezt a WebResource HTTP-kérelemobjektumot.

function clone(): WebResource

Válaszok

WebResource

A WebResource HTTP-kérelemobjektum klónja.

prepare(RequestPrepareOptions)

Előkészíti a kérést.

function prepare(options: RequestPrepareOptions): WebResource

Paraméterek

options

RequestPrepareOptions

A kérés előkészítésének lehetőségei.

Válaszok

WebResource

Az előkészített WebResource (HTTP-kérés) objektumot adja vissza, amelyet meg kell adni a kérelemfolyamatnak.

validateRequestProperties()

Ellenőrzi, hogy a szükséges tulajdonságok, például a metódus, az URL-cím, a fejlécek["Content-Type"], a fejlécek["accept-language"] definiálva vannak-e. Hiba jelenik meg, ha a fent említett tulajdonságok egyike nincs meghatározva.

function validateRequestProperties()