Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
uni-app
提交
4ec515fc
U
uni-app
项目概览
DCloud
/
uni-app
2 个月 前同步成功
通知
717
Star
38705
Fork
3642
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
7
列表
看板
标记
里程碑
合并请求
1
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
uni-app
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
7
Issue
7
列表
看板
标记
里程碑
合并请求
1
合并请求
1
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
4ec515fc
编写于
6月 18, 2020
作者:
hbcui1984
提交者:
GitHub
6月 18, 2020
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
删除客户端示例代码
上级
cb0faef4
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
289 addition
and
446 deletion
+289
-446
docs/uniCloud/uni-id.md
docs/uniCloud/uni-id.md
+289
-446
未找到文件。
docs/uniCloud/uni-id.md
浏览文件 @
4ec515fc
## 简介
`uni-id`
是
`uniCloud`
提供的一套标准化的用户中心,我们的目标是使用
`uni-id`
可以轻松的对接各种各样的系统。
## 用户注册 @register
用法
`uniID.register(Object user)`
**user参数说明**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| username | String| 是 |用户名,唯一 |
| password | String| 是 |密码 |
**响应参数**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| code | Number| 是 |错误码,0表示成功 |
| msg | String| 是 |详细信息 |
| token | String| - |注册完成自动登录之后返回的token信息|
**示例代码**
```
js
// 云函数代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
username
,
password
}
=
event
// username、password验证是否合法的逻辑
const
res
=
await
uniID
.
register
({
username
,
password
})
return
res
}
// 客户端代码
uniCloud
.
callFunction
({
name
:
'
register
'
,
data
:
{
username
:
'
username
'
,
password
:
'
user password
'
},
success
(
res
){
if
(
res
.
result
.
code
===
0
)
{
uni
.
setStorageSync
(
'
uniIdToken
'
,
res
.
result
.
token
)
// 其他业务代码,如跳转到首页等
uni
.
showToast
({
title
:
'
注册成功
'
,
icon
:
'
none
'
})
}
else
{
uni
.
showModal
({
content
:
res
.
result
.
msg
,
showCancel
:
false
})
}
},
fail
(){
uni
.
showModal
({
content
:
'
注册失败,请稍后再试
'
,
showCancel
:
false
})
}
})
```
## 用户登录 @login
用法:
`uniID.login(Object user)`
**user参数说明**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| username | String| 是 |用户名 |
| password | String| 是 |密码 |
**响应参数**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| code | Number| 是 |错误码,0表示成功 |
| msg | String| 是 |详细信息 |
| token | String| - |登录成功之后返回的token信息|
**示例代码**
```
js
// 云函数代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
username
,
password
}
=
event
// username、password验证是否合法的逻辑
const
res
=
await
uniID
.
login
({
username
,
password
})
return
res
}
// 客户端代码
uniCloud
.
callFunction
({
name
:
'
login
'
,
data
:
{
username
:
'
username
'
,
password
:
'
user password
'
},
success
(
res
){
if
(
res
.
result
.
code
===
0
)
{
uni
.
setStorageSync
(
'
uniIdToken
'
,
res
.
result
.
token
)
// 其他业务代码,如跳转到首页等
uni
.
showToast
(
'
注册成功
'
)
}
else
{
uni
.
showModal
({
content
:
res
.
result
.
msg
,
showCancel
:
false
})
}
},
fail
(){
uni
.
showModal
({
content
:
'
登录失败,请稍后再试
'
,
showCancel
:
false
})
}
})
```
## 修改密码 @update-password
用法:
`uniID.updatePwd(Object passwordInfo)`
**passwordInfo参数说明**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| oldPassword | String| 是 |旧密码 |
| newPassword | String| 是 |新密码 |
| passwordConfirmation | String| 是 |确认新密码 |
**响应参数**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| code | Number| 是 |错误码,0表示成功 |
| msg | String| 是 |详细信息 |
**示例代码**
```
js
// 云函数update-pwd代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
oldPassword
,
newPassword
,
passwordConfirmation
}
=
event
// 校验新密码与确认新密码是否一致
const
res
=
await
uniID
.
updatePwd
({
oldPassword
,
newPassword
,
passwordConfirmation
})
return
res
}
// 客户端代码
uniCloud
.
callFunction
({
name
:
'
update-pwd
'
,
data
:
{
oldPassword
:
'
oldPassword
'
,
newPassword
:
'
newPassword
'
,
passwordConfirmation
:
'
confirmed new password
'
},
success
(
res
){
if
(
res
.
result
.
code
===
0
)
{
// 修改成功跳转到登录页面
}
else
{
uni
.
showModal
({
content
:
res
.
result
.
msg
,
showCancel
:
false
})
}
},
fail
(){
uni
.
showModal
({
content
:
'
修改失败,请稍后再试
'
,
showCancel
:
false
})
}
})
```
## 设置头像
用法:
`uniID.setAvatar(Object avatarInfo)`
**avatarInfo**
参数说明
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| avatar| String| 是 |用户头像URL|
**响应参数**
| 字段| 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code| Number| 是 |错误码,0表示成功|
| msg | String| 是 |详细信息 |
**示例代码**
```
js
// 云函数set-avatar代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
avatar
}
=
event
// 校验avatar链接合法性
const
res
=
await
uniID
.
setAvatar
({
avatar
})
return
res
}
// 客户端代码
uniCloud
.
callFunction
({
name
:
'
set-avatar
'
,
data
:
{
avatar
:
'
avatar url
'
},
success
(
res
){
if
(
res
.
result
.
code
===
0
)
{
// 修改成功
uni
.
showToast
({
title
:
'
头像修改成功
'
,
icon
:
'
none
'
})
}
else
{
uni
.
showModal
({
content
:
res
.
result
.
msg
,
showCancel
:
false
})
}
},
fail
(){
uni
.
showModal
({
content
:
'
修改失败,请稍后再试
'
,
showCancel
:
false
})
}
})
```
## 绑定手机号
用法:
`uniID.bindMobile(Object mobileInfo)`
**mobileInfo**
参数说明
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| mobile| String| 是 |用户手机号|
**响应参数**
| 字段| 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code| Number| 是 |错误码,0表示成功|
| msg | String| 是 |详细信息 |
**示例代码**
```
js
// 云函数bind-mobile代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
mobile
}
=
event
// 校验手机号合法性
const
res
=
await
uniID
.
bindMobile
({
mobile
})
return
res
}
// 客户端代码
uniCloud
.
callFunction
({
name
:
'
bind-mobile
'
,
data
:
{
mobile
:
'
mobile phone number
'
},
success
(
res
){
if
(
res
.
result
.
code
===
0
)
{
// 绑定成功
uni
.
showToast
({
title
:
'
手机号绑定成功
'
,
icon
:
'
none
'
})
}
else
{
uni
.
showModal
({
content
:
res
.
result
.
msg
,
showCancel
:
false
})
}
},
fail
(){
uni
.
showModal
({
content
:
'
绑定失败,请稍后再试
'
,
showCancel
:
false
})
}
})
```
## 绑定邮箱
用法:
`uniID.bindEmail(Object emailInfo)`
**emailInfo**
参数说明
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| email | String| 是 |用户邮箱 |
**响应参数**
| 字段| 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code| Number| 是 |错误码,0表示成功|
| msg | String| 是 |详细信息 |
**示例代码**
```
js
// 云函数bind-email代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
email
}
=
event
// 校验手机号合法性
const
res
=
await
uniID
.
bindEmail
({
email
})
return
res
}
// 客户端代码
uniCloud
.
callFunction
({
name
:
'
bind-email
'
,
data
:
{
email
:
'
user email
'
},
success
(
res
){
if
(
res
.
result
.
code
===
0
)
{
// 绑定成功
uni
.
showToast
({
title
:
'
邮箱绑定成功
'
,
icon
:
'
none
'
})
}
else
{
uni
.
showModal
({
content
:
res
.
result
.
msg
,
showCancel
:
false
})
}
},
fail
(){
uni
.
showModal
({
content
:
'
绑定失败,请稍后再试
'
,
showCancel
:
false
})
}
})
```
## 登出
用法:
`uniID.logout(String uid);`
参数说明
| 字段| 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| uid | String| 是 |用户uid|
**响应参数**
| 字段| 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code| Number| 是 |错误码,0表示成功|
| msg | String| 是 |详细信息 |
**示例代码**
```
js
// 云函数logout代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
uniIdToken
}
=
event
payload
=
await
uniID
.
checkToken
(
uniIdToken
)
if
(
payload
.
code
&&
payload
.
code
>
0
)
{
return
payload
}
const
res
=
await
uniID
.
logout
(
payload
.
uid
)
return
res
}
// 客户端代码
## 简介
`uni-id`
是
`uniCloud`
提供的一套标准化的用户中心,我们的目标是使用
`uni-id`
可以轻松的对接各种各样的系统。
## 用户注册 @register
用法
`uniID.register(Object user)`
**user参数说明**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| username | String| 是 |用户名,唯一 |
| password | String| 是 |密码 |
**响应参数**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| code | Number| 是 |错误码,0表示成功 |
| msg | String| 是 |详细信息 |
| token | String| - |注册完成自动登录之后返回的token信息|
**示例代码**
```
js
// 云函数代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
username
,
password
}
=
event
// username、password验证是否合法的逻辑
const
res
=
await
uniID
.
register
({
username
,
password
})
return
res
}
// 客户端代码
uniCloud
.
callFunction
({
name
:
'
logout
'
,
success
(
e
)
{
if
(
res
.
result
.
code
===
0
)
{
uni
.
showToast
({
title
:
'
登出成功
'
,
icon
:
'
none
'
name
:
'
register
'
,
data
:
{
username
:
'
username
'
,
password
:
'
user password
'
},
success
(
res
){
if
(
res
.
result
.
code
===
0
)
{
uni
.
setStorageSync
(
'
uniIdToken
'
,
res
.
result
.
token
)
// 其他业务代码,如跳转到首页等
uni
.
showToast
({
title
:
'
注册成功
'
,
icon
:
'
none
'
})
uni
.
removeStorageSync
(
'
uniIdToken
'
)
}
else
{
uni
.
showModal
({
content
:
res
.
result
.
msg
,
showCancel
:
false
})
}
},
fail
(
e
)
{
uni
.
showModal
({
content
:
'
登出失败,请稍后再试
'
,
showCancel
:
false
})
}
else
{
uni
.
showModal
({
content
:
res
.
result
.
msg
,
showCancel
:
false
})
}
},
fail
(){
uni
.
showModal
({
content
:
'
注册失败,请稍后再试
'
,
showCancel
:
false
})
}
})
```
## 用户登录 @login
用法:
`uniID.login(Object user)`
**user参数说明**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| username | String| 是 |用户名 |
| password | String| 是 |密码 |
**响应参数**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| code | Number| 是 |错误码,0表示成功 |
| msg | String| 是 |详细信息 |
| token | String| - |登录成功之后返回的token信息|
**示例代码**
```
js
// 云函数代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
username
,
password
}
=
event
// username、password验证是否合法的逻辑
const
res
=
await
uniID
.
login
({
username
,
password
})
return
res
}
```
## 修改密码 @update-password
用法:
`uniID.updatePwd(Object passwordInfo)`
**passwordInfo参数说明**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| oldPassword | String| 是 |旧密码 |
| newPassword | String| 是 |新密码 |
| passwordConfirmation | String| 是 |确认新密码 |
**响应参数**
| 字段 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| code | Number| 是 |错误码,0表示成功 |
| msg | String| 是 |详细信息 |
**示例代码**
```
js
// 云函数update-pwd代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
oldPassword
,
newPassword
,
passwordConfirmation
}
=
event
// 校验新密码与确认新密码是否一致
const
res
=
await
uniID
.
updatePwd
({
oldPassword
,
newPassword
,
passwordConfirmation
})
return
res
}
```
## 设置头像
用法:
`uniID.setAvatar(Object avatarInfo)`
**avatarInfo**
参数说明
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| avatar| String| 是 |用户头像URL|
**响应参数**
| 字段| 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code| Number| 是 |错误码,0表示成功|
| msg | String| 是 |详细信息 |
**示例代码**
```
js
// 云函数set-avatar代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
avatar
}
=
event
// 校验avatar链接合法性
const
res
=
await
uniID
.
setAvatar
({
avatar
})
return
res
}
```
## 绑定手机号
用法:
`uniID.bindMobile(Object mobileInfo)`
**mobileInfo**
参数说明
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| mobile| String| 是 |用户手机号|
**响应参数**
| 字段| 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code| Number| 是 |错误码,0表示成功|
| msg | String| 是 |详细信息 |
**示例代码**
```
js
// 云函数bind-mobile代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
mobile
}
=
event
// 校验手机号合法性
const
res
=
await
uniID
.
bindMobile
({
mobile
})
return
res
}
```
## 绑定邮箱
用法:
`uniID.bindEmail(Object emailInfo)`
**emailInfo**
参数说明
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| email | String| 是 |用户邮箱 |
**响应参数**
| 字段| 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code| Number| 是 |错误码,0表示成功|
| msg | String| 是 |详细信息 |
**示例代码**
```
js
// 云函数bind-email代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
email
}
=
event
// 校验手机号合法性
const
res
=
await
uniID
.
bindEmail
({
email
})
return
res
}
```
## 登出
用法:
`uniID.logout(String uid);`
参数说明
| 字段| 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| uid | String| 是 |用户uid|
**响应参数**
| 字段| 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| code| Number| 是 |错误码,0表示成功|
| msg | String| 是 |详细信息 |
**示例代码**
```
js
// 云函数logout代码
const
uniID
=
require
(
'
uni-id
'
)
exports
.
main
=
async
function
(
event
,
context
)
{
const
{
uniIdToken
}
=
event
payload
=
await
uniID
.
checkToken
(
uniIdToken
)
if
(
payload
.
code
&&
payload
.
code
>
0
)
{
return
payload
}
})
```
\ No newline at end of file
const
res
=
await
uniID
.
logout
(
payload
.
uid
)
return
res
}
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录