WebResource class

Paket:

@azure/ms-rest-js

Yeni bir WebResource nesnesi oluşturur.

Bu sınıf, kitaplık / uygulamadan bağımsız olarak ve bir istek başlatmak için gerekli özellikleri sarmalayarak REST çağrısı üzerinde bir soyutlama sağlar.

Oluşturucular

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)

Özellikler

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress	İndirme ilerlemesi üzerine tetiklenen geri çağırma.
onUploadProgress	Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.
operationResponseGetter	Verilen OperationSpec ve HttpOperationResponse bileşimi için düzgün OperationResponse döndüren bir işlev. Bu tanımsızsa, basit bir durum kodu araması kullanılır.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize	HttpOperationResponse'un seri durumdan çıkarılıp seri durumdan çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.
streamResponseBody	HttpOperationResponse gövdesinin akış olarak ele alınıp alınmayacağı.
timeout
url
withCredentials

Yöntemler

clone()	Bu WebResource HTTP istek nesnesini klonla.
prepare(RequestPrepareOptions)	İsteği hazırlar.
validateRequestProperties()	yöntem, url, headers["Content-Type"], headers["accept-language"] gibi gerekli özelliklerin tanımlandığını doğrular. Yukarıda belirtilen özelliklerden biri tanımlanmamışsa hata oluşturur.

Oluşturucu Ayrıntıları

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)

Parametreler

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

Özellik Ayrıntıları

abortSignal

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

agentSettings

agentSettings?: AgentSettings

Özellik Değeri

AgentSettings

body

body?: any

Özellik Değeri

any

formData

formData?: any

Özellik Değeri

any

headers

headers: HttpHeadersLike

Özellik Değeri

HttpHeadersLike

keepAlive

keepAlive?: boolean

Özellik Değeri

boolean

method

method: HttpMethods

Özellik Değeri

HttpMethods

onDownloadProgress

İndirme ilerlemesi üzerine tetiklenen geri çağırma.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

onUploadProgress

Karşıya yükleme ilerlemesi üzerine tetiklenen geri çağırma.

onUploadProgress?: (progress: TransferProgressEvent) => void

Özellik Değeri

(progress: TransferProgressEvent) => void

operationResponseGetter

Verilen OperationSpec ve HttpOperationResponse bileşimi için düzgün OperationResponse döndüren bir işlev. Bu tanımsızsa, basit bir durum kodu araması kullanılır.

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

Özellik Değeri

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

operationSpec

operationSpec?: OperationSpec

Özellik Değeri

OperationSpec

proxySettings

proxySettings?: ProxySettings

Özellik Değeri

ProxySettings

query

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

Özellik Değeri

{[key: string]: any}

redirectLimit

redirectLimit?: number

Özellik Değeri

number

shouldDeserialize

HttpOperationResponse'un seri durumdan çıkarılıp seri durumdan çıkarılmayacağı. Bu tanımlanmamışsa HttpOperationResponse seri durumdan çıkarılmalıdır.

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

Özellik Değeri

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

HttpOperationResponse gövdesinin akış olarak ele alınıp alınmayacağı.

streamResponseBody?: boolean

Özellik Değeri

boolean

timeout

timeout: number

Özellik Değeri

number

url

url: string

Özellik Değeri

string

withCredentials

withCredentials: boolean

Özellik Değeri

boolean

Yöntem Ayrıntıları

clone()

Bu WebResource HTTP istek nesnesini klonla.

function clone(): WebResource

Döndürülenler

WebResource

Bu WebResource HTTP istek nesnesinin kopyası.

prepare(RequestPrepareOptions)

İsteği hazırlar.

function prepare(options: RequestPrepareOptions): WebResource

Parametreler

options

RequestPrepareOptions

İsteğin hazırlanması için sağlanması gereken seçenekler.

Döndürülenler

WebResource

İstek işlem hattına verilmesi gereken hazırlanmış WebResource (HTTP İsteği) nesnesini döndürür.

validateRequestProperties()

yöntem, url, headers["Content-Type"], headers["accept-language"] gibi gerekli özelliklerin tanımlandığını doğrular. Yukarıda belirtilen özelliklerden biri tanımlanmamışsa hata oluşturur.

function validateRequestProperties()