PortalGroup

属性列表

属性详细说明

access String

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

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

created Date

群组的创建日期。

declaredClass Stringreadonly inherited

起始版本: GeoScene API for JavaScript 4.22

类名。类的名称声明格式为 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 API for JavaScript 4.22

群组缩略图的 URL。

示例:

• getThumbnailUrl()

title String

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

url Stringreadonly

群组的 URL。

方法列表

方法详细说明

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

起始版本: GeoScene API for JavaScript 4.22

如果存在，则获取群组的类别架构。

参数:

options Object optional 具有如下属性的对象。 规范: signal AbortSignal optional Signal 对象可用于中止异步任务。 Signal 被发出时，返回的 promise 对象状态将会变为 rejected 并抛出一个名为 AbortError 的 Error 。另请参阅 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>}

获取群组的当前成员。此方法仅适用于群组的成员或管理员。 有关更多详细信息，请查看 Group Users 。

参数:

options Object optional 具有如下属性的对象。 规范: signal AbortSignal optional Signal 对象可用于中止异步任务。 Signal 被发出时，返回的 promise 对象状态将会变为 rejected 并抛出一个名为 AbortError 的 Error 。另请参阅 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 API for JavaScript 4.22

获取组缩略图的 URL。

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

参数:

width Number optional 所需的图像宽度。

返回值:

类型	描述
String	缩略图的 URL 。

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

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

参数:

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

options Object optional 具有如下属性的对象。 规范: signal AbortSignal optional Signal 对象可用于中止异步任务。 Signal 被发出时，返回的 promise 对象状态将会变为 rejected 并抛出一个名为 AbortError 的 Error 。另请参阅 AbortController 以获取有关如何构造可用于传递中止信号的控制器的更多信息。

返回值:

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