获取用户信息
let MyUser = new BaaS.User()
获取指定用户信息
MyUser.get(userID)
参数说明
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
userID | Number | 是 | 用户 ID (对应 _userprofile 表中的 id 字段) |
返回字段说明
参数 | 类型 | 说明 |
---|---|---|
avatar | String | 用户头像 |
city | String | 用户所在城市 |
country | String | 用户所在国家 |
gender | String | 用户的性别,值为 1 时是男性,值为 2 时是女性,值为 0 时是未知 |
id | Number | 用户 ID (对应 _userprofile 表中的 id 字段) |
language | String | 用户的语言,简体中文为 zh_CN |
nickname | String | 用户昵称 |
openid | String | 用户唯一标识,由微信生成 |
province | String | 用户所在省份 |
unionid | String | 用户在开放平台的唯一标识符,由微信生成 |
如果有自定义字段,则一并返回
请求示例
let MyUser = new BaaS.User()
let userID = 36395395
MyUser.get(userID).then(res => {
// success
}, err => {
// err
})
返回示例
{
"status": 200,
"data": {
"avatar": "https://xxx.jpg",
"id": 36395395,
"is_authorized": true,
"nickname": "姚凯伦",
"openid": "xxx",
"unionid": null
}
}
筛选返回字段
select 使用方法可以参考数据表 - 字段过滤小节
扩展字段
expand 使用方法可以参考数据表 - 字段扩展小节
请求示例
假设 _userprofile 表中有一个类型为 pointer 的字段,名称为 pointer_test_oder
, 指向了 test_order 表
let MyUser = new BaaS.User()
MyUser.expand(['pointer_test_oder']).select(['nickname', 'pointer_test_order']).get(123456).then((res) => {
// success
}, (err) => {
// err
})
请求结果
{
"status": 200,
"data": {
"pointer_test_order": {
"created_at": 1538966895,
"_table": "test_order",
"id": "5bbac56fbd66033df7fd0aa2",
"created_by": 61736923,
"updated_at": 1538966895
},
"nickname": "ifanrx"
}
}
let MyUser = new wx.BaaS.User()
MyUser.expand(['pointer_test_oder']).select(['nickname', 'pointer_test_order']).find().then((res) => {
// success
}, (err) => {
// err
})
请求结果
{
"status": 200,
"data": {
"meta": {
"next": null,
"offset": 0,
"total_count": 1,
"limit": 20,
"previous": null
},
"objects": [
{
"pointer_test_order": {
"id": "5bbac56fbd66033df7fd0aa2",
"_table": "test_order",
"created_by": 61736923,
"updated_at": 1538966895
},
"nickname": "ifanrx"
}
]
}
}
微信目前对小程序获取用户信息有两个小时的缓存设定,因此,如果一个用户修改了个人信息如头像、昵称等,需两个小时才能重新授权拿到最新的信息。
更新用户信息
更新用户信息与数据表更新数据项方法基本一致。这里只支持对 _userprofile 表中自定义的字段进行更新。
请求示例
let MyUser = new BaaS.User()
let userID = 36395395
let user = MyUser.getWithoutData(userID)
// age 为自定义字段
user.set('age', 30).update().then(res => {
// success
}, err => {
// err
})
查询,获取用户列表
用户查询与数据表查询方法一致
请求示例
let MyUser = new BaaS.User()
// 查找所有用户
MyUser.find()
// 查询 nickname 中包含 like 的用户
let query = new BaaS.Query()
query.contains('nickname', 'like')
MyUser.setQuery(query).find().then(res => {
// success
}, err => {
// err
})
查询用户组下的用户
_group 是一个系统定义的特殊字段,可以通过 _group 来查询指定用户组下的用户,目前只支持 in 查询。该字段仅支持查询,不支持删除和修改。
let MyUser = new BaaS.User()
let query = new BaaS.Query()
// 查询用户组 [123, 456, 789] 下的用户
query.in('_group', [123, 456, 789])
MyUser.setQuery(query).find().then(res => {
// success
}, err => {
// err
})
返回示例
成功时 res 结构如下
{
"status": 200,
"data": {
"meta": {
"limit": 20,
"next": null,
"offset": 0,
"previous": null,
"total_count": 3
},
"objects": [
{
"age": 40,
"avatar": "https://media.ifanrusercontent.com/tavatar/f1/e8/f1e8da860635ec7386102a4a9bb5e45857c9369e.jpg",
"city": "Guangzhou",
"country": "China",
"created_at": 1513326300,
"created_by": 36476036,
"gender": 1,
"id": 36476036,
"is_authorized": true,
"language": "zh_CN",
"nickname": "yuky123123",
"openid": "xxxxxxx",
"province": "Guangdong",
"unionid": null,
"updated_at": 1524146181,
"_group": [123],
"user_id": 36476036
}
]
}
}
排序
用户查询排序与数据表排序方法一致,不包含在返回数据里的字段不支持排序,如 created_at。
请求示例
let MyUser = new BaaS.User()
MyUser.orderBy('-nickname').find().then()
分页
用户查询分页与数据表分页方法一致。
请求示例
let MyUser = new BaaS.User()
MyUser.limit(5).offset(10).find().then()
pointer 引用
使用 wx.BaaS.User().getWithoutData
可以创建一个 _userprofile 指定数据行的引用。主要配合 pointer 功能使用
let user = new BaaS.User().getWithoutData(123456)
具体使用方法请参考 数据表-添加 pointer 类型数据 小节