Skip to content

Commit 23e0ba8

Browse files
authored
Merge pull request #1368 from haoxiuwen/doc-v2
Remove User Authentication Page on Console From Docs
2 parents 508a10e + f5c0d48 commit 23e0ba8

25 files changed

+57
-163
lines changed
-16.3 KB
Binary file not shown.

docs/document/android/quickstart.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -168,23 +168,15 @@ options.setAppKey("Your appkey");
168168
// context 为上下文,在 Application 或者 Activity 中可以用 this 代替
169169
EMClient.getInstance().init(context, options);
170170
```
171-
### 2. 创建账号
171+
### 2. 创建用户
172172

173-
1.[环信控制台](https://console.easemob.com/user/login) 首页的**应用列表**中,在目标应用的 **操作** 栏中点击 **管理**
174-
175-
2. 在环信即时通讯云的左侧导航栏中,选择**应用概览 > 用户认证**
176-
177-
3.**用户认证**页面,点击**创建IM用户**按钮,在弹出的对话框中填写用户 ID 和密码,然后点击 **保存**
178-
179-
![img](/images/product/user_create_test.png)
180-
181-
创建用户后,你可以查看用户 token、设置 token 有效时间、重置密码、查询用户以及删除用户。
173+
[环信控制台](https://console.easemob.com/user/login) 创建用户,获取用户 ID 和用户 Token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)
182174

183175
在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
184176

185177
### 3. 登录账号
186178

187-
创建账号后,获取账号的用户 ID 和 Token使用如下代码实现用户登录:
179+
获取账号的用户 ID 和 Token 后,使用如下代码实现用户登录:
188180

189181
```java
190182
// 导包

docs/document/flutter/quickstart.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -253,27 +253,11 @@ void _initSDK() async {
253253
}
254254
```
255255

256-
### 注册环信 IM 用户
256+
### 创建用户
257257

258-
Demo 中使用 [开放注册](/document/server-side/account_system.html#开放注册单个用户),此操作需要在环信后台开启 `开放注册`。在开放注册模式下,允许通过 App 客户端直接注册环信用户,正式环境中请使用 [授权注册](/document/server-side/account_system.html#授权注册单个用户)
258+
[环信控制台](https://console.easemob.com/user/login) 创建用户,获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)
259259

260-
`_signUp` 方法中添加注册代码:
261-
262-
```dart
263-
void _signUp() async {
264-
if (_username.isEmpty || _password.isEmpty) {
265-
_addLogToConsole("username or password is null");
266-
return;
267-
}
268-
269-
try {
270-
await EMClient.getInstance.createAccount(_username, _password);
271-
_addLogToConsole("sign up succeed, username: $_username");
272-
} on EMError catch (e) {
273-
_addLogToConsole("sign up failed, e: ${e.code} , ${e.description}");
274-
}
275-
}
276-
```
260+
在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
277261

278262
### 添加登录
279263

docs/document/harmonyos/quickstart.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -124,21 +124,13 @@ ChatClient.getInstance().init(context, options);
124124

125125
### 2. 创建账号
126126

127-
1.[环信控制台](https://console.easemob.com/user/login) 首页的**应用列表**中,在目标应用的 **操作** 栏中点击 **管理**
128-
129-
2. 在环信即时通讯云的左侧导航栏中,选择**应用概览 > 用户认证**
130-
131-
3.**用户认证**页面,点击**创建IM用户**按钮,在弹出的对话框中填写用户 ID 和密码,然后点击 **保存**
132-
133-
![img](/images/product/user_create_test.png)
134-
135-
创建用户后,你可以查看用户 token、设置 token 有效时间、重置密码、查询用户以及删除用户。
127+
[环信控制台](https://console.easemob.com/user/login) 创建用户,获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)
136128

137129
在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
138130

139131
### 3. 登录账号
140132

141-
使用如下代码实现用户登录
133+
利用用户 ID 和用户 Token 实现用户登录
142134

143135
```typescript
144136
import { ChatClient, ChatError } from '@easemob/chatsdk';

docs/document/ios/quickstart.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -83,26 +83,10 @@ SDK 支持 **CocoaPods 导入**和**手动导入**两种方式。
8383

8484
## 4. 创建账号
8585

86-
1.[环信控制台](https://console.easemob.com/user/login)首页的 **应用列表** 中,在目标应用的 **操作** 栏中点击 **管理**
87-
88-
2. 在环信即时通讯云的左侧导航栏中,选择 **应用概览 > 用户认证**
89-
90-
3.**用户认证** 页面,点击 **创建IM用户** 按钮,在弹出的对话框中填写用户 ID 和密码,然后点击 **保存**
91-
92-
![img](/images/product/user_create_test.png)
93-
94-
创建用户后,你可以查看用户 token、设置 token 有效时间、重置密码、查询用户以及删除用户。
86+
[环信控制台](https://console.easemob.com/user/login) 创建用户,获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)
9587

9688
在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
9789

98-
```objectivec
99-
// 异步方法
100-
[[EMClient sharedClient] registerWithUsername:@"username"
101-
password:@"your password"
102-
completion:^(NSString *aUsername, EMError *aError) {
103-
}];
104-
```
105-
10690
## 5. 登录账号
10791

10892
利用创建的用户名和密码登录环信 IM。

docs/document/react-native/quickstart.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,13 @@ iOS 平台需要使用 `cocoapods` 进行初始化。
8080
cd ios && pod install && cd ..
8181
```
8282

83-
## 实现发送和接收单聊消息
83+
## 创建用户
84+
85+
[环信控制台](https://console.easemob.com/user/login) 创建用户,获取用户 ID 和用户 token 用于登录。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)
8486

85-
发送单聊消息前,终端用户需要先注册 Chat 账号,登录。
87+
在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
88+
89+
## 实现发送和接收单聊消息
8690

8791
建议使用 `visual studio code` 打开文件夹 `simple_demo`,打开文件 `App.js`,删除全部内容,并添加如下内容:
8892

docs/document/server-side/easemob_user_token_password.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ POST https://{host}/{org_name}/{app_name}/token
4848
| `grant_type` | String || 授权方式。将值设为 `password`,通过用户 ID 和密码获取 token,需设置 `username``password` 参数。 |
4949
| `username` | String || 用户 ID。 |
5050
| `password` | String || 用户的登录密码。 |
51-
| `ttl` | Long || token 有效期,单位为秒。<br/> - 若传入该参数,token 有效期以传入的值为准。<br/> - 若不传该参数,以 [环信即时通讯云控制台](https://console.easemob.com/user/login/)**用户认证** 页面的 token 有效期的设置为准。<br/> - 若设置为 `0`,则 token 永久有效。<br/>注意:VIP 5 集群该参数单位为毫秒。 |
51+
| `ttl` | Long || token 有效期,单位为秒。<br/> - 若传入该参数,token 有效期以传入的值为准。<br/> - 若不传该参数,以 [环信控制台](https://console.easemob.com/user/login/)**用户管理** 页面的 token 有效期的设置为准。<br/> - 若设置为 `0`,则 token 永久有效。<br/>注意:VIP 5 集群该参数单位为毫秒。 |
5252

5353
## HTTP 响应
5454

docs/document/unity/quickstart.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -117,22 +117,9 @@ SDKClient.Instance.InitWithOptions(options);
117117

118118
### 4. 创建账号
119119

120-
`SignUpAction` 方法尾部添加以下代码,创建即时通讯系统的登录账户,示例代码如下:
120+
[环信控制台](https://console.easemob.com/user/login) 创建用户,获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)
121121

122-
```csharp
123-
SDKClient.Instance.CreateAccount(username: Username.text, Password.text, callback: new CallBack(
124-
onSuccess: () => {
125-
AddLogToLogText("sign up sdk succeed");
126-
},
127-
onError: (code, desc) => {
128-
AddLogToLogText($"sign up sdk failed, code: {code}, desc: {desc}");
129-
}
130-
));
131-
```
132-
133-
:::tip
134-
该注册模式在客户端实现,简单方便,主要用于测试,但不推荐在正式环境中使用。正式环境中应使用服务器端[调用 Restful API 进行注册](/document/server-side/account_system.html#开放注册单个用户)。若需要使用 Token,需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
135-
:::
122+
在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
136123

137124
### 5. 登录账号
138125

docs/document/web/quickstart.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,19 +57,11 @@ Easemob_quickstart<br>
5757
}
5858
```
5959

60-
### 3. 创建账号
60+
### 3. 创建用户
6161

62-
1.[环信控制台](https://console.easemob.com/user/login)首页的 **应用列表** 中,在目标应用的 **操作** 栏中点击 **管理**
62+
[环信控制台](https://console.easemob.com/user/login) 创建用户,获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)
6363

64-
2. 在环信即时通讯云的左侧导航栏中,选择 **应用概览 > 用户认证**
65-
66-
3.**用户认证** 页面,点击 **创建IM用户** 按钮,在弹出的对话框中填写用户 ID 和密码,然后点击 **保存**
67-
68-
![img](/images/product/user_create_test.png)
69-
70-
创建用户后,你可以查看用户 token、设置 token 有效时间、重置密码、查询用户以及删除用户。
71-
72-
在生产环境中,若使用 Token 登录,为了安全考虑,你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
64+
在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
7365

7466
### 3. 实现用户界面
7567

docs/document/windows/quickstart.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -87,28 +87,11 @@ options.UsingHttpsOnly = true;
8787
SDKClient.Instance.InitWithOptions(options);
8888
```
8989

90-
### 4.创建账号
90+
### 4.创建用户
9191

92-
`SignUp_Click` 函数尾部添加以下代码,用于创建 AppServer 上的登录账户,示例代码如下:
92+
[环信控制台](https://console.easemob.com/user/login) 创建用户,获取用户 ID 和用户 token。详见 [创建用户文档](/product/enable_and_configure_IM.html#创建-im-用户)
9393

94-
```csharp
95-
SDKClient.Instance.CreateAccount(username, password, callback: new CallBack(
96-
onSuccess: () =>
97-
{
98-
AddLogToLogText("sign up succeed");
99-
},
100-
onError: (code, desc) =>
101-
{
102-
AddLogToLogText("sign up failed");
103-
}
104-
));
105-
```
106-
107-
:::tip
108-
1. 该注册模式为在客户端注册,主要用于测试,简单方便,但不推荐在正式环境中使用。
109-
2. 正式环境中,应使用服务器端调用 Restful API 注册,详见[注册用户](/document/server-side/account_system.html#注册用户)。若使用 Token 登录,你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
110-
111-
:::
94+
在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html)[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。
11295

11396
### 5. 登录账号
11497

0 commit comments

Comments
 (0)