JavaScript ArcGIS request.RequestOptions用法及代码示例

基本信息

以下是所在类或对象的基本信息。

AMD: require(["esri/request"], (esriRequest) => { /* code goes here */ });

ESM: import esriRequest from "@arcgis/core/request";

函数： esri/request

自从：用于 JavaScript 4.0 的 ArcGIS API

用法说明

request.RequestOptions函数(或属性)的定义如下：

RequestOptions

具有以下说明请求的属性的对象。

属性：

类型说明

authMode String

可选的

默认值：汽车

指示是否以及如何验证对ArcGIS 服务的请求。仅适用于 esriConfig.request.useIdentity = true 。

已知值	说明
auto	当请求安全资源时，用户将登录。
anonymous	请求安全资源时将返回错误。
immediate	用户将在请求资源之前登录。
no-prompt	检查用户是否已登录。如果是，则不会显示任何登录提示。

可能的值："auto"|"anonymous"|"immediate"|"no-prompt"

body FormData|HTMLFormElement|String

可选的

如果上传文件，请在此处指定用于提交文件的表单数据或元素。如果指定，query 的参数将被添加到 URL。

cacheBust Boolean

可选的

默认值：错误的

如果 true ，浏览器将向服务器发送请求，而不是使用浏览器的本地缓存。如果 false ，将使用浏览器的默认缓存处理。

headers Object

可选的

用于请求的标头。这是一个属性名称为标题名称的对象。

method String

可选的

默认值：汽车

指示是否应使用 HTTP DELETE、HEAD、POST 或 PUT 方法发出请求。默认情况下，如果请求大小比在 config.request 中设置的 maxUrlLength 属性长，则 HTTP POST 将用于 auto。

可能的值："auto"|"delete"|"head"|"post"|"put"

query Object

可选的

默认值：空值

请求的查询参数。如果使用 GET 请求或设置了 body 属性，则查询参数将添加到 URL。否则，如果未设置 body 属性，并且使用 DELETE、POST 或 PUT 请求，则查询参数将添加到正文请求参数中。

responseType String

可选的

默认值：json

响应格式。

signal AbortSignal

可选的

AbortSignal 允许可取消的请求。如果取消，promise 将被拒绝，并出现名为 AbortError 的错误。另见AbortController。

例子：

const controller = new AbortController();
const signal = controller.signal;

esriRequest(url, { signal })
  .then((response) => {
    // The request went OK
  })
  .catch((err) => {
    if (err.name === 'AbortError') {
      console.log('Request aborted');
    } else {
      console.error('Error encountered', err);
    }
  });

// Abort requests that are aware of the controller's signal
controller.abort();

timeout Number

可选的

默认值：60000

指示等待服务器响应的时间量(以毫秒为单位)。设置为 0 以无限期等待响应。

useProxy Boolean

可选的

默认值：错误的

指示请求应使用代理。默认情况下，这是根据请求 URL 的域自动确定的。\

withCredentials Boolean

可选的

默认值：错误的

指示 cross-site Access-Control 请求是否应使用凭据。如果应用程序需要凭据，也可以将域推送到配置 trustedServers 。有关 withCredentials 的更多信息，请参阅 this documentation 。

相关用法

注：本文由纯净天空筛选整理自arcgis.com大神的英文原创作品 request.RequestOptions。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。