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。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。