85 lines
1.6 KiB
Markdown
85 lines
1.6 KiB
Markdown
## 星云SDK
|
||
|
||
### 1. 安装
|
||
|
||
```git
|
||
npm install star-cloud-web
|
||
```
|
||
|
||
### 2. 使用
|
||
|
||
```javascript
|
||
import {
|
||
init,
|
||
Result,
|
||
register,
|
||
logout,
|
||
getOfflinePassword,
|
||
removeBadLock,
|
||
getLockSupportFeatures,
|
||
getServerTimestamp
|
||
} from 'star-cloud-web'
|
||
|
||
/**
|
||
* 初始化星云
|
||
* @param params
|
||
* @param {String} params.clientId 客户端Id
|
||
* @param {String} params.clientSecret 客户端密码
|
||
* @param {Array<AccountInfo>} params.accounts 账号列表，后续方法中需传入uid，若未传入则默认使用第一个账号
|
||
* @param {String} params.env 环境
|
||
*/
|
||
init(params)
|
||
|
||
/**
|
||
* 注册星云
|
||
* @returns Result
|
||
*/
|
||
const { code, data, message } = await register()
|
||
if (code === Result.Success.code) {
|
||
// 逻辑代码
|
||
} else {
|
||
// 错误处理
|
||
}
|
||
|
||
/**
|
||
* 退出登录
|
||
* @param params
|
||
* @param {Number} params.uid 用户ID
|
||
* @returns Result
|
||
*/
|
||
const { code, data, message } = await logout(params)
|
||
|
||
/**
|
||
* 获取离线密码
|
||
* @param params
|
||
* @param {Number} [params.uid] 用户ID
|
||
* @param {OfflinePassword} params.password 密码信息
|
||
* @returns Result
|
||
*/
|
||
const data = await getOfflinePassword(params)
|
||
|
||
/**
|
||
* 移除坏锁
|
||
* @param params
|
||
* @param {Number} [params.uid] 用户ID
|
||
* @param {List[Number]} params.lockIds 锁Id列表
|
||
* @returns Result
|
||
*/
|
||
const data = await removeBadLock(params)
|
||
|
||
/**
|
||
* 获取服务器时间
|
||
* @returns Result
|
||
*/
|
||
const data = await getServerTimestamp()
|
||
|
||
/**
|
||
* 获取锁支持项
|
||
* @param params
|
||
* @param {Number} [params.uid] 用户ID
|
||
* @param {Number} params.lockId 锁 Id
|
||
* @returns Result
|
||
*/
|
||
const data = await getLockSupportFeatures(params)
|
||
```
|