HttpClient class
HttpClient 实现一组基本功能,用于对泛型服务执行 REST 操作。
注解
若要与 SharePoint 通信,请改用 SPHttpClient 类。
构造函数
| (constructor)(service |
构造 类的新实例 |
属性
| configurations | 用于 HttpClient 类的标准预定义 HttpClientConfiguration 对象。 |
| service |
PageContext 的服务键。 |
方法
| fetch(url, configuration, options) | 执行 REST 服务调用。 |
| get(url, configuration, options) | 调用 fetch () ,但将 方法设置为“GET”。 |
| post(url, configuration, options) | 调用 fetch () ,但将 方法设置为“POST”。 |
构造函数详细信息
(constructor)(serviceScope)
属性详细信息
configurations
用于 HttpClient 类的标准预定义 HttpClientConfiguration 对象。
static readonly configurations: IHttpClientConfigurations;
属性值
serviceKey
方法详细信息
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 提取 () 的承诺。 此承诺将解决 httpClientResponse.ok 为 false (,) 错误状态代码(如 HTTP 404 或 500)。 承诺只会拒绝网络故障或其他阻止与服务器通信的错误。
注解
尽管 SPHttpClient 子类添加了其他增强功能,HttpClient.fetch() 的参数和语义在本质上与此处介绍的 WHATWG API 标准是相同的: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 提取 () 的承诺。 此承诺将解决 httpClientResponse.ok 为 false (,) 错误状态代码(如 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 提取 () 的承诺。 此承诺将解决 httpClientResponse.ok 为 false (,) 错误状态代码(如 HTTP 404 或 500)。 承诺只会拒绝网络故障或其他阻止与服务器通信的错误。