22
33/**
44 * @class SuperMap.Credential
5- * @description SuperMap的安全证书类，其中包括token等安全验证信息。
6- *
7- * 需要使用用户名和密码在："http://localhost:8090/iserver/services/security/tokens"下申请value
8- *
9- * 获得形如："2OMwGmcNlrP2ixqv1Mk4BuQMybOGfLOrljruX6VcYMDQKc58Sl9nMHsqQaqeBx44jRvKSjkmpZKK1L596y7skQ.."的value
10- *
5+ * @classdesc SuperMap的安全证书类，其中包括token等安全验证信息。<br>
6+ * 需要使用用户名和密码在："http://localhost:8090/iserver/services/security/tokens"下申请value <br>
7+ * 获得形如："2OMwGmcNlrP2ixqv1Mk4BuQMybOGfLOrljruX6VcYMDQKc58Sl9nMHsqQaqeBx44jRvKSjkmpZKK1L596y7skQ.."的value<br>
118 * 目前支持的功能包括：地图服务、专题图、量算、查询、公交换乘、空间分析、网络分析，不支持轮询功能。
9+ * @param value - {string} 访问受安全限制的服务时用于通过安全认证的验证信息。
10+ * @param name - {string} 验证信息前缀，name=value部分的name部分，默认为“token”。
11+ * @example
12+ * var pixcel = new SuperMap.Credential("valueString","token");
13+ * pixcel.destroy();
1214 */
1315export default class Credential {
1416 /**
15- * APIProperty: value
16- * {String} 访问受安全限制的服务时用于通过安全认证的验证信息。
17+ * @member SuperMap.Bounds.prototype. value -{string}
18+ * @description 访问受安全限制的服务时用于通过安全认证的验证信息。
1719 */
1820 value = "" ;
1921
2022 /**
21- * APIProperty: name
22- * {String} 验证信息前缀，name=value部分的name部分，默认为“token”。
23+ * @member SuperMap.Bounds.prototype. name -{string}
24+ * @description 验证信息前缀，name=value部分的name部分，默认为“token”。
2325 */
2426 name = "token" ;
25-
2627 /**
27- * Constructor: SuperMap.Credential
28- * SuperMap地图服务安全验证类。
29- *
30- * 例如:
31- * (start code)
32- * var pixcel = new SuperMap.Credential("valueString","token");
33- * pixcel.destroy();
34- * (end)
28+ * @member SuperMap.Credential.CREDENTIAL -{SuperMap.Credential}
29+ * @description 这个对象保存一个安全类的实例，在服务端需要安全验证的时候必须进行设置。
30+ * @constant
31+ * @example
32+ * 代码实例:
33+ * // 当iServer启用服务安全的时候，下边的代码是必须的。安全证书类能够接收一个value和一个name参数。
34+ * var value = "(以iServer为例，这里是申请的token值)";
35+ * var name = "token";
36+ * // 默认name参数为token，所以当使用iServer服务的时候可以不进行设置。
37+ * SuperMap.Credential.CREDENTIAL = new SuperMap.Credential(value, name);
3538 *
36- * Parameters:
37- * value - {String} 访问受安全限制的服务时用于通过安全认证的验证信息。
38- * name - {String} 验证信息前缀，name=value部分的name部分，默认为“token”。
3939 */
40+
41+ static CREDENTIAL = null ;
42+
4043 constructor ( value , name ) {
4144 this . value = value ? value : this . value ;
4245 this . name = name ? name : this . name ;
4346 }
4447
4548 /**
46- * Property: getUrlParameters
47- *
48- * 例如:
49- * (start code)
49+ * @function SuperMap.Credential.prototype.getUrlParameters
50+ * @example
5051 * var credential = new SuperMap.Credential("valueString","token");
5152 * //这里 str = "token=valueString";
5253 * var str = credential.getUrlParameters();
53- * (end)
54- *
55- * Returns:
56- * {String} 返回安全信息组成的url片段。
54+ * @returns {string } 返回安全信息组成的url片段。
5755 */
5856 getUrlParameters ( ) {
5957 //当需要其他安全信息的时候，则需要return this.name + "=" + this.value + "&" + "...";的形式添加。
@@ -62,35 +60,25 @@ export default class Credential {
6260
6361
6462 /**
65- * APIProperty: getValue
66- * 获取value
67- *
68- * 例如:
69- * (start code)
63+ * @function SuperMap.Bounds.prototype.getValue
64+ * @description 获取value
65+ * @example
7066 * var credential = new SuperMap.Credential("2OMwGmcNlrP2ixqv1Mk4BuQMybOGfLOrljruX6VcYMDQKc58Sl9nMHsqQaqeBx44jRvKSjkmpZKK1L596y7skQ..","token");
7167 * //这里 str = "2OMwGmcNlrP2ixqv1Mk4BuQMybOGfLOrljruX6VcYMDQKc58Sl9nMHsqQaqeBx44jRvKSjkmpZKK1L596y7skQ..";
7268 * var str = credential.getValue();
73- * (end)
74- *
75- * Returns:
76- * {String} 返回value字符串，在iServer服务下该value值即为token值。
69+ * @returns {string } 返回value字符串，在iServer服务下该value值即为token值。
7770 */
7871 getValue ( ) {
7972 return this . value ;
8073 }
8174
8275 /**
8376 *
84- * APIMethod: destroy
85- * 销毁此对象。
86- * 销毁后此对象的所有属性为null，而不是初始值。
87- *
88- * 例如:
89- * (start code)
77+ * @function SuperMap.Credential.prototype.destroy
78+ * @description 销毁此对象。销毁后此对象的所有属性为null，而不是初始值。
79+ * @example
9080 * var credential = new SuperMap.Credential("valueString","token");
9181 * credential.destroy();
92- * (end)
93- *
9482 */
9583 destroy ( ) {
9684 this . value = null ;
@@ -101,20 +89,3 @@ export default class Credential {
10189 CLASS_NAME = "SuperMap.Credential"
10290}
10391SuperMap . Credential = Credential ;
104- /**
105- * Constant: CREDENTIAL
106- * {<SuperMap.Credential>} 这个对象保存一个安全类的实例，在服务端需要安全验证的时候必须进行
107- * 设置。
108- *
109- * 代码实例:
110- * (code)
111- * // 当iServer启用服务安全的时候，下边的代码是必须的。安全证书类能够接收一个value和一个name参数。
112- * var value = "(以iServer为例，这里是申请的token值)";
113- * var name = "token";
114- * // 默认name参数为token，所以当使用iServer服务的时候可以不进行设置。
115- * SuperMap.Credential.CREDENTIAL = new SuperMap.Credential(value, name);
116- * (end)
117- *
118- */
119-
120- SuperMap . Credential . CREDENTIAL = null ;
0 commit comments