WebResource class

Paket:

@azure/ms-rest-js

Erstellt ein neues WebResource -Objekt.

Diese Klasse stellt eine Abstraktion über einen REST-Aufruf bereit, indem sie bibliotheks-/implementierungsagnostisch sind und die erforderlichen Eigenschaften umschließen, 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 Uploadfortschritt ausgelöst wird.
operationResponseGetter	Eine Funktion, die die richtige OperationResponse für die angegebene OperationSpec- und HttpOperationResponse-Kombination zurückgibt. Wenn dies nicht definiert ist, wird eine einfache Statuscodesuche verwendet.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize	Gibt an, ob die HttpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte die HttpOperationResponse deserialisiert werden.
streamResponseBody	Gibt an, ob der Textkörper der HttpOperationResponse als Datenstrom 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. Wenn eine der oben genannten Eigenschaften nicht definiert ist, wird ein Fehler ausgelöst.

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 Uploadfortschritt ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

operationResponseGetter

Eine Funktion, die die richtige OperationResponse für die angegebene OperationSpec- und HttpOperationResponse-Kombination 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 die HttpOperationResponse deserialisiert werden soll. Wenn dies nicht definiert ist, sollte die HttpOperationResponse deserialisiert werden.

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

Eigenschaftswert

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Gibt an, ob der Textkörper der HttpOperationResponse als Datenstrom 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 zum Vorbereiten der Anforderung.

Gibt zurück

WebResource

Gibt das vorbereitete WebResource -Objekt (HTTP-Anforderung) zurück, das der Anforderungspipeline übergeben werden muss.

validateRequestProperties()

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

function validateRequestProperties()