Bagikan melalui

WebResource class

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

Membuat objek WebResource baru.

Kelas ini menyediakan abstraksi atas panggilan REST dengan menjadi pustaka/implementasi agnostik dan membungkus properti yang diperlukan untuk memulai permintaan.

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)

Properti

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.
onUploadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.
operationResponseGetter

Fungsi yang mengembalikan OperationResponse yang tepat untuk kombinasi OperationSpec dan HttpOperationResponse yang diberikan. Jika ini tidak ditentukan, maka pencarian kode status sederhana akan digunakan.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize

Apakah HttpOperationResponse harus dideserialisasi atau tidak. Jika ini tidak terdefinisi, maka HttpOperationResponse harus dideserialisasi.
streamResponseBody

Apakah isi HttpOperationResponse harus diperlakukan sebagai aliran atau tidak.
timeout
url
withCredentials

Metode

clone()

Kloning objek permintaan HTTP WebResource ini.
prepare(RequestPrepareOptions)

Menyiapkan permintaan.
validateRequestProperties()

Memvalidasi bahwa properti yang diperlukan seperti metode, url, header["Content-Type"], header["accept-language"] ditentukan. Ini akan melemparkan kesalahan jika salah satu properti yang disebutkan di atas tidak ditentukan.

Detail 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

Detail Properti

abortSignal 

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

agentSettings 

agentSettings?: AgentSettings

Nilai Properti

AgentSettings

body 

body?: any

Nilai Properti

any

formData 

formData?: any

Nilai Properti

any

headers 

headers: HttpHeadersLike

Nilai Properti

HttpHeadersLike

keepAlive 

keepAlive?: boolean

Nilai Properti

boolean

method 

method: HttpMethods

Nilai Properti

HttpMethods

onDownloadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunduhan.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

onUploadProgress

Panggilan balik yang diaktifkan setelah kemajuan pengunggahan.

onUploadProgress?: (progress: TransferProgressEvent) => void

Nilai Properti

(progress: TransferProgressEvent) => void

operationResponseGetter

Fungsi yang mengembalikan OperationResponse yang tepat untuk kombinasi OperationSpec dan HttpOperationResponse yang diberikan. Jika ini tidak ditentukan, maka pencarian kode status sederhana akan digunakan.

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

Nilai Properti

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

operationSpec 

operationSpec?: OperationSpec

Nilai Properti

OperationSpec

proxySettings 

proxySettings?: ProxySettings

Nilai Properti

ProxySettings

query 

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

Nilai Properti

{[key: string]: any}

redirectLimit 

redirectLimit?: number

Nilai Properti

number

shouldDeserialize

Apakah HttpOperationResponse harus dideserialisasi atau tidak. Jika ini tidak terdefinisi, maka HttpOperationResponse harus dideserialisasi.

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

Nilai Properti

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

Apakah isi HttpOperationResponse harus diperlakukan sebagai aliran atau tidak.

streamResponseBody?: boolean

Nilai Properti

boolean

timeout 

timeout: number

Nilai Properti

number

url 

url: string

Nilai Properti

string

withCredentials 

withCredentials: boolean

Nilai Properti

boolean

Detail Metode

clone()

Kloning objek permintaan HTTP WebResource ini.

function clone(): WebResource

Mengembalikan

WebResource

Kloning objek permintaan HTTP WebResource ini.

prepare(RequestPrepareOptions)

Menyiapkan permintaan.

function prepare(options: RequestPrepareOptions): WebResource

Parameter

options
RequestPrepareOptions

Opsi yang disediakan untuk menyiapkan permintaan.

Mengembalikan

WebResource

Mengembalikan objek WebResource (Permintaan HTTP) yang disiapkan yang perlu diberikan ke alur permintaan.

validateRequestProperties()

Memvalidasi bahwa properti yang diperlukan seperti metode, url, header["Content-Type"], header["accept-language"] ditentukan. Ini akan melemparkan kesalahan jika salah satu properti yang disebutkan di atas tidak ditentukan.

function validateRequestProperties()