Bmob 新版ES6 SDK, 新版语法整合微信小程序、快应用、抖音小程序、H5等.zip

## SDK使用文档 ## 安装使用 ### 下载 > https://github.com/bmob/hydrogen-js-sdk/ ### 安装使用 **简介：** 1. 整个SDK，就dist目录下Bmob.*.js 这个文件即可使用全部功能 2. 目前支持微信小程序、H5、快应用、游戏Cocos、混合App等 **ps：这不只是微信小程序SDK，是跨平台SDK，相关平台都是引入**`Bmob-x.x.x.min.js` --- **引入：** 压缩包引入 ``` var Bmob = require('../dist/Bmob-x.x.x.min.js'); ``` 或者源码引入（nodejs必须源码引入） ``` var Bmob = require('./src/lib/app.js'); ``` ### 初始化 为了您的前端应用安全，SDK 2.0版本启用新的初始化key，新SDK请使用以下方式初始化，其他方法未变动 ``` Bmob.initialize("你的Secret Key", "你的API 安全码"); ``` **API 安全码**: 在应用功能设置，安全验证，API安全码自己设置 SDK版本 **2.0.0** 以下保留之前的初始化方法 ``` Bmob.initialize("你的Application ID", "你的REST API Key"); ``` 或者包引入方式 安装 ``` npm install hydrogen-js-sdk ``` 引入 ``` import Bmob from "hydrogen-js-sdk"; ``` 使用ES6前端相关框架，建议使用此方式引入。快应用由于网络包不支持npm，暂时不支持npm，头条小程序可以跟小程序一样使用。 Vue示例 ``` // 安装 npm install hydrogen-js-sdk // 打开 main.js import Bmob from "hydrogen-js-sdk"; // 初始化 SDK版本 2.0.0 以下保留之前的初始化方法 Bmob.initialize("你的Application ID", "你的REST API Key"); 或者-------- // 初始化 SDK版本 2.0.0 以及之后版本 Bmob.initialize("你的Secret Key", "你的API 安全码"); // 挂载到全局使用 Vue.prototype.Bmob = Bmob // 项目其他页面使用跟小程序一样使用Bmob对象即可，例如： Bmob.User.login('username','password').then(res => { console.log(res) }).catch(err => { console.log(err) }); ``` ## 用户操作 ### 登陆 **简介：** 通过用户名密码登陆，登陆成功后会在本地缓存保存用户的信息 **参数说明：** | 参数 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------ | | username | string | 是 | 用户名 | | password | string | 是 | 密码 | **请求示例：** ``` Bmob.User.login('username','password').then(res => { console.log(res) }).catch(err => { console.log(err) }); ``` **返回示例:** ``` 成功： { "createdAt":"2018-04-19 17:26:45", "objectId":"X43SIIIH", "sessionToken":"cc4fbcfd40583af980f4e6e52085adbf", "updatedAt":"2018-04-19 17:26:48", "username":"aaaaaa" } 失败： {"code":101,"error":"username or password incorrect."} ``` ### 注册 **简介：** 通过用户名密码注册 **参数说明：** | 参数 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------ | | username | string | 是 | 用户名 | | password | string | 是 | 密码 | | email | string | 是 | 邮箱 | | phone | string | 否 | 手机 | **请求示例：** ``` let params = { username: 'bmob2018', password: 'bmob2018', email: '[email protected]', phone: '13711166567', } Bmob.User.register(params).then(res => { console.log(res) }).catch(err => { console.log(err) }); ``` **返回示例:** ``` 成功： { "createdAt":"2018-04-19 17:42:59", "objectId":"73d4587140", "sessionToken":"14683f9a40b2509d80320bf0d4ec7d6e" } 失败： {"code":107,"error":"content is empty."} ``` ### 手机验证码登陆 **简介：** 手机号码和验证码一键快速登录的功能，而 **smsCode** 是调用短信请求验证码函数 **参数说明：** | 参数 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ------ | | phone | Number | 是 | 用户名 | | smsCode | Number | 是 | 密码 | **请求示例：** ``` Bmob.User.signOrLoginByMobilePhone(phone,smsCode).then(res => { console.log(res) }).catch(err => { console.log(err) }); ``` **返回示例:** ``` 成功： { "username": username, "mobilePhoneNumber": mobilePhoneNumber, "mobilePhoneVerified": boolValue, "createdAt": YYYY-mm-dd HH:ii:ss, "updatedAt": YYYY-mm-dd HH:ii:ss, "objectId": objectId, "sessionToken": sessionToekn, key1:value1, key2:value2, ... } 失败： {"code":207,"error":"code error."} ``` ### 更新用户缓存 **简介：** 通过用户名密码登陆，登陆成功后会在本地缓存保存用户的信息 **参数说明：** | 参数 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | -------- | | objectId | string | 是 | objectId | **请求示例：** ``` Bmob.User.updateStorage('objectId').then(res => { console.log(res) }).catch(err => { console.log(err) }); ``` **返回示例:** ``` 成功： { "createdAt":"2018-04-19 17:26:45", "objectId":"X43SIIIH", "sessionToken":"cc4fbcfd40583af980f4e6e52085adbf", "updatedAt":"2018-04-19 17:26:48", "username":"aaaaaa" } ``` ### 用户表权限 **简介： ** 用户表属于系统表，默认情况下，接口只能查询。如需修改或删除，请登录当前用户，即可修改或删除当前用户资料。 当然了，你也可以直接把`MasterKey`传入到`X-Bmob-Master-Key`中, 这个就可以实现在不需要提供`SessionToken`的情形下更新和删除用户了，但希望只在开发环境下使用，不要把`MasterKey`发布出去。 传入MasterKey方式： ``` //初始化时，多传入一个参数 Bmob.initialize("你的Application ID", "你的REST API Key", "你的MasterKey"); ``` ### 退出登录 **简介：** 执行退出函数，会退出登录状态，并清理本地全部缓存 **请求示例：** ``` Bmob.User.logout() ``` ### 查询用户 **简介：** 你可以一次获取多个用户，只要向用户的根URL发送一个GET请求，没有任何URL参数的话，可以简单地列出100个用户。 所有的对普通对象的查询选项都适用于对用户对象的查询，所以可以查看 查询 部分来获取详细信息。 User表是一个特殊的表，专门用于存储用户对象。在浏览器端，你会看到一个User表旁边有一个小人的图标。 **参数说明：** 无需参数 **请求示例：** ``` Bmob.User.users().then(res => { console.log(res) }).catch(err => { console.log(err) }) ``` **返回示例:** ``` { results: [ {createdAt: "2018-04-19 17:26:45", objectId: "X43SIIIH", updatedAt: "2018-04-19 17:26:48",…} {createdAt: "2018-04-19 17:42:59", email: "[email protected]", objectId: "73d4587140",…} ] } ``` ### 获取用户登录信息 **简介：** 此函数获取本地缓存用户信息，登陆后才有值，使用值前请先判断是否为空。 ``` //获取用户当前信息 let current = Bmob.User.current() //由于快应用新推出暂时不支持同步获取，如果是快应用请用以下写法 Bmob.User.current().then(result => { console.log(result) }).catch(err => { console.log(err) }) ``` **返回示例:** ``` 成功： { "createdAt":"2018-04-19 17:26:45", "objectId":"X43SIIIH", "sessionToken":"cc4fbcfd40583af980f4e6e52085adbf", "updatedAt":"2018-04-19 17:26:48", "username":"aaaaaa" } 失败： {"code":101,"error":"username or password incorrect."} ``` ### 验证 Email **简介：** 设置邮件验证是一个可选的应用设置, 这样可以对已经确认过邮件的用户提供一部分保留的体验，邮件验证功能会在用户(User)对象中加入emailVerified字段, 当一个用户的邮件被新添加或者修改过的话，emailVerified会默认被设为false，如果应用设置中开启了邮箱认证功能，[Bmob](http://www.bmob.cn/)会对用户填写的邮箱发送一个链接, 这个链接可以把emailVerified设置为 true. emailVerified 字段有 3 种状态可以考虑： **true** : 用户可以点击邮件中的链接通过[Bmob](http://www.bmob.cn/)来验证地址，一个用户永远不会在新创�