當前位置: 首頁>>編程示例 >>用法及示例精選 >>正文


JavaScript ArcGIS Portal.queryUsers用法及代碼示例

基本信息

以下是所在類或對象的基本信息。

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

ESM: import Portal from "@arcgis/core/portal/Portal";

類: esri/portal/Portal

繼承: Portal > Accessor

自從:用於 JavaScript 4.0 的 ArcGIS API

用法說明

Portal.queryUsers函數(或屬性)的定義如下:

queryUsers (queryParams, options) {Promise<PortalQueryResult>}


對 Portal 執行查詢以返回與輸入查詢匹配的 PortalUser 對象數組。

參數:

類型說明
來自 Object

PortalQueryParams 中定義的輸入查詢參數。

options Object
可選的

具有以下屬性的對象。

規格:
signal

AbortSignal

可選的

可用於中止異步任務的信號對象。當發出中止信號時,返回的 Promise 將被名為 AbortErrorError 拒絕。另請參閱AbortController,了解有關如何構建可用於傳遞中止信號的控製器的更多信息。

返回:

類型 說明
Promise<PortalQueryResult> 解析後,解析為 PortalQueryResult 的實例,其中包含 PortalUser 對象的 results 數組,表示與輸入查詢匹配的所有項目。

例子:

// Once portal is loaded, user signed in
portal.load().then(function() {
   // queryUsers
   // This object autocasts as new PortalQueryParams()
   let queryParameters = {
     query: "username:" + portal.user.username
   };

   portal.queryUsers(queryParameters).then(function(queryResults){
     queryResults.results[0].fetchFolders().then(function(folders){
       folders.forEach(function(folder){
         console.log(" user folder", folder.title);
       });
     });
   });
});

相關用法


注:本文由純淨天空篩選整理自arcgis.com大神的英文原創作品 Portal.queryUsers。非經特殊聲明,原始代碼版權歸原作者所有,本譯文未經允許或授權,請勿轉載或複製。