Dela via

WebResource class

  • Referens
Paket:
@azure/ms-rest-js

Skapar ett nytt WebResource-objekt.

Den här klassen ger en abstraktion över ett REST-anrop genom att vara biblioteks-/implementeringsagnostisk och omsluta de nödvändiga egenskaperna för att initiera en begäran.

Konstruktorer

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)

Egenskaper

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress

Återanrop som utlöses vid nedladdningsframställning.
onUploadProgress

Återanrop som utlöses vid uppladdningsstatus.
operationResponseGetter

En funktion som returnerar rätt OperationResponse för den angivna kombinationen OperationSpec och HttpOperationResponse. Om detta är odefinierat används en enkel statuskodsökning.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize

Om HttpOperationResponse ska deserialiseras eller inte. Om detta är odefinierat bör HttpOperationResponse deserialiseras.
streamResponseBody

Om brödtexten i HttpOperationResponse ska behandlas som en ström eller inte.
timeout
url
withCredentials

Metoder

clone()

Klona det här HTTP-begärandeobjektet för WebResource.
prepare(RequestPrepareOptions)

Förbereder begäran.
validateRequestProperties()

Verifierar att de obligatoriska egenskaperna, till exempel metod, URL, rubriker["Content-Type"], rubriker["accept-language"] har definierats. Det utlöser ett fel om någon av ovanstående egenskaper inte har definierats.

Konstruktorinformation

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)

Parametrar

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

Egenskapsinformation

abortSignal 

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

agentSettings 

agentSettings?: AgentSettings

Egenskapsvärde

AgentSettings

body 

body?: any

Egenskapsvärde

any

formData 

formData?: any

Egenskapsvärde

any

headers 

headers: HttpHeadersLike

Egenskapsvärde

HttpHeadersLike

keepAlive 

keepAlive?: boolean

Egenskapsvärde

boolean

method 

method: HttpMethods

Egenskapsvärde

HttpMethods

onDownloadProgress

Återanrop som utlöses vid nedladdningsframställning.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

onUploadProgress

Återanrop som utlöses vid uppladdningsstatus.

onUploadProgress?: (progress: TransferProgressEvent) => void

Egenskapsvärde

(progress: TransferProgressEvent) => void

operationResponseGetter

En funktion som returnerar rätt OperationResponse för den angivna kombinationen OperationSpec och HttpOperationResponse. Om detta är odefinierat används en enkel statuskodsökning.

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

Egenskapsvärde

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

operationSpec 

operationSpec?: OperationSpec

Egenskapsvärde

OperationSpec

proxySettings 

proxySettings?: ProxySettings

Egenskapsvärde

ProxySettings

query 

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

Egenskapsvärde

{[key: string]: any}

redirectLimit 

redirectLimit?: number

Egenskapsvärde

number

shouldDeserialize

Om HttpOperationResponse ska deserialiseras eller inte. Om detta är odefinierat bör HttpOperationResponse deserialiseras.

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

Egenskapsvärde

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Om brödtexten i HttpOperationResponse ska behandlas som en ström eller inte.

streamResponseBody?: boolean

Egenskapsvärde

boolean

timeout 

timeout: number

Egenskapsvärde

number

url 

url: string

Egenskapsvärde

string

withCredentials 

withCredentials: boolean

Egenskapsvärde

boolean

Metodinformation

clone()

Klona det här HTTP-begärandeobjektet för WebResource.

function clone(): WebResource

Returer

WebResource

Klonen av det här HTTP-begärandeobjektet för WebResource.

prepare(RequestPrepareOptions)

Förbereder begäran.

function prepare(options: RequestPrepareOptions): WebResource

Parametrar

options
RequestPrepareOptions

Alternativ för att förbereda begäran.

Returer

WebResource

Returnerar det förberedda WebResource-objektet (HTTP-begäran) som måste ges till pipelinen för begäran.

validateRequestProperties()

Verifierar att de obligatoriska egenskaperna, till exempel metod, URL, rubriker["Content-Type"], rubriker["accept-language"] har definierats. Det utlöser ett fel om någon av ovanstående egenskaper inte har definierats.

function validateRequestProperties()