表示用于访问安全 GeoScene 资源的凭据对象。
- 另请参阅:
-
身份验证和 OAuth 2
属性概述
名称 | 类型 | 描述 | 类 | |
---|---|---|---|---|
String | 更多信息 类的名称。 | 更多信息 | Accessor | |
整数 | 更多信息 令牌过期时间指定为自 1970 年 1 月 1 日 00:00:00 UTC 以来的毫秒数。 | 更多信息 | Credential | |
布尔值 | 更多信息 指示已创建此凭据以访问 GeoScene REST 管理服务。 | 更多信息 | Credential | |
Object | 更多信息 Identity Manager 的 setOAuthRedirectionHandler 返回一个包含 | 更多信息 | Credential | |
String | 更多信息 服务器网址。 | 更多信息 | Credential | |
布尔值 | 更多信息 指示是否应通过 HTTPS 协议提取使用此凭据访问的资源。 | 更多信息 | Credential | |
String | 更多信息 令牌服务使用指定的用户 Id 和密码生成的令牌。 | 更多信息 | Credential | |
String | 更多信息 与凭据对象关联的用户。 | 更多信息 | Credential |
属性详情
-
起始版本:GeoScene API for JavaScript 4.7
-
类的名称。声明的类名的格式为
geoscene.folder.className
。
-
expires Number
-
令牌过期时间指定为自 1970 年 1 月 1 日 00:00:00 UTC 以来的毫秒数。
- 另请参阅:
-
isAdmin Boolean
-
指示已创建此凭据以访问 GeoScene REST 管理服务。
-
oAuthState Object
-
身份管理器的 setOAuthRedirectionHandler 返回一个包含
state
属性的对象。为该属性返回此信息。
-
server String
-
服务器网址。
-
ssl Boolean
-
指示是否应通过 HTTPS 协议提取使用此凭据访问的资源。
-
token String
-
令牌服务使用指定的用户 Id 和密码生成的令牌。
-
userId String
-
与凭据对象关联的用户。
方法概述
名称 | 返回类型 | 描述 | 类 | |
---|---|---|---|---|
更多信息 销毁凭据。 | 更多信息 | Credential | ||
布尔值 | 更多信息 在实例上发出事件。 | 更多信息 | Credential | |
布尔值 | 更多信息 指示实例上是否存在与提供的事件名称匹配的事件侦听器。 | 更多信息 | Credential | |
Object | 更多信息 在实例上注册事件处理程序。 | 更多信息 | Credential | |
更多信息 生成新令牌并使用新获取的令牌更新凭证的令牌属性。 | 更多信息 | Credential |
方法详情
-
destroy()
-
销毁凭据。当凭证被销毁时,您应该删除所有使用此凭证的地图图层。通过OAuth生成的任何令牌都将自动撤销。
-
emit(type, event){Boolean}起始版本:GeoScene API for JavaScript 4.5
-
在实例上发出事件。此方法仅应在创建此类的子类时使用。
参数:type String事件的名称。
event Object可选事件负载。
返回:类型 说明 布尔值 true
如果通知了侦听器
-
hasEventListener(type){Boolean}
-
指示实例上是否存在与提供的事件名称匹配的事件侦听器。
参数:type String事件的名称。
返回:类型 说明 布尔值 如果类支持输入事件,则返回 true。
-
on(type, listener){Object}
-
在实例上注册事件处理程序。调用此方法以将事件与侦听器挂钩。
参数:要侦听的事件或事件数组。
listener Function事件触发时调用的函数。
返回:类型 说明 Object 返回带有 remove()
方法的事件处理程序,应调用该方法以停止侦听事件。属性 类型 说明 remove 函数 调用时,从事件中删除侦听器。 示例:view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
refreshToken()
-
生成新令牌并使用新获取的令牌更新凭证的令牌属性。令牌通常使用计时器保持有效,该计时器会在令牌过期之前自动触发刷新。在计时器延迟或停止的情况下使用此方法。
事件概述
名称 | 类型 | 描述 | 类 | |
---|---|---|---|---|
更多信息 在凭据对象被销毁时激发。 |
更多信息 | Credential | ||
更多信息 在更新或更改与凭据关联的令牌时激发。 |
更多信息 | Credential |
事件详情
-
destroy
-
在凭据对象被销毁时激发。凭证销毁后,删除使用此凭证的所有地图图层。通过 Oauth 生成的任何令牌都将自动撤销。
-
token-change
-
在更新或更改与凭据关联的令牌时激发。