WebResource class

Pakiet:

@azure/ms-rest-js

Tworzy nowy obiekt WebResource.

Ta klasa zapewnia abstrakcję wywołania REST przez bycie biblioteką / implementacją niezależne od implementacji i zawijanie niezbędnych właściwości do zainicjowania żądania.

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)

Właściwości

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress	Wywołanie zwrotne uruchamiane po postępie pobierania.
onUploadProgress	Wywołanie zwrotne uruchamiane po postępie przekazywania.
operationResponseGetter	Funkcja zwracająca odpowiednią kombinację OperationResponse dla danej kombinacji OperationSpec i HttpOperationResponse. Jeśli jest to niezdefiniowane, zostanie użyte proste wyszukiwanie kodu stanu.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize	Określa, czy element HttpOperationResponse powinien być deserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno zostać zdeserializowane.
streamResponseBody	Określa, czy treść obiektu HttpOperationResponse powinna być traktowana jako strumień.
timeout
url
withCredentials

Metody

clone()	Sklonuj ten obiekt żądania HTTP WebResource.
prepare(RequestPrepareOptions)	Przygotowuje żądanie.
validateRequestProperties()	Sprawdza, czy zdefiniowane są wymagane właściwości, takie jak metoda, adres URL, nagłówki["Content-Type"], nagłówki["accept-language"]. Jeśli jedna z powyższych właściwości nie zostanie zdefiniowana, zostanie zgłoszony błąd.

Szczegóły konstruktora

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

Szczegóły właściwości

abortSignal

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

agentSettings

agentSettings?: AgentSettings

Wartość właściwości

AgentSettings

body

body?: any

Wartość właściwości

any

formData

formData?: any

Wartość właściwości

any

headers

headers: HttpHeadersLike

Wartość właściwości

HttpHeadersLike

keepAlive

keepAlive?: boolean

Wartość właściwości

boolean

method

method: HttpMethods

Wartość właściwości

HttpMethods

onDownloadProgress

Wywołanie zwrotne uruchamiane po postępie pobierania.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

onUploadProgress

Wywołanie zwrotne uruchamiane po postępie przekazywania.

onUploadProgress?: (progress: TransferProgressEvent) => void

Wartość właściwości

(progress: TransferProgressEvent) => void

operationResponseGetter

Funkcja zwracająca odpowiednią kombinację OperationResponse dla danej kombinacji OperationSpec i HttpOperationResponse. Jeśli jest to niezdefiniowane, zostanie użyte proste wyszukiwanie kodu stanu.

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

Wartość właściwości

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

operationSpec

operationSpec?: OperationSpec

Wartość właściwości

OperationSpec

proxySettings

proxySettings?: ProxySettings

Wartość właściwości

ProxySettings

query

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

Wartość właściwości

{[key: string]: any}

redirectLimit

redirectLimit?: number

Wartość właściwości

number

shouldDeserialize

Określa, czy element HttpOperationResponse powinien być deserializowany. Jeśli jest to niezdefiniowane, polecenie HttpOperationResponse powinno zostać zdeserializowane.

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

Wartość właściwości

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Określa, czy treść obiektu HttpOperationResponse powinna być traktowana jako strumień.

streamResponseBody?: boolean

Wartość właściwości

boolean

timeout

timeout: number

Wartość właściwości

number

url

url: string

Wartość właściwości

string

withCredentials

withCredentials: boolean

Wartość właściwości

boolean

Szczegóły metody

clone()

Sklonuj ten obiekt żądania HTTP WebResource.

function clone(): WebResource

Zwraca

WebResource

Klon tego obiektu żądania HTTP WebResource.

prepare(RequestPrepareOptions)

Przygotowuje żądanie.

function prepare(options: RequestPrepareOptions): WebResource

Parametry

options

RequestPrepareOptions

Opcje do przygotowania żądania.

Zwraca

WebResource

Zwraca przygotowany obiekt WebResource (żądanie HTTP), który musi zostać przekazany potokowi żądania.

validateRequestProperties()

Sprawdza, czy zdefiniowane są wymagane właściwości, takie jak metoda, adres URL, nagłówki["Content-Type"], nagłówki["accept-language"]. Jeśli jedna z powyższych właściwości nie zostanie zdefiniowana, zostanie zgłoszony błąd.

function validateRequestProperties()