Freigeben über

WebResource class

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

Erstellt ein neues WebResource-Objekt.

Diese Klasse stellt eine Abstraktion über einen REST-Aufruf bereit, indem sie bibliotheks-/implementierungsunabhängig ist und die erforderlichen Eigenschaften umschlossen, um eine Anforderung zu initiieren.

Konstruktoren

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)

Eigenschaften

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress

Rückruf, der beim Uploadvorgang ausgelöst wird.
operationResponseGetter

Eine Funktion, die die richtige OperationResponse für die angegebene Kombination aus OperationSpec und HttpOperationResponse zurückgibt. Wenn dies nicht definiert ist, wird eine einfache Statuscodesuche verwendet.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize

Gibt an, ob httpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte httpOperationResponse deserialisiert werden.
streamResponseBody

Gibt an, ob der Text der HttpOperationResponse als Stream behandelt werden soll.
timeout
url
withCredentials

Methoden

clone()

Klonen Sie dieses WebResource-HTTP-Anforderungsobjekt.
prepare(RequestPrepareOptions)

Bereitet die Anforderung vor.
validateRequestProperties()

Überprüft, ob die erforderlichen Eigenschaften wie Methode, URL, Header["Content-Type"], Header["accept-language"] definiert sind. Es wird ein Fehler ausgelöst, wenn eine der oben genannten Eigenschaften nicht definiert ist.

Details zum Konstruktor

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)

Parameter

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

Details zur Eigenschaft

abortSignal 

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

agentSettings 

agentSettings?: AgentSettings

Eigenschaftswert

AgentSettings

body 

body?: any

Eigenschaftswert

any

formData 

formData?: any

Eigenschaftswert

any

headers 

headers: HttpHeadersLike

Eigenschaftswert

HttpHeadersLike

keepAlive 

keepAlive?: boolean

Eigenschaftswert

boolean

method 

method: HttpMethods

Eigenschaftswert

HttpMethods

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

onUploadProgress

Rückruf, der beim Uploadvorgang ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

operationResponseGetter

Eine Funktion, die die richtige OperationResponse für die angegebene Kombination aus OperationSpec und HttpOperationResponse zurückgibt. Wenn dies nicht definiert ist, wird eine einfache Statuscodesuche verwendet.

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

Eigenschaftswert

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

operationSpec 

operationSpec?: OperationSpec

Eigenschaftswert

OperationSpec

proxySettings 

proxySettings?: ProxySettings

Eigenschaftswert

ProxySettings

query 

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

Eigenschaftswert

{[key: string]: any}

redirectLimit 

redirectLimit?: number

Eigenschaftswert

number

shouldDeserialize

Gibt an, ob httpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte httpOperationResponse deserialisiert werden.

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

Eigenschaftswert

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Gibt an, ob der Text der HttpOperationResponse als Stream behandelt werden soll.

streamResponseBody?: boolean

Eigenschaftswert

boolean

timeout 

timeout: number

Eigenschaftswert

number

url 

url: string

Eigenschaftswert

string

withCredentials 

withCredentials: boolean

Eigenschaftswert

boolean

Details zur Methode

clone()

Klonen Sie dieses WebResource-HTTP-Anforderungsobjekt.

function clone(): WebResource

Gibt zurück

WebResource

Der Klon dieses WebResource-HTTP-Anforderungsobjekts.

prepare(RequestPrepareOptions)

Bereitet die Anforderung vor.

function prepare(options: RequestPrepareOptions): WebResource

Parameter

options
RequestPrepareOptions

Optionen, die für die Vorbereitung der Anforderung bereitgestellt werden sollen.

Gibt zurück

WebResource

Gibt das vorbereitete WebResource-Objekt (HTTP Request) zurück, das an die Anforderungspipeline übergeben werden muss.

validateRequestProperties()

Überprüft, ob die erforderlichen Eigenschaften wie Methode, URL, Header["Content-Type"], Header["accept-language"] definiert sind. Es wird ein Fehler ausgelöst, wenn eine der oben genannten Eigenschaften nicht definiert ist.

function validateRequestProperties()