Credential

属性概述

属性详细信息

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

expires Number

令牌过期时间，指定为自 1970 年 1 月 1 日 00:00:00 UTC 以来的毫秒数。

另请参阅

• Date - MDN

isAdmin Boolean

指示已创建此凭据以访问 GeoScene REST Admin 服务。

oAuthState Object

身份管理器的 setOAuthRedirectionHandler 返回一个包含 state 属性的对象。为该属性返回此信息。

server String

服务器 url。

ssl Boolean

指示是否应通过 HTTPS 协议获取使用此凭据访问的资源。

token String

令牌服务使用指定的用户 Id 和密码生成的令牌。

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

destroy()

销毁凭据。当凭证被销毁时，您应该删除所有使用此凭证的地图图层。通过 Oauth 生成的任何令牌都将自动撤销。

另请参阅

• IdentityManager.destroyCredentials

emit(type, event){Boolean}

起始版本：GeoScene Maps SDK for JavaScript 4.5

在实例上触发事件。仅当创建此类的子类时，才应使用此方法。

参数

type String 事件的名称。

event Object optional 事件有效负载。

返回

类型	描述
Boolean	如果监听器收到通知，则为true

hasEventListener(type){Boolean}

指示实例上是否存在与提供的事件名称相匹配的事件监听器。

参数

type String 事件的名称。

返回

类型	描述
Boolean	如果类支持输入事件，则返回 true。

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

on(type, listener){Object}

在实例上注册事件处理程序。调用此方法将事件与监听器挂钩。

参数

type String|String[] 要侦听的事件或者事件数组。

listener Function 事件触发时要调用的函数。

返回

类型	描述
Object	返回具有 remove() 方法的事件处理程序，可调用该方法来停止侦听事件。 属性 类型 描述 remove Function 调用时，从事件中移除监听器。

示例

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

refreshToken()

生成新令牌并使用新获取的令牌更新凭证的 token 属性。令牌通常使用计时器保持其有效性，该计时器会在令牌过期之前自动触发刷新。在计时器延迟或停止的情况下使用此方法。

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

事件概述

事件详细说明

destroy

在凭据对象被销毁时激发。凭证被销毁后，移除所有使用此凭证的地图图层。通过 Oauth 生成的任何令牌都将自动撤销。

另请参阅

• IdentityManager.destroyCredentials

token-change

在更新或更改与凭据关联的令牌时激发。