WebResource class

Balíček:

@azure/ms-rest-js

Vytvoří nový objekt WebResource.

Tato třída poskytuje abstrakci volání REST tím, že je knihovna / implementace nezávislá a zabalení nezbytných vlastností k zahájení požadavku.

Konstruktory

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)

Vlastnosti

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress	Zpětné volání, které se aktivuje při průběhu stahování.
onUploadProgress	Zpětné volání, které se aktivuje při nahrávání průběhu.
operationResponseGetter	Funkce, která vrátí správnou operaci OperationResponse pro danou kombinaci OperationSpec a HttpOperationResponse. Pokud není definováno, použije se jednoduché vyhledávání stavového kódu.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize	Zda httpOperationResponse by měl být deserializován. Pokud není definováno, měl by být httpOperationResponse deserializován.
streamResponseBody	Zda je tělo HttpOperationResponse považováno za datový proud nebo ne.
timeout
url
withCredentials

Metody

clone()	Naklonujte tento objekt požadavku HTTP webResource.
prepare(RequestPrepareOptions)	Připraví požadavek.
validateRequestProperties()	Ověří, že jsou definovány požadované vlastnosti, jako je metoda, adresa URL, hlavičky["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, vyvolá se chyba.

Podrobnosti konstruktoru

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)

Parametry

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

Podrobnosti vlastnosti

abortSignal

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

agentSettings

agentSettings?: AgentSettings

Hodnota vlastnosti

AgentSettings

body

body?: any

Hodnota vlastnosti

any

formData

formData?: any

Hodnota vlastnosti

any

headers

headers: HttpHeadersLike

Hodnota vlastnosti

HttpHeadersLike

keepAlive

keepAlive?: boolean

Hodnota vlastnosti

boolean

method

method: HttpMethods

Hodnota vlastnosti

HttpMethods

onDownloadProgress

Zpětné volání, které se aktivuje při průběhu stahování.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

onUploadProgress

Zpětné volání, které se aktivuje při nahrávání průběhu.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

operationResponseGetter

Funkce, která vrátí správnou operaci OperationResponse pro danou kombinaci OperationSpec a HttpOperationResponse. Pokud není definováno, použije se jednoduché vyhledávání stavového kódu.

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

Hodnota vlastnosti

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

operationSpec

operationSpec?: OperationSpec

Hodnota vlastnosti

OperationSpec

proxySettings

proxySettings?: ProxySettings

Hodnota vlastnosti

ProxySettings

query

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

Hodnota vlastnosti

{[key: string]: any}

redirectLimit

redirectLimit?: number

Hodnota vlastnosti

number

shouldDeserialize

Zda httpOperationResponse by měl být deserializován. Pokud není definováno, měl by být httpOperationResponse deserializován.

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

Hodnota vlastnosti

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Zda je tělo HttpOperationResponse považováno za datový proud nebo ne.

streamResponseBody?: boolean

Hodnota vlastnosti

boolean

timeout

timeout: number

Hodnota vlastnosti

number

url

url: string

Hodnota vlastnosti

string

withCredentials

withCredentials: boolean

Hodnota vlastnosti

boolean

Podrobnosti metody

clone()

Naklonujte tento objekt požadavku HTTP webResource.

function clone(): WebResource

Návraty

WebResource

Klon tohoto objektu požadavku HTTP webResource.

prepare(RequestPrepareOptions)

Připraví požadavek.

function prepare(options: RequestPrepareOptions): WebResource

Parametry

options

RequestPrepareOptions

Možnosti pro přípravu požadavku

Návraty

WebResource

Vrátí připravený objekt WebResource (požadavek HTTP), který musí být předán kanálu požadavku.

validateRequestProperties()

Ověří, že jsou definovány požadované vlastnosti, jako je metoda, adresa URL, hlavičky["Content-Type"], headers["accept-language"]. Pokud není definována jedna z výše uvedených vlastností, vyvolá se chyba.

function validateRequestProperties()