@microsoft/sp-http-base package
Базовый уровень связи для SharePoint Framework
Классы
| AadHttpClient |
AadHttpClient используется для выполнения вызовов REST к приложению Azure AD. |
| AadHttpClientConfiguration |
Конфигурация для HttpClient. |
| AadHttpClientFactory |
Возвращает предварительно инициализированную версию AadHttpClient для заданного URL-адреса ресурса. Дополнительные сведения: https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient |
| AadHttpClientResponse |
Подкласс Response возвращается такими методами, как |
| AadTokenProvider |
Этот класс позволяет разработчику получать маркеры OAuth2 из Azure AD. Маркеры OAuth2 используются для проверки подлинности пользователя со страницы SharePoint в других службах, таких как PowerBI, Sway, Exchange, Yammer и т. д. |
| AadTokenProviderFactory |
Возвращает предварительно инициализированную версию AadTokenProviderFactory. |
| BeforeRedirectEventArgs |
Аргументы перед перенаправлением для полностраничной проверки подлинности |
| DigestCache |
IDigestCache — это внутренняя служба, используемая SPHttpClient для поддержания кэша дайджестов запросов для каждого URL-адреса SPWeb. Дайджест запроса — это маркер безопасности, необходимый серверу SharePoint для любой операции записи REST, который указывается через http-заголовок "X-RequestDigest". Он получается путем вызова конечной точки REST "/_api/contextinfo" и истекает через настраиваемое сервером время. Дополнительные сведения см. в статье MSDN "Выполнение базовых операций с помощью конечных точек REST SharePoint 2013". |
| HttpClient |
HttpClient реализует базовый набор функций для выполнения операций REST в универсальной службе. |
| HttpClientConfiguration |
Конфигурация для HttpClient. |
| HttpClientResponse |
Подкласс Response, возвращаемый такими методами, как HttpClient.fetch(). |
| ODataVersion |
Представляет поддерживаемую версию заголовка OData-Version, который входит в стандарт Open Data Protocol. |
| PopupEventArgs |
Аргументы для события всплывающего окна, если взаимодействие требуется во время потока входа. |
| SPHttpClient |
SPHttpClient используется для выполнения вызовов REST для SharePoint. Он добавляет заголовки по умолчанию, управляет дайджестом, необходимым для записей, и собирает данные телеметрии, которые помогают службе отслеживать производительность приложения. |
| SPHttpClientBatch |
Класс SPHttpClientBatch накапливает ряд вызовов службы REST и передает их в едином пакете ODATA. Документация по этому протоколу находится здесь: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html Порядок использования: вызывается SPHttpClientBatch.fetch() для постановки в очередь каждого отдельного запроса, затем следует вызов SPHttpClientBatch.execute() для выполнения пакетной операции. Метод execute() возвращает обещание, исполняемое по завершении действительного вызова REST. Каждый вызов fetch() также возвращает обещание, исполняемое объектом SPHttpClientResponse для данного конкретного запроса. |
| SPHttpClientBatchConfiguration |
Конфигурация spHttpClientBatch. |
| SPHttpClientCommonConfiguration |
Общий базовый класс для SPHttpClientConfiguration и SPHttpClientBatchConfiguration. |
| SPHttpClientConfiguration |
Конфигурация для SPHttpClient. |
| SPHttpClientResponse |
Подкласс Response, возвращаемый такими методами, как SPHttpClient.fetch(). |
| TokenAcquisitionEventArgs |
Аргументы для события сбоя получения маркера. |
Интерфейсы
| IAadHttpClientConfiguration |
Интерфейс флажков для HttpClientConfiguration. |
| IAadHttpClientConfigurations |
Standard конфигурации для AadHttpClient. |
| IAadHttpClientOptions |
Интерфейс для переопределения поведения AadHttpClient по умолчанию. |
| IAadTokenProvider |
Этот класс позволяет разработчику получать маркеры OAuth2 из Azure AD. Маркеры OAuth2 используются для проверки подлинности пользователя со страницы SharePoint в других службах, таких как PowerBI, Sway, Exchange, Yammer и т. д. |
| IAadTokenProviderConfiguration |
Обязательные строки для создания AadTokenProvider. |
| IBeforeRedirectEventArgs |
Представляет аргументы, используемые перед событием перенаправления. |
| IDigestCache |
IDigestCache — это внутренняя служба, используемая SPHttpClient для поддержания кэша дайджестов запросов для каждого URL-адреса SPWeb. Дайджест запроса — это маркер безопасности, необходимый серверу SharePoint для любой операции записи REST, который указывается через http-заголовок "X-RequestDigest". Он получается путем вызова конечной точки REST "/_api/contextinfo" и истекает через настраиваемое сервером время. Дополнительные сведения см. в статье MSDN "Выполнение базовых операций с помощью конечных точек REST SharePoint 2013". |
| IGetTokenOptions | |
| IHttpClientConfiguration |
Интерфейс флажков для HttpClientConfiguration. |
| IHttpClientConfigurations |
Standard конфигурации для HttpClient. |
| IHttpClientOptions |
Параметры для HttpClient |
| IPopupEventArgs |
Представляет аргументы, используемые перед событием всплывающего окна. |
| ISPHttpClientBatchConfiguration |
Интерфейс flags для SPHttpClientBatchConfiguration. |
| ISPHttpClientBatchConfigurations |
Standard конфигурации для SPHttpClient. |
| ISPHttpClientBatchCreationOptions |
Этот интерфейс передается в конструктор SPHttpClientBatch. Он задает параметры, влияющие на весь пакет. |
| ISPHttpClientBatchOptions |
Этот интерфейс определяет параметры для отдельного запроса REST, который является частью SPHttpClientBatch. Он основан на стандартных параметрах API WHATWG, которые описаны здесь: https://fetch.spec.whatwg.org/ |
| ISPHttpClientCommonConfiguration |
Интерфейс флажков для SPHttpClientCommonConfiguration |
| ISPHttpClientConfiguration |
Интерфейс флажков для SPHttpClientConfiguration. |
| ISPHttpClientConfigurations |
Standard конфигурации для SPHttpClient. |
| ISPHttpClientOptions |
В этом интерфейсе определены параметры для таких операций SPHttpClient, как get(), post(), fetch(). Он основан на параметрах стандарта WHATWG для API, приведенных на сайте https://fetch.spec.whatwg.org/. |
| ITokenAcquisitionEventArgs |
Представляет аргументы, используемые для создания события сбоя получения маркера. |
Перечисления
| IAuthenticationScheme |
Параметры схемы проверки подлинности |
| SPHttpHeader |
Standard заголовки HTTP, используемые с SPHttpClient |