PortalGroup

属性概述

属性详细信息

access String

群组的访问权限，该参数决定了谁可以查看和访问该群组。

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

created Date

群组的创建日期。

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

description String

该群组的详细说明。

id String

群组的唯一 id。

isInvitationOnly Boolean

如果设置为 true，则用户将无法申请加入该群组。

默认值：false

modified Date

群组的最后修改日期。

owner String

群组所有者的用户名。

portal Portal

与群组相关联的门户。

snippet String

描述群组的简要概述。

tags String[]

描述该群组的用户定义标签。

thumbnailUrl Stringreadonly

起始版本：GeoScene Maps SDK for JavaScript 4.4

用于该群组的缩略图的 URL。

另请参阅

• getThumbnailUrl()

title String

群组的标题。这是向用户显示的名称。它用于指代群组。每个群组都必须具有一个标题，并且必须是唯一的。

url Stringreadonly

群组的 URL。

方法概述

方法详细说明

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() 进行删除。如果未提供键，则句柄将被添加到默认组。

fetchCategorySchema(options){Promise<object[]>}

起始版本：GeoScene Maps SDK for JavaScript 4.8

如果存在，则获取群组的类别模式。

参数

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<object[]>	解析为包含以下属性的对象数组： 属性 类型 描述 title string 类别模式的标题。 categories object[] 包含标题和可选子类别数组的对象数组。

示例

// Fetch featured group members
portal.fetchFeaturedGroups().then(function(groups){
  groups.forEach(function(group){
    // Fetch group category schema
    group.fetchCategorySchema().then(function(schemas){
      schemas.forEach(function(schema){
        console.log("schema: ", schema);
      })
    });
  });
});

fetchMembers(options){Promise<object>}

获取群组的当前成员。此方法仅对群组成员或管理员可用。查看 GeoScene REST API 文档以了解群组用户的更多信息。

参数

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
Promise<Object>	解析为具有以下属性的类： 属性 类型 描述 admins String[] 包含群组中每个管理员的用户名的数组。 owner String 群组所有者的用户名。 users String[] 包含群组中每个用户的用户名的数组。

示例

// Fetch featured group members
portal.fetchFeaturedGroups().then(function(groups){
   groups.forEach(function(group){
     group.fetchMembers().then(function(members){
       console.log("member", members);
     });
   });
});

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");
}

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

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

参数

queryParams PortalQueryParams autocast optional 自动转换自 Object PortalQueryParams 中定义的输入查询参数。

options Object optional 具有以下属性的对象。 规范 signal AbortSignal optional 可用于中止异步任务的信号对象。当发出中止信号时，返回的 Promise 将被拒绝，并具有一个名为 AbortError 的错误。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回

类型	描述
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");