@microsoft/sp-http-base package

SharePoint 框架的基础通信层

AadHttpClient

AadHttpClient 用于对 Azure AD 应用程序执行 REST 调用。

AadHttpClientConfiguration

HttpClient 的配置。

AadHttpClientFactory

返回给定资源 URL 的 AadHttpClient 的预初始化版本。 有关详细信息,请参阅: https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient

AadHttpClientResponse

由 方法(如 ) AadHttpClient.fetch()返回的 Response 子类。 扩展 HttpClientResponse 的类,添加了特定于 AadHttpClient 的其他功能。

AadTokenProvider

此类允许开发人员从 Azure AD 获取 OAuth2 令牌。

OAuth2 令牌用于从 SharePoint 页面向其他服务(如 PowerBI、Sway、Exchange、Yammer 等)对用户进行身份验证。

AadTokenProviderFactory

返回 AadTokenProviderFactory 的预初始化版本。

BeforeRedirectEventArgs

在重定向之前进行整页身份验证的参数

DigestCache

IDigestCache 是 SPHttpClient 用于维护每个 SPWeb URL 的请求摘要缓存的内部服务。 请求摘要是 SharePoint 服务器为通过“X-RequestDigest”HTTP 标头指定的任何 REST 写入作所需的安全令牌。 它通过调用“/_api/contextinfo”REST 终结点获取,并在服务器可配置的时间量后过期。

有关详细信息,请参阅 MSDN 文章 “使用 SharePoint 2013 REST 终结点完成基本作”

HttpClient

HttpClient 实现一组基本功能,用于对泛型服务执行 REST作。

HttpClientConfiguration

HttpClient 的配置。

HttpClientResponse

类似 HttpClient.fetch() 的方法返回 Response 子类。

ODataVersion

表示“OData-Version”标头的支持版本,它是开放数据协议标准的一部分。

PopupEventArgs

如果登录流期间需要交互,则弹出事件的参数。

SPHttpClient

SPHttpClient 用于执行针对 SharePoint 的 REST 调用。 此类负责添加默认标题、管理写入操作所需的摘要,并收集遥测来帮助服务监视应用程序的性能。

SPHttpClientBatch

SPHttpClientBatch 类累积大量 REST 服务调用,并将其作为单个 ODATA 批处理传输。 此处介绍了此协议: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html

其用法是调用 SPHttpClientBatch.fetch () 将每个单独的请求排队,然后调用 SPHttpClientBatch.execute () 来执行批处理作。 执行 () 方法返回一个承诺,该承诺将在实际 REST 调用完成时解析。 每次调用提取 () 还会返回一个承诺,该承诺将使用该特定请求的 SPHttpClientResponse 对象解析。

SPHttpClientBatchConfiguration

SPHttpClientBatch 的配置。

SPHttpClientCommonConfiguration

SPHttpClientConfiguration 和 SPHttpClientBatchConfiguration 的通用基类。

SPHttpClientConfiguration

SPHttpClient 的配置。

SPHttpClientResponse

类似 SPHttpClient.fetch() 的方法返回的 Response 子类。

TokenAcquisitionEventArgs

令牌获取失败事件的参数。

接口

IAadHttpClientConfiguration

HttpClientConfiguration 的标记接口。

IAadHttpClientConfigurations

Standard AadHttpClient 的配置。

IAadHttpClientOptions

用于重写 AadHttpClient 的默认行为的接口。

IAadTokenProvider

此类允许开发人员从 Azure AD 获取 OAuth2 令牌。

OAuth2 令牌用于从 SharePoint 页面向其他服务(如 PowerBI、Sway、Exchange、Yammer 等)对用户进行身份验证。

IAadTokenProviderConfiguration

构造 AadTokenProvider 所需的字符串。

IBeforeRedirectEventArgs

表示在重定向事件之前使用的参数。

IDigestCache

IDigestCache 是 SPHttpClient 用于维护每个 SPWeb URL 的请求摘要缓存的内部服务。 请求摘要是 SharePoint 服务器为通过“X-RequestDigest”HTTP 标头指定的任何 REST 写入作所需的安全令牌。 它通过调用“/_api/contextinfo”REST 终结点获取,并在服务器可配置的时间量后过期。

有关详细信息,请参阅 MSDN 文章 “使用 SharePoint 2013 REST 终结点完成基本作”

IFetchProvider

这是一个 ServiceScope 接口,表示 ES6 提取 API 的基本协定,没有任何其他 SharePoint 逻辑。

IGetTokenOptions
IHttpClientConfiguration

HttpClientConfiguration 的标记接口。

IHttpClientConfigurations

Standard HttpClient 的配置。

IHttpClientOptions

HttpClient 的选项

IPopupEventArgs

表示在弹出事件之前使用的参数。

ISPHttpClientBatchConfiguration

SPHttpClientBatchConfiguration 的标志接口。

ISPHttpClientBatchConfigurations

Standard SPHttpClient 的配置。

ISPHttpClientBatchCreationOptions

此接口将传递给 SPHttpClientBatch 构造函数。 它指定影响整个批处理的选项。

ISPHttpClientBatchOptions

此接口定义属于 SPHttpClientBatch 的单个 REST 请求的选项。 它基于此处记录的 WHATWG API 标准参数: 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

表示用于引发令牌 acquisiton 失败事件的参数。

枚举

IAuthenticationScheme

身份验证方案的选项

SPHttpHeader

Standard与 SPHttpClient 一起使用的 HTTP 标头