PortalUser

属性概述

属性详细信息

access String

指示用户的访问级别。如果为私有，则用户描述信息将对其他用户不可用，用户名也将不可搜索。

可能值："private"|"org"|"public"

created Date

创建用户的日期。

culture String

用户的语言设置。

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

类的名称。声明的类名称格式化为 geoscene.folder.className。

description String

用户的描述。

email String

用户的电子邮件地址。

fullName String

用户的完整名称。

modified Date

用户上次修改的日期。

orgId String

用户所属的组织的 ID。

portal Portal

与用户相关联的门户。

preferredView String

用户对内容的首选视图，无论是 web 还是 GIS。

region String

用户首选区域，用于设置主页上的特色地图，图库中的内容以及查看器中新地图的默认范围。

role String

定义用户在组织中的角色。有关用户何时拥有自定义角色的更多详细信息，请参阅 roleId。

可能值："org_admin"|"org_publisher"|"org_user"

roleId String

用户角色的 ID。仅当为用户分配了自定义角色时设置。

当存在时，角色将根据自定义角色包含的权限指示自定义角色的"基本”角色。例如，如果自定义角色包含一些发布者权限，则该角色将设置为 org_publisher。

sourceJSON Object

起始版本：GeoScene Maps SDK for JavaScript 4.13

创建 PortalUser 时，用于创建属性值的 JSON。虽然最常用的属性直接在 PortalUser 类上公开，但这提供了为门户用户返回的所有信息的访问。如果在使用较旧版本的 API 构建的应用程序中工作，且需要访问较新版本的门户用户属性，则此属性非常有用。

thumbnailUrl Stringreadonly

用户缩略图的 URL。

另请参阅

• getThumbnailUrl()

units String

用户的个人测量单位设置。

可能值："english"|"metric"

userContentUrl Stringreadonly

用户内容的 URL。

username String

用户的用户名。

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

addItem(params){Promise<PortalItem>}

将项目添加到用户的门户内容中。

参数

规范

params Object 有关可作为此对象中的属性传递的参数，请参阅下面的对象规范表。 规范 item PortalItem 要添加到用户内容中的项目。 data String|Object optional 用于将项目表示的数据流式传输到客户端的组件。 folder String|PortalFolder optional 用于存储项目的门户文件夹。

返回

类型	描述
Promise<PortalItem>	解析后，返回要添加到用户内容中的 PortalItem。

deleteItem(item){Promise}

从用户的门户内容中删除项目。

参数

item PortalItem 要移除的门户项目。

返回

类型	描述
Promise	当从用户内容中删除项目时解析。

deleteItems(items){Promise}

起始版本：GeoScene Maps SDK for JavaScript 4.8

从用户的门户内容中删除多个项目。

参数

items PortalItem[] 要移除的多个门户项目。

返回

类型	描述
Promise	当从用户内容中删除多个项目时解析。

fetchFolders(){Promise<PortalFolder[]>}

获取用于组织门户内容的所有用户文件夹。

返回

类型	描述
Promise<PortalFolder[]>	解析为 PortalFolder 对象数组，表示门户中用户的每个文件夹。

示例

// Once portal is loaded, user signed in
portal.load().then(function() {
  portalUser.fetchFolders().then(function(folders){
    folders.forEach(function(folder){
      console.log(" user folder", folder.title);
    });
  });
});

fetchGroups(){Promise<PortalGroup[]>}

获取门户用户有权访问的所有组。

返回

类型	描述
Promise<PortalGroup[]>	解析为 PortalGroup 对象数组，表示用户可以访问的每个群组。

示例

// Once portal is loaded, user signed in
portal.load().then(function() {
  // fetch all the groups user can access
  portal.user.fetchGroups().then(function(fetchItemResult){
    console.log("user's groups: ", fetchItemResult);
  });
});

fetchItems(params){Promise<object>}

检索指定文件夹中的所有项目。

参数

规范

params Object optional 有关可作为此对象中的属性传递的参数，请参阅下面的对象规范表。 规范 folder PortalFolder optional 要从中检索项目的文件夹。 num Number optional 默认值：10 要包含在结果集响应中的最大结果数。允许的最大值为 100。将 start 属性和 num 属性组合用于对搜索结果进行分页。 sortField String optional 默认值： created 以逗号分隔的要排序的字段列表。允许的值为 created、modified、size 和 type。 sortOrder String optional 默认值： asc 对结果进行排序的顺序。允许的值为用于升序的 asc 和用于降序的 desc。 start Number optional 默认值：1 结果集响应中第一个条目的索引。索引从 1 开始。

返回

类型	描述
Promise<Object>	解析为具有以下属性的类： 属性 类型 描述 items PortalItem[] 包含用户门户项目的数组。 nextStart number 下一个条目索引（如果当前结果集未包含所有结果）。 total number 结果的总数。

示例

// portalUser.fetchItems
portal.user.fetchItems().then(function(fetchItemResult){
   console.log("next start index: ", fetchItemResult.nextStart);
   fetchItemResult.items.forEach(function(item){
     console.log("portal item title:", item.title);
   });
});

fetchTags(){Promise<object[]>}

起始版本：GeoScene Maps SDK for JavaScript 4.14

获取门户用户创建的标记对象。

返回

类型	描述
Promise<object[]>	解析为包含以下属性的对象数组： 属性 类型 描述 tag string 标签名。 count number 标签使用的次数。

getThumbnailUrl(width){String}

起始版本：GeoScene Maps SDK for JavaScript 4.4

获取用户缩略图的 URL。

可用宽度大小：150、300 和 600。

参数

width Number optional 所需的图像宽度。

返回

类型	描述
String	缩略图的 URL。

hasHandles(groupKey){Boolean}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 true。

参数

groupKey * optional 组键。

返回

类型	描述
Boolean	如果存在指定的句柄组，则返回 true。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

queryFavorites(queryParams){Promise<PortalQueryResult>}

对用户喜爱的群组执行查询，以返回与输入查询相匹配的 PortalItem 对象数组。

参数

queryParams PortalQueryParams optional PortalQueryParams 中定义的输入查询参数。此对象可能是自动转换的。

返回

类型	描述
Promise<PortalQueryResult>	解决时，将解析为 PortalQueryResult 的实例，该实例包含 PortalItem 对象的 results 数组，表示与输入查询相匹配的所有项目。

removeHandles(groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

groupKey * optional 要移除的组键或组键的数组或集合。

示例

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");