Bagikan melalui

WebResource class

  • Referensi
Paket:
@azure/core-http

Membuat objek WebResource baru.

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

Konstruktor

WebResource(string, HttpMethods, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>)

Properti

abortSignal

Sinyal pengontrol batal. Dapat digunakan untuk membatalkan pengiriman permintaan jaringan dan menunggu respons.
body

Isi permintaan.
decompressResponse

Apakah akan mendekompresi respons sesuai dengan header Accept-Encoding (hanya pengambilan simpul)
formData

Data formulir, digunakan untuk membangun isi permintaan.
headers

Header HTTP.
keepAlive

Apakah koneksi HTTP tetap hidup di seluruh permintaan.
method

Metode HTTP untuk digunakan.
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

Spesifikasi permintaan HTTP.
proxySettings

Proksi apa yang akan digunakan, jika perlu.
query

Kueri ditambahkan ke URL.
requestId

Pengidentifikasi unik permintaan keluar.
shouldDeserialize

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

Pelacakan: Opsi yang digunakan untuk membuat rentang saat pelacakan diaktifkan.
streamResponseBody

Apakah isi HttpOperationResponse harus diperlakukan sebagai aliran atau tidak.
streamResponseStatusCodes

Daftar kode status yang isi HttpOperationResponse terkait harus diperlakukan sebagai aliran.
timeout

Berapa lama menunggu dalam milidetik sebelum membatalkan permintaan.
tracingContext

Pelacakan: Konteks yang digunakan saat membuat Rentang.
url

URL permintaan keluar.
withCredentials

Apakah akan mengirim kredensial (melalui cookie, header otorisasi, atau sertifikat klien TLS) saat membuat permintaan di browser ke tujuan lintas situs.

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, unknown, {[key: string]: any}, {[key: string]: any} | HttpHeadersLike, boolean, boolean, AbortSignalLike, number, (progress: TransferProgressEvent) => void, (progress: TransferProgressEvent) => void, ProxySettings, boolean, boolean, Set<number>) 

new WebResource(url?: string, method?: HttpMethods, body?: unknown, 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, decompressResponse?: boolean, streamResponseStatusCodes?: Set<number>)

Parameter

url

string

method
HttpMethods
body

unknown

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

decompressResponse

boolean

streamResponseStatusCodes

Set<number>

Detail Properti

abortSignal

Sinyal pengontrol batal. Dapat digunakan untuk membatalkan pengiriman permintaan jaringan dan menunggu respons.

abortSignal?: AbortSignalLike

Nilai Properti

AbortSignalLike

body

Isi permintaan.

body?: any

Nilai Properti

any

decompressResponse

Apakah akan mendekompresi respons sesuai dengan header Accept-Encoding (hanya pengambilan simpul)

decompressResponse?: boolean

Nilai Properti

boolean

formData

Data formulir, digunakan untuk membangun isi permintaan.

formData?: any

Nilai Properti

any

headers

Header HTTP.

headers: HttpHeadersLike

Nilai Properti

HttpHeadersLike

keepAlive

Apakah koneksi HTTP tetap hidup di seluruh permintaan.

keepAlive?: boolean

Nilai Properti

boolean

method

Metode HTTP untuk digunakan.

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

Spesifikasi permintaan HTTP.

operationSpec?: OperationSpec

Nilai Properti

OperationSpec

proxySettings

Proksi apa yang akan digunakan, jika perlu.

proxySettings?: ProxySettings

Nilai Properti

ProxySettings

query

Kueri ditambahkan ke URL.

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

Nilai Properti

{[key: string]: any}

requestId

Pengidentifikasi unik permintaan keluar.

requestId: string

Nilai Properti

string

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

spanOptions

Pelacakan: Opsi yang digunakan untuk membuat rentang saat pelacakan diaktifkan.

spanOptions?: SpanOptions

Nilai Properti

@azure/core-tracing.SpanOptions

streamResponseBody

Peringatan

API ini sudah tidak digunakan lagi.

Use streamResponseStatusCodes property instead.

Apakah isi HttpOperationResponse harus diperlakukan sebagai aliran atau tidak.

streamResponseBody?: boolean

Nilai Properti

boolean

streamResponseStatusCodes

Daftar kode status yang isi HttpOperationResponse terkait harus diperlakukan sebagai aliran.

streamResponseStatusCodes?: Set<number>

Nilai Properti

Set<number>

timeout

Berapa lama menunggu dalam milidetik sebelum membatalkan permintaan.

timeout: number

Nilai Properti

number

tracingContext

Pelacakan: Konteks yang digunakan saat membuat Rentang.

tracingContext?: Context

Nilai Properti

@azure/core-tracing.Context

url

URL permintaan keluar.

url: string

Nilai Properti

string

withCredentials

Apakah akan mengirim kredensial (melalui cookie, header otorisasi, atau sertifikat klien TLS) saat membuat permintaan di browser ke tujuan lintas situs.

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()