HttpClient class
HttpClient реализует базовый набор функций для выполнения операций REST в универсальной службе.
Комментарии
Для взаимодействия с SharePoint используйте вместо него класс SPHttpClient .
Конструкторы
| (constructor)(service |
Создает новый экземпляр |
Свойства
| configurations | Стандартные предопределенные объекты HttpClientConfiguration для использования с классом HttpClient. |
| service |
Ключ службы для HttpClient. |
Методы
| fetch(url, configuration, options) | Выполняет вызов службы REST. |
| get(url, configuration, options) | Вызывает метод fetch(), но задает для метода значение GET. |
| post(url, configuration, options) | Вызывает метод fetch(), но задает для метода значение POST. |
Сведения о конструкторе
(constructor)(serviceScope)
Создает новый экземпляр HttpClient класса
constructor(serviceScope: ServiceScope);Параметры
- serviceScope
- ServiceScope
Сведения о свойстве
configurations
Стандартные предопределенные объекты HttpClientConfiguration для использования с классом HttpClient.
static readonly configurations: IHttpClientConfigurations;Значение свойства
serviceKey
Ключ службы для HttpClient.
static readonly serviceKey: ServiceKey<HttpClient>;Значение свойства
Сведения о методе
fetch(url, configuration, options)
Выполняет вызов службы REST.
fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Параметры
- url
-
string
URL-адрес для получения
- configuration
- HttpClientConfiguration
Определяет поведение по умолчанию HttpClient. Как правило, это должен быть номер последней версии из HttpClientConfigurations.
- options
- IHttpClientOptions
дополнительные параметры, влияющие на запрос
Возвращаемое значение
Promise<HttpClientResponse>
Обещание, поведение которого аналогично WHATWG fetch(). Это обещание обычно исполняется (при ложном значении HttpClientResponse.ok) для кодов ошибок, таких как HTTP 404 или 500. Оно отклоняется только в случае сетевых сбоев или прочих ошибок, препятствующих коммуникации с сервером.
Комментарии
Несмотря на то что подкласс SPHttpClient добавляет некоторые улучшения, параметры и семантика для HttpClient.fetch() фактически такие же, как и в стандарте по API WHATWG (приведен здесь: https://fetch.spec.whatwg.org/.
get(url, configuration, options)
Вызывает метод fetch(), но задает для метода значение GET.
get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;Параметры
- url
-
string
URL-адрес для получения
- configuration
- HttpClientConfiguration
Определяет поведение по умолчанию HttpClient. Как правило, это должен быть номер последней версии из HttpClientConfigurations.
- options
- IHttpClientOptions
дополнительные параметры, влияющие на запрос
Возвращаемое значение
Promise<HttpClientResponse>
Обещание, поведение которого аналогично WHATWG fetch(). Это обещание обычно исполняется (при ложном значении HttpClientResponse.ok) для кодов ошибок, таких как HTTP 404 или 500. Оно отклоняется только в случае сетевых сбоев или прочих ошибок, препятствующих коммуникации с сервером.
post(url, configuration, options)
Вызывает метод fetch(), но задает для метода значение POST.
post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Параметры
- url
-
string
URL-адрес для получения
- configuration
- HttpClientConfiguration
Определяет поведение по умолчанию HttpClient. Как правило, это должен быть номер последней версии из HttpClientConfigurations.
- options
- IHttpClientOptions
дополнительные параметры, влияющие на запрос
Возвращаемое значение
Promise<HttpClientResponse>
Обещание, поведение которого аналогично WHATWG fetch(). Это обещание обычно исполняется (при ложном значении HttpClientResponse.ok) для кодов ошибок, таких как HTTP 404 или 500. Оно отклоняется только в случае сетевых сбоев или прочих ошибок, препятствующих коммуникации с сервером.