Skip to content

Commit c85165b

Browse files
authored
Merge pull request #74 from xuchengpu/shengwang
update android doc of shengwang
2 parents e8aba0f + 6d7da6b commit c85165b

File tree

7 files changed

+50
-125
lines changed

7 files changed

+50
-125
lines changed

docs/docs/sdk/android/integration.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@
1414

1515
:::tip
1616

17-
1. 以下集成方式只需选择一种,同时使用多种集成方式可能会报错。
18-
2. 请点击查看[发版说明](releasenote.html)获得最新版本号。
17+
以下集成方式只需选择一种,同时使用多种集成方式可能会报错。
1918

2019
:::
2120

@@ -48,15 +47,15 @@ dependencyResolutionManagement {
4847
dependencies {
4948
...
5049
// x.y.z 请填写具体版本号,如:1.3.2。
51-
implementation("cn.shengwang:chat-sdk:x.y.z")
50+
implementation 'cn.shengwang:chat-sdk:1.3.2'
5251
}
5352
```
54-
// TODO:修改版本号及repo地址链接
55-
若要查看最新版本号,请点击[这里](releasenote.html)
5653

57-
### 方法二:手动复制 SDK 文件
54+
若要查看最新版本号,请点击[这里](https://central.sonatype.com/artifact/cn.shengwang/chat-sdk/versions)
5855

59-
打开 SDK 下载页面,获取最新版的即时通讯 IM Android SDK,然后解压。
56+
### 方法二:本地集成(将jar包和so文件拷贝到项目中)
57+
58+
打开 SDK [下载页面]( https://im.shengwang.cn/),获取最新版的即时通讯 IM Android SDK,然后解压。
6059

6160
![img](@static/images/android/sdk-files.png)
6261

@@ -72,7 +71,7 @@ dependencies {
7271

7372
如果对生成的 `apk` 大小比较敏感,我们建议使用 `jar` 方式,并且手工拷贝 `so`,而不是使用 `aar`,因为 `aar` 方式会把各个平台的 `so` 文件都包含在其中。采用 `jar` 方式,可以仅保留一个 `ARCH` 目录,建议仅保留 `armeabi-v7a`,这样虽然在对应平台执行的速度会降低,但是能有效减小 `apk` 的大小。
7473

75-
### 方法三:动态加载 .so 库文件
74+
### 方法三:本地集成(动态加载 .so 库文件)
7675

7776
为了减少应用安装包的大小,SDK 提供了 `ChatOptions#setNativeLibBasePath` 方法支持动态加载 SDK 所需的 `.so` 文件。以 SDK 1.3.2 为例,`.so` 文件包括 `libcipherdb.so``libagora-chat-sdk.so``libaosl.so` 三个文件**
7877

docs/docs/sdk/android/quickstart.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,11 @@ dependencyResolutionManagement {
6868
dependencies {
6969
...
7070
// x.y.z 请填写具体版本号,如:1.3.2。
71-
implementation("cn.shengwang:chat-sdk:x.y.z")
71+
implementation 'cn.shengwang:chat-sdk:1.3.2'
7272
}
7373
```
7474

75-
// TODO:修改版本号及repo地址链接
76-
若要查看最新版本号,请点击[这里](releasenote.html)
75+
若要查看最新版本号,请点击[这里](https://central.sonatype.com/artifact/cn.shengwang/chat-sdk/versions)
7776

7877
除此之外,你还可以通过手动复制 SDK 文件和动态加载 `.so` 库文件的方法集成 IM SDK,详见[集成文档](integration.html)
7978

docs/docs/sdk/android/userprofile.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@
4040
// 设置所有用户属性。
4141
UserInfo userInfo = new UserInfo();
4242
userInfo.setUserId(ChatClient.getInstance().getCurrentUser());
43-
userInfo.setNickname("easemob");
44-
userInfo.setAvatarUrl("https://www.easemob.com");
43+
userInfo.setNickname("shengwang");
44+
userInfo.setAvatarUrl("https://www.shengwang.com");
4545
userInfo.setBirth("2000.10.10");
4646
userInfo.setSignature("hello world");
4747
userInfo.setPhoneNumber("13333333333");
@@ -141,13 +141,6 @@ ChatClient.getInstance().chatManager().sendMessage(message);
141141

142142
如果需要在名片中展示更丰富的信息,可以在 `ext` 中增加更多字段。
143143

144-
// TODO:替换链接
145-
可参考 [示例项目](https://www.easemob.com/download/im) 中的以下类:
146-
147-
- `ChatUserCardAdapterDelegate`
148-
- `ChatUserCardAdapterDelegate`
149-
- `ChatRowUserCard`
150-
151144
### 常见问题
152145

153146
Q:我设置了用户昵称(`nickname`),但调用客户端或 RESTful API 获取用户属性时,未返回用户昵称,原因是什么?

docs/docs/uikit/chatuikit/android/chatuikit_chat.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ class ChatActivity: AppCompactActivity() {
5252

5353
```kotlin
5454
// conversationID: 单聊为对端用户的用户 ID,群聊为群组 ID。
55-
// easeChatType: 单聊和群聊分别为 SINGLE_CHAT 和 GROUP_CHAT。
56-
UIKitChatFragment.Builder(conversationID, easeChatType)
55+
// chatType: 单聊和群聊分别为 SINGLE_CHAT 和 GROUP_CHAT。
56+
UIKitChatFragment.Builder(conversationID, chatType)
5757
.useTitleBar(true)
5858
.setTitleBarTitle("title")
5959
.setTitleBarSubTitle("subtitle")
@@ -115,14 +115,14 @@ UIKitChatFragment.Builder(conversationID, easeChatType)
115115
| setChatInputMenuHint() | 设置菜单区域输入文本框的提示文字。 |
116116
| sendMessageByOriginalImage() | 设置图片消息是否发送原图:<br/> - `true`:是。 <br/> - (默认) `false`: 否。 |
117117
| setEmptyLayout() | 设置聊天列表的空白页面。 |
118-
| setCustomAdapter() | 设置自定义的适配器,默认为 `EaseMessageAdapter`|
118+
| setCustomAdapter() | 设置自定义的适配器,默认为 `ChatUIKitMessagesAdapter`|
119119
| setCustomFragment() | 设置自定义聊天 Fragment,需要继承自 `UIKitChatFragment`|
120120

121121
### 添加自定义消息布局
122122

123-
开发者可以继承 `EaseMessageAdapter``ChatUIKitRowViewHolder``ChatUIKitRow`,实现自己的 `CustomMessageAdapter``CustomChatTypeViewViewHolder``CustomTypeChatRow`,然后将 `CustomMessageAdapter` 设置到 `UIKitChatFragment#Builder#setCustomAdapter` 中。
123+
开发者可以继承 `ChatUIKitMessagesAdapter``ChatUIKitRowViewHolder``ChatUIKitRow`,实现自己的 `CustomMessageAdapter``CustomChatTypeViewViewHolder``CustomTypeChatRow`,然后将 `CustomMessageAdapter` 设置到 `UIKitChatFragment#Builder#setCustomAdapter` 中。
124124

125-
1. 创建自定义适配器 `CustomMessageAdapter` 继承自 `EaseMessageAdapter`,重写 `getViewHolder``getItemNotEmptyViewType` 方法。
125+
1. 创建自定义适配器 `CustomMessageAdapter` 继承自 `ChatUIKitMessagesAdapter`,重写 `getViewHolder``getItemNotEmptyViewType` 方法。
126126

127127
```kotlin
128128
class CustomMessageAdapter: ChatUIKitMessagesAdapter() {
@@ -133,7 +133,7 @@ class CustomMessageAdapter: ChatUIKitMessagesAdapter() {
133133
return CUSTOM_YOUR_MESSAGE_TYPE
134134
}
135135

136-
override fun getViewHolder(parent: ViewGroup, viewType: Int): ViewHolder<EaseMessage> {
136+
override fun getViewHolder(parent: ViewGroup, viewType: Int): ViewHolder<ChatMessage> {
137137
// 根据返回的 viewType 返回对应的 ViewHolder。
138138
// 返回自定义的 ViewHolder 或者使用默认的 super.getViewHolder(parent, viewType)。
139139
return CUSTOM_VIEW_HOLDER()
@@ -172,7 +172,7 @@ class CustomChatTypeViewViewHolder(
172172
itemView: View
173173
): ChatUIKitRowViewHolder(itemView) {
174174

175-
override fun onBubbleClick(message: EaseMessage?) {
175+
override fun onBubbleClick(message: ChatMessage?) {
176176
super.onBubbleClick(message)
177177
// 添加点击事件
178178
}
@@ -201,7 +201,7 @@ class CustomMessageAdapter: ChatUIKitMessagesAdapter() {
201201
return super.getItemNotEmptyViewType(position)
202202
}
203203

204-
override fun getViewHolder(parent: ViewGroup, viewType: Int): ViewHolder<EaseMessage> {
204+
override fun getViewHolder(parent: ViewGroup, viewType: Int): ViewHolder<ChatMessage> {
205205
// 根据返回的 viewType 返回对应的 ViewHolder。
206206
if (viewType == VIEW_TYPE_MESSAGE_CUSTOM_VIEW_ME || viewType == VIEW_TYPE_MESSAGE_CUSTOM_VIEW_OTHER) {
207207
CustomChatTypeViewViewHolder(
@@ -503,7 +503,7 @@ chatMessageListLayout?.let{
503503
}
504504

505505
// UIKitChatFragment#Builder 中也提供了部分消息列表相关配置项
506-
UIKitChatFragment.Builder(conversationID, easeChatType)
506+
UIKitChatFragment.Builder(conversationID, chatType)
507507
.showNickname() //是否显示昵称:true:是;(默认) false: 否。
508508
.setMsgTimeTextColor() //设置时间线文本的颜色。
509509
.setMsgTimeTextSize() //设置时间线文本的字体大小。
@@ -520,9 +520,9 @@ UIKitChatFragment.Builder(conversationID, easeChatType)
520520

521521
自定义消息表中列表项的内容,即各种消息类型的自定义消息布局。
522522

523-
开发者可以继承 `EaseMessageAdapter``ChatUIKitRowViewHolder``ChatUIKitRow` 实现自己的 `CustomMessageAdapter``CustomChatTypeViewViewHolder``CustomTypeChatRow`,然后将 `CustomMessageAdapter` 设置到 `UIKitChatFragment#Builder#setCustomAdapter` 中。
523+
开发者可以继承 `ChatUIKitMessagesAdapter``ChatUIKitRowViewHolder``ChatUIKitRow` 实现自己的 `CustomMessageAdapter``CustomChatTypeViewViewHolder``CustomTypeChatRow`,然后将 `CustomMessageAdapter` 设置到 `UIKitChatFragment#Builder#setCustomAdapter` 中。
524524

525-
1. 创建自定义适配器 `CustomMessageAdapter` 继承自 `EaseMessageAdapter`,重写 `getViewHolder``getItemNotEmptyViewType` 方法。
525+
1. 创建自定义适配器 `CustomMessageAdapter` 继承自 `ChatUIKitMessagesAdapter`,重写 `getViewHolder``getItemNotEmptyViewType` 方法。
526526

527527
```kotlin
528528
class CustomMessageAdapter: ChatUIKitMessagesAdapter() {
@@ -533,7 +533,7 @@ class CustomMessageAdapter: ChatUIKitMessagesAdapter() {
533533
return CUSTOM_YOUR_MESSAGE_TYPE
534534
}
535535

536-
override fun getViewHolder(parent: ViewGroup, viewType: Int): ViewHolder<EaseMessage> {
536+
override fun getViewHolder(parent: ViewGroup, viewType: Int): ViewHolder<ChatMessage> {
537537
// 根据返回的 viewType 返回对应的 ViewHolder。
538538
// 返回自定义的 ViewHolder 或者使用默认的 super.getViewHolder(parent, viewType)。
539539
return CUSTOM_VIEW_HOLDER()
@@ -572,7 +572,7 @@ class CustomChatTypeViewViewHolder(
572572
itemView: View
573573
): ChatUIKitRowViewHolder(itemView) {
574574

575-
override fun onBubbleClick(message: EaseMessage?) {
575+
override fun onBubbleClick(message: ChatMessage?) {
576576
super.onBubbleClick(message)
577577
// Add click event
578578
}
@@ -601,7 +601,7 @@ class CustomMessageAdapter: ChatUIKitMessagesAdapter() {
601601
return super.getItemNotEmptyViewType(position)
602602
}
603603

604-
override fun getViewHolder(parent: ViewGroup, viewType: Int): ViewHolder<EaseMessage> {
604+
override fun getViewHolder(parent: ViewGroup, viewType: Int): ViewHolder<ChatMessage> {
605605
// 根据返回的 viewType 返回对应的 ViewHolder。
606606
if (viewType == VIEW_TYPE_MESSAGE_CUSTOM_VIEW_ME || viewType == VIEW_TYPE_MESSAGE_CUSTOM_VIEW_OTHER) {
607607
CustomChatTypeViewViewHolder(

docs/docs/uikit/chatuikit/android/chatuikit_integrated.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,14 @@
1414

1515
## 集成单群聊 UIKit
1616

17-
### Module 远程依赖
18-
19-
在 app 项目 `build.gradle.kts` 中添加以下依赖:
20-
21-
```kotlin
22-
// TODO: 替换为最新版本号和仓库地址
23-
implementation("cn.shengwang:chat-uikit:1.3.2")
24-
```
25-
// TODO: 替换链接
26-
若要查看最新版本号,请点击[这里](https://central.sonatype.com/artifact/io.hyphenate/ease-chat-kit/versions)
27-
2817
### 本地依赖
29-
// TODO: 替换链接
3018
从 GitHub 获取[单群聊 UIKit](https://github.com/Shengwang-Community/ShengwangChat-UIKit-android) 源码,按照下面的方式集成:
3119

3220
1. 在根目录 `settings.gradle.kts` 文件中添加如下代码:
3321

3422
```kotlin
3523
include(":chat-uikit")
36-
project(":chat-uikit").projectDir = File("../AgoraChat-UIKit-android/ease-im-kit")
24+
project(":chat-uikit").projectDir = File("../ShengwangChat-UIKit-android/ease-im-kit")
3725
```
3826

3927
2. 在 app 的 `build.gradle.kts` 文件中添加如下代码:

docs/docs/uikit/chatuikit/android/chatuikit_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
## UIKit 基本项目结构
1010

1111
```
12-
└── easeui
12+
└── uikit
1313
├── ChatUIKitClient // UIKit SDK 入口
1414
├── ChatUIKitConfig // UIKit SDK 配置类
1515
├── feature // UIKit 功能模块

0 commit comments

Comments
 (0)