WebResource class

الحزمة:

@azure/ms-rest-js

إنشاء كائن WebResource جديد.

توفر هذه الفئة تجريدا عبر استدعاء REST من خلال كونها مكتبة / تنفيذ غير محدد والتفاف الخصائص الضرورية لبدء طلب.

المنشئون

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)

الخصائص

abortSignal
agentSettings
body
formData
headers
keepAlive
method
onDownloadProgress	رد الاتصال الذي يتم إطلاقه عند تقدم التنزيل.
onUploadProgress	رد الاتصال الذي يتم إطلاقه عند تقدم التحميل.
operationResponseGetter	دالة ترجع OperationResponse المناسبة لمجموعة OperationSpec وHttpOperationResponse المحددة. إذا كان هذا غير معرف، استخدام بحث بسيط عن التعليمات البرمجية للحالة.
operationSpec
proxySettings
query
redirectLimit
shouldDeserialize	ما إذا كان يجب إلغاء تسلسل HttpOperationResponse أم لا. إذا كان هذا غير معرف، فيجب إلغاء تسلسل HttpOperationResponse.
streamResponseBody	ما إذا كان يجب التعامل مع نص HttpOperationResponse على أنه دفق أم لا.
timeout
url
withCredentials

الأساليب

clone()	استنساخ كائن طلب WEBResource HTTP هذا.
prepare(RequestPrepareOptions)	إعداد الطلب.
validateRequestProperties()	التحقق من أن الخصائص المطلوبة مثل الأسلوب وعنوان url والرؤوس ["نوع المحتوى"]، والرؤوس["قبول اللغة"] محددة. سيطرح خطأ إذا لم يتم تعريف إحدى الخصائص المذكورة أعلاه.

تفاصيل المنشئ

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)

المعلمات

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

تفاصيل الخاصية

abortSignal

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

agentSettings

agentSettings?: AgentSettings

قيمة الخاصية

AgentSettings

body

body?: any

قيمة الخاصية

any

formData

formData?: any

قيمة الخاصية

any

headers

headers: HttpHeadersLike

قيمة الخاصية

HttpHeadersLike

keepAlive

keepAlive?: boolean

قيمة الخاصية

boolean

method

method: HttpMethods

قيمة الخاصية

HttpMethods

onDownloadProgress

رد الاتصال الذي يتم إطلاقه عند تقدم التنزيل.

onDownloadProgress?: (progress: TransferProgressEvent) => void

قيمة الخاصية

(progress: TransferProgressEvent) => void

onUploadProgress

رد الاتصال الذي يتم إطلاقه عند تقدم التحميل.

onUploadProgress?: (progress: TransferProgressEvent) => void

قيمة الخاصية

(progress: TransferProgressEvent) => void

operationResponseGetter

دالة ترجع OperationResponse المناسبة لمجموعة OperationSpec وHttpOperationResponse المحددة. إذا كان هذا غير معرف، استخدام بحث بسيط عن التعليمات البرمجية للحالة.

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

قيمة الخاصية

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

operationSpec

operationSpec?: OperationSpec

قيمة الخاصية

OperationSpec

proxySettings

proxySettings?: ProxySettings

قيمة الخاصية

ProxySettings

query

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

قيمة الخاصية

{[key: string]: any}

redirectLimit

redirectLimit?: number

قيمة الخاصية

number

shouldDeserialize

ما إذا كان يجب إلغاء تسلسل HttpOperationResponse أم لا. إذا كان هذا غير معرف، فيجب إلغاء تسلسل HttpOperationResponse.

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

قيمة الخاصية

boolean | (response: HttpOperationResponse) => boolean

streamResponseBody

ما إذا كان يجب التعامل مع نص HttpOperationResponse على أنه دفق أم لا.

streamResponseBody?: boolean

قيمة الخاصية

boolean

timeout

timeout: number

قيمة الخاصية

number

url

url: string

قيمة الخاصية

string

withCredentials

withCredentials: boolean

قيمة الخاصية

boolean

تفاصيل الأسلوب

clone()

استنساخ كائن طلب WEBResource HTTP هذا.

function clone(): WebResource

المرتجعات

WebResource

استنساخ كائن طلب WebResource HTTP هذا.

prepare(RequestPrepareOptions)

إعداد الطلب.

function prepare(options: RequestPrepareOptions): WebResource

المعلمات

options

RequestPrepareOptions

خيارات لتوفير لإعداد الطلب.

المرتجعات

WebResource

إرجاع كائن WebResource (طلب HTTP) الذي يجب منحه إلى مسار الطلب.

validateRequestProperties()

التحقق من أن الخصائص المطلوبة مثل الأسلوب وعنوان url والرؤوس ["نوع المحتوى"]، والرؤوس["قبول اللغة"] محددة. سيطرح خطأ إذا لم يتم تعريف إحدى الخصائص المذكورة أعلاه.

function validateRequestProperties()