Dev/0.5.2 (#117)

* [Android]change delegate to observer. * [Android]Update README. * [Android]Update README. * [Android]Update appid config and etc. * [Android]Update README. * refactor: refactor appid * fix: update version * perf: optional func of AUIRoomManagerRespDelegate * docs: update change logs * docs: update change log --------- Co-authored-by: wushengtao <tamworth@163.com>
AgoraIO-Community · Oct 18, 2023 · 394ed48 · 394ed48
1 parent b72c0ef
commit 394ed48
Show file tree

Hide file tree

Showing 41 changed files with 412 additions and 376 deletions.
diff --git a/AUIKitCore.podspec b/AUIKitCore.podspec
@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'AUIKitCore'
-  s.version          = '0.5.1'
+  s.version          = '0.5.2'
   s.summary          = 'A short description of AUIKit.'
 
   # This description is used to generate tags and improve search results.

diff --git a/Android/README.md b/Android/README.md
@@ -6,25 +6,25 @@ AUIKit is a set of scaffolding for scenario-based applications. It provides UI c
 
 ## Features
 - [AUIKit](auikit)
-  - [Service](auikit/src/main/java/io/agora/auikit/service)**([Document](doc/AUIKit-Service.md))**
-    - [AUIRoomManager](auikit/src/main/java/io/agora/auikit/service/IAUIRoomManager.java)
-    - [AUIUserService](auikit/src/main/java/io/agora/auikit/service/IAUIUserService.java)
-    - [AUIMicSeatService](auikit/src/main/java/io/agora/auikit/service/IAUIMicSeatService.java)
-    - [AUIMusicPlayerService](auikit/src/main/java/io/agora/auikit/service/IAUIMusicPlayerService.java)
-    - [AUIChorusService](auikit/src/main/java/io/agora/auikit/service/IAUIChorusService.java)
-    - [AUIJukeboxService](auikit/src/main/java/io/agora/auikit/service/IAUIJukeboxService.java)
-  - [UI](auikit/src/main/java/io/agora/auikit/ui)**([Document](doc/AUIKit-UI.md))**
-    - [Feature UI Widgets](auikit/src/main/java/io/agora/auikit/ui)
-      - [AUIMicSeatsView](auikit/src/main/java/io/agora/auikit/ui/micseats/IMicSeatsView.java)
-      - [AUIJukeboxView](auikit/src/main/java/io/agora/auikit/ui/jukebox/IAUIJukeboxView.java)
-      - [AUIMusicPlayerView](auikit/src/main/java/io/agora/auikit/ui/musicplayer/IMusicPlayerView.java)
-      - [AUIMemberView](auikit/src/main/java/io/agora/auikit/ui/member/IMemberListView.java)
-    - [Basic UI Widgets](auikit/src/main/java/io/agora/auikit/ui/basic)
-      - [AUIButton](auikit/src/main/java/io/agora/auikit/ui/basic/AUIButton.java)
-      - [AUIBottomDialog](auikit/src/main/java/io/agora/auikit/ui/basic/AUIBottomDialog.java)
-      - [AUIAlertDialog](auikit/src/main/java/io/agora/auikit/ui/basic/AUIAlertDialog.java)
-      - [AUITabLayout](auikit/src/main/java/io/agora/auikit/ui/basic/AUITabLayout.java)
-      - [AUIEditText](auikit/src/main/java/io/agora/auikit/ui/basic/AUIEditText.java)
+  - [Service](auikit-service/src/main/java/io/agora/auikit/service)**([Document](doc/AUIKit-Service.md))**
+    - [AUIRoomManager](auikit-service/src/main/java/io/agora/auikit/service/IAUIRoomManager.java)
+    - [AUIUserService](auikit-service/src/main/java/io/agora/auikit/service/IAUIUserService.java)
+    - [AUIMicSeatService](auikit-service/src/main/java/io/agora/auikit/service/IAUIMicSeatService.java)
+    - [AUIMusicPlayerService](auikit-service/src/main/java/io/agora/auikit/service/IAUIMusicPlayerService.java)
+    - [AUIChorusService](auikit-service/src/main/java/io/agora/auikit/service/IAUIChorusService.java)
+    - [AUIJukeboxService](auikit-service/src/main/java/io/agora/auikit/service/IAUIJukeboxService.java)
+  - [UI](auikit-ui/src/main/java/io/agora/auikit/ui)**([Document](doc/AUIKit-UI.md))**
+    - [Feature UI Widgets](auikit-ui/src/main/java/io/agora/auikit/ui)
+      - [AUIMicSeatsView](auikit-ui/src/main/java/io/agora/auikit/ui/micseats/IMicSeatsView.java)
+      - [AUIJukeboxView](auikit-ui/src/main/java/io/agora/auikit/ui/jukebox/IAUIJukeboxView.java)
+      - [AUIMusicPlayerView](auikit-ui/src/main/java/io/agora/auikit/ui/musicplayer/IMusicPlayerView.java)
+      - [AUIMemberView](auikit-ui/src/main/java/io/agora/auikit/ui/member/IMemberListView.java)
+    - [Basic UI Widgets](auikit-ui/src/main/java/io/agora/auikit/ui/basic)
+      - [AUIButton](auikit-ui/src/main/java/io/agora/auikit/ui/basic/AUIButton.java)
+      - [AUIBottomDialog](auikit-ui/src/main/java/io/agora/auikit/ui/basic/AUIBottomDialog.java)
+      - [AUIAlertDialog](auikit-ui/src/main/java/io/agora/auikit/ui/basic/AUIAlertDialog.java)
+      - [AUITabLayout](auikit-ui/src/main/java/io/agora/auikit/ui/basic/AUITabLayout.java)
+      - [AUIEditText](auikit-ui/src/main/java/io/agora/auikit/ui/basic/AUIEditText.java)
       - ...
 
 ## Quick Start

diff --git a/Android/README.zh.md b/Android/README.zh.md
@@ -6,13 +6,13 @@ AUIKit是一套场景化应用的脚手架，提供Ui组件以及Service组件
 
 ## 特性
 - [AUIKit](auikit)
-    - [Service](auikit-ui/src/main/java/io/agora/auikit/service)**([使用指南](doc/AUIKit-Service.md))**
-        - [AUIRoomManager](auikit-ui/src/main/java/io/agora/auikit/service/IAUIRoomManager.java)
-        - [AUIUserService](auikit-ui/src/main/java/io/agora/auikit/service/IAUIUserService.java)
-        - [AUIMicSeatService](auikit-ui/src/main/java/io/agora/auikit/service/IAUIMicSeatService.java)
-        - [AUIMusicPlayerService](auikit-ui/src/main/java/io/agora/auikit/service/IAUIMusicPlayerService.java)
-        - [AUIChorusService](auikit-ui/src/main/java/io/agora/auikit/service/IAUIChorusService.java)
-        - [AUIJukeboxService](auikit-ui/src/main/java/io/agora/auikit/service/IAUIJukeboxService.java)
+    - [Service](auikit-service/src/main/java/io/agora/auikit/service)**([使用指南](doc/AUIKit-Service.md))**
+        - [AUIRoomManager](auikit-service/src/main/java/io/agora/auikit/service/IAUIRoomManager.java)
+        - [AUIUserService](auikit-service/src/main/java/io/agora/auikit/service/IAUIUserService.java)
+        - [AUIMicSeatService](auikit-service/src/main/java/io/agora/auikit/service/IAUIMicSeatService.java)
+        - [AUIMusicPlayerService](auikit-service/src/main/java/io/agora/auikit/service/IAUIMusicPlayerService.java)
+        - [AUIChorusService](auikit-service/src/main/java/io/agora/auikit/service/IAUIChorusService.java)
+        - [AUIJukeboxService](auikit-service/src/main/java/io/agora/auikit/service/IAUIJukeboxService.java)
     - [UI](auikit-ui/src/main/java/io/agora/auikit/ui)**([使用指南](doc/AUIKit-UI.md))**
         - [Feature UI Widgets](auikit-ui/src/main/java/io/agora/auikit/ui)
             - [AUIMicSeatsView](auikit-ui/src/main/java/io/agora/auikit/ui/micseats/IMicSeatsView.java)

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/model/AUICommonConfig.java b/Android/auikit-service/src/main/java/io/agora/auikit/model/AUICommonConfig.java
@@ -6,7 +6,7 @@
 
 public class AUICommonConfig {
     public @NonNull Context context;
-    public @NonNull String appId = "";
+    public @NonNull String host = "";
     public @NonNull String userId = "";
     public @NonNull String userName = "";
     public @NonNull String userAvatar = "";  //用户头像

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/model/AUIRoomContext.java b/Android/auikit-service/src/main/java/io/agora/auikit/model/AUIRoomContext.java
@@ -8,17 +8,22 @@
 import java.util.Map;
 
 public class AUIRoomContext {
-    private static AUIRoomContext instance = null;
+    private static volatile AUIRoomContext instance = null;
     private AUIRoomContext() {
         // 私有构造函数
     }
-    public static synchronized AUIRoomContext shared() {
+    public static AUIRoomContext shared() {
         if (instance == null) {
-            instance = new AUIRoomContext();
+            synchronized (AUIRoomContext.class){
+                if(instance == null){
+                    instance = new AUIRoomContext();
+                }
+            }
         }
         return instance;
     }
 
+    public String appId = "";
     public Map<String, AUIRoomConfig> roomConfigMap = new HashMap<>();
 
     public @NonNull AUIUserThumbnailInfo currentUserInfo = new AUIUserThumbnailInfo();

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIChorusService.java b/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIChorusService.java
@@ -7,7 +7,7 @@
 import io.agora.auikit.service.callback.AUIChoristerListCallback;
 import io.agora.auikit.service.callback.AUISwitchSingerRoleCallback;
 
-public interface IAUIChorusService extends IAUICommonService<IAUIChorusService.AUIChorusRespDelegate> {
+public interface IAUIChorusService extends IAUICommonService<IAUIChorusService.AUIChorusRespObserver> {
 
 
     // 获取合唱者列表
@@ -22,7 +22,7 @@ public interface IAUIChorusService extends IAUICommonService<IAUIChorusService.A
     // 切换角色
     void switchSingerRole(int newRole, @Nullable AUISwitchSingerRoleCallback callback);
 
-    interface AUIChorusRespDelegate {
+    interface AUIChorusRespObserver {
         /// 合唱者加入
         /// - Parameter chorus: <#chorus description#>
         void onChoristerDidEnter(AUIChoristerModel chorister);

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUICommonService.java b/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUICommonService.java
@@ -5,21 +5,21 @@
 
 import io.agora.auikit.model.AUIRoomContext;
 
-public interface IAUICommonService<Delegate> {
+public interface IAUICommonService<Observer> {
 
     /**
      * 绑定响应事件回调，可绑定多个
      *
-     * @param delegate 响应事件回调
+     * @param observer 响应事件回调
      */
-    void bindRespDelegate(@Nullable Delegate delegate);
+    void registerRespObserver(@Nullable Observer observer);
 
     /**
      * 解绑响应事件回调
      *
-     * @param delegate 响应事件回调
+     * @param observer 响应事件回调
      */
-    void unbindRespDelegate(@Nullable Delegate delegate);
+    void unRegisterRespObserver(@Nullable Observer observer);
 
     /** 获取当前房间上下文
      *

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIGiftsService.kt b/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIGiftsService.kt
@@ -4,7 +4,7 @@ import io.agora.auikit.model.AUIGiftEntity
 import io.agora.auikit.service.callback.AUICallback
 import io.agora.auikit.service.callback.AUIGiftListCallback
 
-interface IAUIGiftsService : IAUICommonService<IAUIGiftsService.AUIGiftRespDelegate> {
+interface IAUIGiftsService : IAUICommonService<IAUIGiftsService.AUIGiftRespObserver> {
 
     /**
      * - roomId: 房间id
@@ -19,7 +19,7 @@ interface IAUIGiftsService : IAUICommonService<IAUIGiftsService.AUIGiftRespDeleg
      */
     fun sendGift(gift: AUIGiftEntity, callback: AUICallback)
 
-    interface AUIGiftRespDelegate{
+    interface AUIGiftRespObserver{
         fun onReceiveGiftMsg(giftEntity: AUIGiftEntity?){}
     }
 }
diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIIMManagerService.kt b/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIIMManagerService.kt
@@ -3,7 +3,7 @@ package io.agora.auikit.service
 import io.agora.auikit.model.AUIUserThumbnailInfo
 import io.agora.auikit.service.callback.AUIException
 
-interface IAUIIMManagerService: IAUICommonService<IAUIIMManagerService.AUIIMManagerRespDelegate>{
+interface IAUIIMManagerService: IAUICommonService<IAUIIMManagerService.AUIIMManagerRespObserver>{
 
 
     /**
@@ -30,7 +30,7 @@ interface IAUIIMManagerService: IAUICommonService<IAUIIMManagerService.AUIIMMana
         val user: AUIUserThumbnailInfo?
     )
 
-    interface AUIIMManagerRespDelegate{
+    interface AUIIMManagerRespObserver{
 
         /**
          * 接收到消息

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIInvitationService.java b/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIInvitationService.java
@@ -8,7 +8,7 @@
 import io.agora.auikit.model.AUIUserInfo;
 import io.agora.auikit.service.callback.AUICallback;
 
-public interface IAUIInvitationService extends IAUICommonService<IAUIInvitationService.AUIInvitationRespDelegate> {
+public interface IAUIInvitationService extends IAUICommonService<IAUIInvitationService.AUIInvitationRespObserver> {
     /**
      * 向用户发送邀请
      * @param userId 邀请用户id
@@ -66,7 +66,7 @@ public interface IAUIInvitationService extends IAUICommonService<IAUIInvitationS
      */
     void rejectApply(@NonNull String userId,@NonNull AUICallback callback);
 
-    interface AUIInvitationRespDelegate {
+    interface AUIInvitationRespObserver {
 
         /**
          * 收到新的邀请请求

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIJukeboxService.java b/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIJukeboxService.java
@@ -16,7 +16,7 @@
 /**
  * 点歌器Service抽象协议
  */
-public interface IAUIJukeboxService extends IAUICommonService<IAUIJukeboxService.AUIJukeboxRespDelegate> {
+public interface IAUIJukeboxService extends IAUICommonService<IAUIJukeboxService.AUIJukeboxRespObserver> {
 
     // 0 -> "项目热歌榜单"
     // 1 -> "声网热歌榜"
@@ -88,7 +88,7 @@ public interface IAUIJukeboxService extends IAUICommonService<IAUIJukeboxService
      */
     void updatePlayStatus(@NonNull String songCode, @AUIPlayStatus int playStatus, @Nullable AUICallback completion);
 
-    interface AUIJukeboxRespDelegate {
+    interface AUIJukeboxRespObserver {
 
         /**
          * 新增一首歌曲回调

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIMicSeatService.java b/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIMicSeatService.java
@@ -12,7 +12,7 @@
 /**
  * 麦位Service抽象协议，一个房间对应一个MicSeatService
  */
-public interface IAUIMicSeatService extends IAUICommonService<IAUIMicSeatService.AUIMicSeatRespDelegate> {
+public interface IAUIMicSeatService extends IAUICommonService<IAUIMicSeatService.AUIMicSeatRespObserver> {
 
     /**
      * 主动上麦（听众端和房主均可调用）
@@ -96,7 +96,7 @@ public interface IAUIMicSeatService extends IAUICommonService<IAUIMicSeatService
      */
     void onClickInvited(int index);
 
-    interface AUIMicSeatRespDelegate {
+    interface AUIMicSeatRespObserver {
 
         /**
          * 全量的麦位列表变化

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIMusicPlayerService.java b/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIMusicPlayerService.java
@@ -5,7 +5,7 @@
 import io.agora.auikit.model.AUILoadMusicConfiguration;
 import io.agora.auikit.service.callback.AUIMusicLoadStateCallback;
 
-public interface IAUIMusicPlayerService extends IAUICommonService<IAUIMusicPlayerService.AUIPlayerRespDelegate> {
+public interface IAUIMusicPlayerService extends IAUICommonService<IAUIMusicPlayerService.AUIPlayerRespObserver> {
     /**
      * 异步加载歌曲，同时只能为一首歌loadSong，loadSong结果会通过回调通知业务层
      * @param songCode 歌曲唯一编码
@@ -109,7 +109,7 @@ public interface IAUIMusicPlayerService extends IAUICommonService<IAUIMusicPlaye
     /**
      * musicPlayer 模块事件
      */
-    interface AUIPlayerRespDelegate {
+    interface AUIPlayerRespObserver {
         /**
          * 前奏开始加载
          */

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIRoomManager.java b/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIRoomManager.java
@@ -12,7 +12,7 @@
 /**
  * 房间Service抽象协议
  */
-public interface IAUIRoomManager extends IAUICommonService<IAUIRoomManager.AUIRoomManagerRespDelegate> {
+public interface IAUIRoomManager extends IAUICommonService<IAUIRoomManager.AUIRoomManagerRespObserver> {
     /**
      * 创建房间（房主调用），若房间不存在，系统将自动创建一个新房间
      *
@@ -70,7 +70,7 @@ public interface IAUIRoomManager extends IAUICommonService<IAUIRoomManager.AUIRo
      */
     void kickUser(String roomId,int userId,AUICallback callback);
 
-    interface AUIRoomManagerRespDelegate {
+    interface AUIRoomManagerRespObserver {
 
         /**
          * 房间被销毁的回调

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIUserService.java b/Android/auikit-service/src/main/java/io/agora/auikit/service/IAUIUserService.java
@@ -12,7 +12,7 @@
 /**
  * 房间Service抽象协议
  */
-public interface IAUIUserService extends IAUICommonService<IAUIUserService.AUIUserRespDelegate> {
+public interface IAUIUserService extends IAUICommonService<IAUIUserService.AUIUserRespObserver> {
 
     /**
      * 获取指定 userId 的用户信息，如果为 null，则获取房间内所有人的信息
@@ -45,7 +45,7 @@ public interface IAUIUserService extends IAUICommonService<IAUIUserService.AUIUs
      */
     void muteUserVideo(boolean isMute, @Nullable AUICallback callback);
 
-    interface AUIUserRespDelegate {
+    interface AUIUserRespObserver {
         /**
          * 用户进入房间后获取到的所有用户信息
          *

diff --git a/...it/service/im/AUIChatSubscribeDelegate.kt → .../auikit/service/im/AUIChatEventHandler.kt b/...it/service/im/AUIChatSubscribeDelegate.kt → .../auikit/service/im/AUIChatEventHandler.kt
@@ -2,7 +2,7 @@ package io.agora.auikit.service.im
 
 import io.agora.auikit.model.AgoraChatMessage
 
-interface AUIChatSubscribeDelegate {
+interface AUIChatEventHandler {
 
     /**
      * 接收到普通消息

diff --git a/Android/auikit-service/src/main/java/io/agora/auikit/service/im/AUIChatManager.kt b/Android/auikit-service/src/main/java/io/agora/auikit/service/im/AUIChatManager.kt
@@ -38,7 +38,7 @@ class AUIChatManager(
     channelName: String,
     roomContext:AUIRoomContext,
 ): MessageListener, ChatRoomChangeListener {
-    private val chatSubscribeDelegates = mutableListOf<AUIChatSubscribeDelegate>()
+    private val chatEvnetHandlers = mutableListOf<AUIChatEventHandler>()
     private var chatRoomId:String? = ""
     private var channelId:String? = ""
     private var appKey:String? =""
@@ -57,12 +57,12 @@ class AUIChatManager(
         this.roomContext = roomContext
     }
 
-    fun subscribeChatMsg(delegate: AUIChatSubscribeDelegate) {
-        chatSubscribeDelegates.add(delegate)
+    fun subscribeChatMsg(delegate: AUIChatEventHandler) {
+        chatEvnetHandlers.add(delegate)
     }
 
-    fun unsubscribeChatMsg(delegate: AUIChatSubscribeDelegate?) {
-        chatSubscribeDelegates.remove(delegate)
+    fun unsubscribeChatMsg(delegate: AUIChatEventHandler?) {
+        chatEvnetHandlers.remove(delegate)
     }
 
     fun initManager() {
@@ -218,7 +218,7 @@ class AUIChatManager(
             if (it.type == ChatMessage.Type.TXT) {
                 parseMsgChatEntity(it)
                 try {
-                    for (listener in chatSubscribeDelegates) {
+                    for (listener in chatEvnetHandlers) {
                         listener.onReceiveTextMsg(channelId,parseChatMessage(it))
                     }
                 } catch (e: Exception) {
@@ -240,7 +240,7 @@ class AUIChatManager(
                             AUICustomMsgType.AUIChatRoomJoinedMember -> {
                                 parseMsgChatEntity(it)
                                 try {
-                                    for (listener in chatSubscribeDelegates) {
+                                    for (listener in chatEvnetHandlers) {
                                         listener.onReceiveMemberJoinedMsg(channelId,parseChatMessage(it))
                                     }
                                 } catch (e: Exception) {
@@ -465,7 +465,7 @@ class AUIChatManager(
         participant: String?
     ) {
         try {
-            for (listener in chatSubscribeDelegates) {
+            for (listener in chatEvnetHandlers) {
                 listener.onUserBeKicked(chatRoomId,getKickReason(reason))
             }
         } catch (e: Exception) {
@@ -475,7 +475,7 @@ class AUIChatManager(
 
     override fun onChatRoomDestroyed(chatRoomId: String?, roomName: String?) {
         try {
-            for (listener in chatSubscribeDelegates) {
+            for (listener in chatEvnetHandlers) {
                 listener.onRoomDestroyed(chatRoomId)
             }
         } catch (e: Exception) {