• geoscene/identity

ServerInfo

AMD: require(["geoscene/identity/ServerInfo"], (ServerInfo) => { /* code goes here */ });
ESM: import ServerInfo from "@geoscene/core/identity/ServerInfo";
类: geoscene/identity/ServerInfo
继承于:ServerInfo Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.0

此类包含有关 GeoScene Server 及其令牌端点的信息。

另请参阅

构造函数

new ServerInfo(properties)
参数
properties Object
optional

有关可能传递给构造函数的所有属性的列表,请参见属性

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
String

用于为 GeoScene Server Admin 资源生成令牌的令牌服务 URL。

更多详情
ServerInfo
Number

部署在服务器上的 GeoScene Server 或 Portal 的版本。

更多详情
ServerInfo
String

类的名称。

更多详情
Accessor
Boolean

指示 server 是否为 Portal 实例。

更多详情
ServerInfo
Boolean

指示 server 是否为 GeoScene Server 实例。

更多详情
ServerInfo
String

服务器 URL。

更多详情
ServerInfo
Number

短期令牌的有效期,以分钟为单位。

更多详情
ServerInfo
String

用于为服务器上的安全资源生成令牌的令牌服务 URL。

更多详情
ServerInfo
Boolean

指示服务器是否配置为使用 web 层身份验证。

更多详情
ServerInfo

属性详细信息

adminTokenServiceUrl String

用于为 GeoScene Server Admin 资源生成令牌的令牌服务 URL。

currentVersion Number

部署在服务器上的 GeoScene Server 或 Portal 的版本。

注:对于 GeoScene Online,此值为 8.4

另请参阅
declaredClass Stringreadonly inherited
起始版本:GeoScene Maps SDK for JavaScript 4.7

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

hasPortal Boolean

指示 server 是否为 Portal 实例。

另请参阅
hasServer Boolean

指示 server 是否为 GeoScene Server 实例。

另请参阅
示例
// Register the serverInfo with the IdentityManager
geosceneId.registerServers([{
  hasServer: true,
  server: "https://<server domain>/geoscene",
  tokenServiceUrl: "https://<server domain>/geoscene/tokens/"
}]);
server String

服务器 URL。此值包括服务器和门户的 web 适配器的路径。

shortLivedTokenValidity Number

短期令牌的有效期,以分钟为单位。

tokenServiceUrl String

用于为服务器上的安全资源生成令牌的令牌服务 URL。

webTierAuth Boolean

指示服务器是否配置为使用 web 层身份验证。

另请参阅

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象的生命周期相关联的句柄。

更多详情
Accessor
*

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。

更多详情
ServerInfo
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

将此类的实例转换为 GeoScene Portal JSON 表示。

更多详情
ServerInfo

方法详细说明

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

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例,请参阅指南中的使用 fromJSON() 主题。

参数
json Object

GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例,请参阅 GeoScene REST API 文档

返回
类型 描述
* 返回该类的新实例。
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");
}
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");
toJSON(){Object}

将此类的实例转换为 GeoScene Portal JSON 表示。有关详细信息,请参阅使用 fromJSON() 指南主题。

返回
类型 描述
Object 此类实例的 GeoScene Portal JSON 表示。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。请参阅浏览器弃用帖子以获取更多信息