SPHttpClient class

Пакет:

@microsoft/sp-http-base

SPHttpClient используется для выполнения вызовов REST для SharePoint. Он добавляет заголовки по умолчанию, управляет дайджестом, необходимым для записей, и собирает данные телеметрии, которые помогают службе отслеживать производительность приложения.

Комментарии

Этот класс помечается как @sealed. Подклассы не должны расширять его.

Для взаимодействия с другими веб-службами используйте класс HttpClient .

Конструкторы

(constructor)(serviceScope)

Создает новый экземпляр SPHttpClient класса

Свойства

configurations	Стандартные предопределенные объекты SPHttpClientConfiguration для использования с классом SPHttpClient.
isNavigate
onBeforeRedirectEvent
onPopupRequestedEvent
serviceKey	Ключ службы для SPHttpClient.

Методы

_fetch(url, configuration, options)
beginBatch(batchCreationOptions)	Создает пакет ODATA, позволяющий собирать множество запросов REST в один веб-запрос.
fetch(url, configuration, options)	Выполнение вызова службы REST.
get(url, configuration, options)	Вызывает метод fetch(), но задает для метода значение GET.
getWebUrlFromRequestUrl(requestUrl)	Используйте эвристические данные, чтобы определить базовый URL-адрес для проверки подлинности.
post(url, configuration, options)	Вызывает метод fetch(), но задает для метода значение POST.

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

(constructor)(serviceScope)

Создает новый экземпляр SPHttpClient класса

constructor(serviceScope: ServiceScope);

Параметры

serviceScope

ServiceScope

Сведения о свойстве

configurations

Стандартные предопределенные объекты SPHttpClientConfiguration для использования с классом SPHttpClient.

static readonly configurations: ISPHttpClientConfigurations;

Значение свойства

ISPHttpClientConfigurations

isNavigate

get isNavigate(): boolean;

set isNavigate(isNavigate: boolean);

Значение свойства

boolean

onBeforeRedirectEvent

readonly onBeforeRedirectEvent: SPEvent<BeforeFullPageRedirectEventArgs>;

Значение свойства

SPEvent<BeforeFullPageRedirectEventArgs>

onPopupRequestedEvent

readonly onPopupRequestedEvent: SPEvent<PopupRequestEventArgs>;

Значение свойства

SPEvent<PopupRequestEventArgs>

serviceKey

Ключ службы для SPHttpClient.

static readonly serviceKey: ServiceKey<SPHttpClient>;

Значение свойства

ServiceKey<SPHttpClient>

Сведения о методе

_fetch(url, configuration, options)

protected _fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;

Параметры

url

string

configuration

SPHttpClientConfiguration

options

ISPHttpClientOptions

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

Promise<SPHttpClientResponse>

beginBatch(batchCreationOptions)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Создает пакет ODATA, позволяющий собирать множество запросов REST в один веб-запрос.

beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;

Параметры

batchCreationOptions

ISPHttpClientBatchCreationOptions

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

SPHttpClientBatch

Объект SPHttpClientBatch , используемый для управления пакетной операцией.

fetch(url, configuration, options)

Выполнение вызова службы REST.

fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;

Параметры

url

string

URL-адрес для получения

configuration

SPHttpClientConfiguration

Определяет поведение по умолчанию SPHttpClient. Как правило, это должен быть номер последней версии из SPHttpClientConfigurations.

options

ISPHttpClientOptions

дополнительные параметры, влияющие на запрос

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

Promise<SPHttpClientResponse>

Обещание, поведение которого аналогично WHATWG fetch(). Это обещание обычно исполняется (при ложном значении HttpClientResponse.ok) для кодов ошибок, таких как HTTP 404 или 500. Оно отклоняется только в случае сетевых сбоев или прочих ошибок, препятствующих коммуникации с сервером.

Комментарии

Как правило, параметры и семантика для SPHttpClient.fetch() по существу совпадают со стандартом API WHATWG, который описан здесь: https://fetch.spec.whatwg.org/

Подкласс SPHttpClient добавляет некоторые дополнительные варианты поведения, удобные при работе с API ODATA SharePoint (чего можно избежать, используя HttpClient):

• Заголовки Accept и Content-Type по умолчанию добавляются, если они не указаны явно.

• Для операций записи автоматически добавляется заголовок X-RequestDigest.

• Маркер дайджеста запроса автоматически извлекается и сохраняется в кэше с поддержкой предварительной загрузки.

Для операции записи SPHttpClient автоматически добавит заголовок X-RequestDigest, который, возможно, потребуется получить путем выдачи отдельного запроса, например "https://example.com/sites/sample/_api/contextinfo". Как правило, соответствующий URL-адрес SPWeb можно угадать, найдя зарезервированный сегмент URL-адреса, например "_api" в исходном URL-адресе, переданном в fetch(); Если нет, используйте ISPHttpClientOptions.webUrl, чтобы указать его явным образом.

get(url, configuration, options)

Вызывает метод fetch(), но задает для метода значение GET.

get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): Promise<SPHttpClientResponse>;

Параметры

url

string

URL-адрес для получения

configuration

SPHttpClientConfiguration

Определяет поведение по умолчанию SPHttpClient. Как правило, это должен быть номер последней версии из SPHttpClientConfigurations.

options

ISPHttpClientOptions

дополнительные параметры, влияющие на запрос

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

Promise<SPHttpClientResponse>

Обещание, поведение которого аналогично WHATWG fetch(). Это обещание обычно исполняется (при ложном значении HttpClientResponse.ok) для кодов ошибок, таких как HTTP 404 или 500. Оно отклоняется только в случае сетевых сбоев или прочих ошибок, препятствующих коммуникации с сервером.

getWebUrlFromRequestUrl(requestUrl)

Используйте эвристические данные, чтобы определить базовый URL-адрес для проверки подлинности.

static getWebUrlFromRequestUrl(requestUrl: string): string;

Параметры

requestUrl

string

URL-адрес для службы REST SharePoint.

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

string

Выводимый URL-адрес SPWeb.

Комментарии

Пытается вывести URL-адрес SPWeb, связанный с предоставленным URL-адресом REST, путем поиска общих компонентов пути SharePoint, таких как "_api", "_layouts" или "_vit_bin". Это необходимо для таких операций, как пакетная обработка X-RequestDigest и ODATA, требующих отправки POST-запроса в отдельную конечную точку REST для выполнения запроса.

Например, если параметр requestUrl имеет значение "/sites/site/web/_api/service", возвращаемым URL-адресом будет "/sites/site/web". Или если параметр requestUrl имеет значение "http://example.com/_layouts/service"", то возвращаемый URL-адрес будет иметь значение "http://example.com".

Если URL-адрес не может быть определен, возникает исключение.

post(url, configuration, options)

Вызывает метод fetch(), но задает для метода значение POST.

post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;

Параметры

url

string

URL-адрес для получения

configuration

SPHttpClientConfiguration

Определяет поведение по умолчанию SPHttpClient. Как правило, это должен быть номер последней версии из SPHttpClientConfigurations.

options

ISPHttpClientOptions

дополнительные параметры, влияющие на запрос

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

Promise<SPHttpClientResponse>

Обещание, поведение которого аналогично WHATWG fetch(). Это обещание обычно исполняется (при ложном значении HttpClientResponse.ok) для кодов ошибок, таких как HTTP 404 или 500. Оно отклоняется только в случае сетевых сбоев или прочих ошибок, препятствующих коммуникации с сервером.