Поделиться через

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

Клонируйте объект HTTP-запроса WebResource.
prepare(RequestPrepareOptions)

Подготавливает запрос.
validateRequestProperties()

Проверяет, определены ли обязательные свойства, такие как method, URL, headers["Content-Type"], headers["accept-language"]. Если одно из указанных выше свойств не определено, это приведет к ошибке.

Сведения о конструкторе

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

Клонируйте объект HTTP-запроса WebResource.

function clone(): WebResource

Возвращаемое значение

WebResource

Клон объекта HTTP-запроса WebResource.

prepare(RequestPrepareOptions)

Подготавливает запрос.

function prepare(options: RequestPrepareOptions): WebResource

Параметры

options
RequestPrepareOptions

Параметры для подготовки запроса.

Возвращаемое значение

WebResource

Возвращает подготовленный объект WebResource (HTTP-запрос), который необходимо предоставить конвейеру запроса.

validateRequestProperties()

Проверяет, определены ли обязательные свойства, такие как method, URL, headers["Content-Type"], headers["accept-language"]. Если одно из указанных выше свойств не определено, это приведет к ошибке.

function validateRequestProperties()