升级指南

从 1.1.5 升级至 2.0.0

在 2.0.0 版中，声网优化了 Classroom SDK 的内部架构，重新设计了 Agora Edu Context API。

本节列出 2.0.0 与 1.1.5 在 Edu Context API 上的主要变动。

信息

如需了解 Agora Edu Context API 2.0.0 的具体信息，查看 API 文档。

Chat context

移除 AgoraEduMessageContext 和 AgoraEduMessageHandler，由 AgoraWidgets 库中的 AgoraRtmIMWidget 代替。

Whiteboard context

移除 AgoraEduWhiteBoardContext、AgoraEduWhiteBoardHandler、AgoraEduWhiteBoardToolContext、 AgoraEduWhiteBoardPageControlContext、AgoraEduWhiteBoardPageControlHandler， 由 AgoraWidgets 库中的 AgoraWhiteBoardWidget 代替。

Device context

移除 AgoraEduDeviceContext 和 AgoraEduDeviceHandler，该类提供的方法和回调由 AgoraEduMediaContext 和 AgoraEduMediaHandler 代替，具体如下：

• setCameraDeviceEnable、setMicDeviceEnable、setSpeakerDeviceEnable 由 AgoraEduMediaContext 中的 openLocalDevice 和 closeLocalDevice 代替。
• switchCameraFacing 由 AgoraEduMediaContext 中的openLocalDevice 代替。
• onCameraDeviceEnableChanged、onCameraDeviceFacingChanged、onMicDeviceEnableChanged、onSpeakerDeviceEnableChanged 由 AgoraEduMediaHandler 中的 onLocalDeviceStateUpdated 代替。

Hands-up context

移除 AgoraEduHandsUpContext 和 AgoraEduHandsUpHandler，该类提供的方法和回调由 AgoraEduUserContext 和 AgoraEduUserHandler 代替，具体如下：

• updateHandsUpState 由 AgoraEduUserContext 中的 handsWave 和 handsDown 代替。
• onHandsUpState 由 AgoraEduUserHandler 中的 onUserHandsWave 和 onUserHandsDown 代替。
• onHandsUpEnable 由 AgoraEduUserHandler 中的 onUserHandsWaveEnable 代替。

Media context

• openCamera 更名为 openLocalDevice。
• closeCamera 更名为 closeLocalDevice。
• startPreview 更名为 startRenderVideo。
• stopPreview 更名为 stopRenderVideo。
• openMicrophone 更名为 openLocalDevice。
• closeMicrophone 更名为 closeLocalDevice。
• renderRemoteView 更名为 startRenderVideo。
• 移除 publishStream。
• 移除 unpublishStream。

Room context

• joinClassroom 更名为 joinRoom。
• updateFlexRoomProperties 更名为 updateRoomProperties。
• 移除 uploadLog 和 onUploadLogSuccess，由 AgoraEduMonitorContext 中的 uploadLog 代替。
• registerEventHandler 更名为 registerRoomEventHandler。
• 移除 onShowErrorInfo。
• onClassroomJoined 更名为 onRoomJoinedSuccess。
• onFlexRoomPropertiesInitialize 更名为 RoomContext.getRoomProperties。
• 移除 onFlexRoomPropertiesChanged，由 onRoomPropertiesUpdated 和 onRoomPropertiesDeleted 代替。
• 移除 onClassroomName，由 AgoraEduRoomContext 中的getRoomInfo 代替。
• 移除 onClassroomState，由 onClassStateUpdated 和 onRoomClosed 代替。
• onClassTimeInfo 由 AgoraEduRoomContext 中的 getRoomInfo 代替。
• onNetworkQuality 由 AgoraEduMonitorHandler 中的 onLocalNetworkQualityUpdated 代替。
• onConnectionState 由 AgoraEduMonitorHandler 中的 onLocalConnectionUpdated 代替。

Screen-sharing context

• 移除 AgoraEduScreenShareContext 和AgoraEduScreenShareHandler，由 AgoraEduStreamContext 代替。当 AgoraEduContextStreamInfo 里有 videoSourceType 为 screen 时，可以判断为屏幕共享视频流。
• 移除 AgoraEduScreenShareHandler。 AgoraEduStreamContext 代替。onUpdateScreenShareState 由 AgoraEduStreamHandler 中的onStreamJoined、onStreamLeft、onStreamUpdate 代替。

User context

• updateFlexUserProperties 更名为 updateUserProperties
• registerEventHandler 更名为 registerUserEventHandler
• 移除 onUpdateUserList，由 onRemoteUserJoined、 onRemoteUserLeft、onUserUpdated 代替。
• 移除 onUpdateCoHostList，由 onCoHostUserListAdded、 onCoHostUserListRemoved 代替。
• onKickOut 更名为 onLocalUserKickOut。
• 移除 onUpdateAudioVolumeIndication， 由 AgoraEduMediaHandler 中的 onVolumeUpdated 代替。
• onShowUserReward 更名为 onUserRewarded。
• 移除 onFlexUserPropertiesChanged，由 onUserPropertiesUpdated、onUserPropertiesDeleted 代替。
• 移除 onStreamUpdated，由 AgoraEduStreamHandler 中的 onStreamUpdated 代替。

从 1.1.5 之前版本升级至 1.1.5

如果你在 1.1.5 之前版本中修改了灵动课堂的默认 UI，需参考以下步骤从 1.1.5 之前的版本升级至 1.1.5：

步骤一：重新集成灵动课堂

根据集成灵动课堂文档中的步骤将 1.1.5 集成至你的项目中。

步骤二：替换 SDKs/AgoraEduUI 目录下的文件

用原先 AgoraEduSDK/Modules/AgoraUIEduAppViews/AgoraUIEduAppView 目录下的文件替换 SDKs/AgoraEduUI 目录下的文件，具体如下：

• 用 AgoraEduSDK/Modules/AgoraUIEduAppViews/AgoraUIEduAppViews/AgoraResources 替换 SDKs/AgoraEduUI/AgoraEduUI/AgoraResources。
• 用 AgoraEduSDK/Modules/AgoraUIEduAppViews/AgoraUIEduAppViews/Render 替换 SDKs/AgoraEduUI/AgoraEduUI/Render。
• 用 AgoraEduSDK/Modules/AgoraUIEduAppViews/AgoraUIEduAppViews/UIController 替换 SDKs/AgoraEduUI/AgoraEduUI/UIController。
• 用 AgoraEduSDK/Modules/AgoraUIEduAppViews/AgoraUIEduAppViews/WhiteBoard 替换 SDKs/AgoraEduUI/AgoraEduUI/WhiteBoard。
• 用 AgoraEduSDK/Modules/AgoraUIEduAppViews/AgoraUIEduAppViews/AgoraUIEduAppViews.xcassets 替换 SDKs/AgoraEduUI/AgoraEduUI/AgoraEduUI.xcassets。
• 用 AgoraEduSDK/Modules/AgoraUIEduAppViews/AgoraUIEduAppViews/UIManager 替换 SDKs/AgoraEduUI/AgoraEduUI/UIManager，并将 AgoraUIManager.swift 改名为 AgoraEduUI.swift，将AgoraUIManager 类改名为 AgoraEduUI。
• 用 AgoraEduSDK/Modules/AgoraUIEduAppViews/AgoraUIEduAppViews/Widget 替换 Widgets/AgoraWidgets/Chat。

1.1.5 之前版本的目录结构如下：

1.1.5 的目录结构如下：

步骤三：修改 AgoraEduUI.swift 文件

在 AgoraEduUI.swift 中，进行以下修改：

1. 将 AgoraEduContextAppType 更名为 AgoraEduContextRoomType。

2. 将 var chat: AgoraEduWidget 改为 var chat: AgoraBaseWidget。

3. 参考下图，添加以下代码新增 initWidgets 方法。

   
   Swift

   func initWidgets() {
           guard let widgetInfos = contextPool.widget.getWidgetInfos() else {
               return
           }
   
           for info in widgetInfos {
               switch info.widgetId {
               case "AgoraChatWidget":
                   info.properties = ["contextPool": contextPool]
                   let chat = contextPool.widget.create(with: info)
                   chat.addMessageObserver(self)
   
                   let hasConversation = (viewType == .oneToOne ? 0 : 1)
                   if let message = ["hasConversation": hasConversation].jsonString() {
                       chat.widgetDidReceiveMessage(message)
                   }
   
                   self.chat = chat
               default:
                   break
               }
           }
   }

步骤四：替换 SDKs/Modules/AgraUIEduBaseViews 目录下的文件

用原先 AgoraEduSDK/Modules/AgraUIEduBaseViews 目录下的文件替换 SDKs/Modules/AgraUIEduBaseViews 目录下的文件，具体如下：

• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraResources 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraResources。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraAlertView 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraAlertView。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraAnimatedImage 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraAnimatedImage。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraHandsUpView 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraHandsUpView。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraRefresh 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraRefresh。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraToastView 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraToastView。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraUIEduBaseViews.xcassets 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraUIEduBaseViews.xcassets。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraUINavigationBar 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraUINavigationBar。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraUIUserView 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraUIUserView。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraUserListView 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraUserListView。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraUserRenderListView 替换 SDKs/Modules/AgraUIEduBaseViews/AgoraUserRenderListView。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/Utils 替换 SDKs/Modules/AgraUIEduBaseViews/Utils。
• 用 AgoraEduSDK/Modules/AgraUIEduBaseViews/AgoraUIChatView 替换 Widgets/AgoraWidgets/Chat。

1.1.5 之前版本的目录结构如下：

1.1.5 版本的目录结构如下：

步骤五：修改 AgoraChatWidget.swift 文件

在 AgoraChatWidget.swift 文件中进行以下操作：

1. 将初始化方法更改为下面的新的初始化方法：

   Swift

   public required init(widgetId: String,
                        contextPool: AgoraEduContextPool,
                        properties: [AnyHashable : Any]?) {
       super.init(widgetId: widgetId,
                  contextPool: contextPool,
                  properties: properties)
       initViews()
       initLayout()
       initData()
   }

2. 增加 AgoraEduMessageContext 属性：

   Swift

   private weak var context: AgoraEduMessageContext?
   
   public required override init(widgetId: String,
                                 properties: [AnyHashable: Any]?) {
       super.init(widgetId: widgetId,
                  properties: properties)
   
       initViews()
       initLayout()
   
       if let contextPool = properties?["contextPool"] as? AgoraEduContextPool {
           context = contextPool.chat
           initData()
       }
   }