PortalUser

属性列表

属性详细说明

access String

用户的访问级别。如果是 private，其他人将无法获得用户描述信息，也无法搜索用户名。

可选值:"private"|"org"|"public"

created Date

创建用户的日期。

culture String

用户的区域性信息。

declaredClass Stringreadonly inherited

起始版本: GeoScene API for JavaScript 4.22

类名。类的名称声明格式为 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。仅当为用户分配了自定义角色时设置。

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

sourceJSON Object

起始版本: GeoScene API for JavaScript 4.22

创建 PortalUser 时用于创建属性值的JSON。尽管最常用的属性直接暴露在 PortalUser 类上，但这提供了对门户用户返回的所有信息的访问。如果在使用较旧版本的API构建的应用程序中工作，且需要从较新版本访问门户网站的用户属性，那么此属性将非常有用。

示例:

• GeoScene REST API - Item

thumbnailUrl Stringreadonly

用户缩略图的URL。

示例:

• getThumbnailUrl()

units String

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

可选值:"english"|"metric"

userContentUrl Stringreadonly

用户内容的URL。

username String

用户的用户名。

方法列表

方法详细说明

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 API for JavaScript 4.22

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

参数:

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 API for JavaScript 4.22

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

返回值:

类型	描述
Promise<Object[]>	解析为: 属性 类型 描述 tag string 标签名。 count number 标签使用的时间。

getThumbnailUrl(width){String}

起始版本: GeoScene API for JavaScript 4.22

获取用户缩略图的URL。

可用宽度尺寸：150、300和600。

参数:

width Number optional 所需的图像宽度。

返回值:

类型	描述
String	缩略图的URL。

queryFavorites(queryParams){Promise<PortalQueryResult>}

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

参数:

queryParams PortalQueryParams optional PortalQueryParams中定义的输入查询参数。此对象支持 autocast。

返回值:

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