Merge pull request #74 from AgoraIO-Community/api-ref-finishing

API References Update 1.8.4
AgoraIO-Community · Jun 23, 2022 · 1e31b8c · 1e31b8c
2 parents ad127b6 + 00cd617
commit 1e31b8c
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 6 deletions.
diff --git a/AgoraRtmControl_iOS.podspec b/AgoraRtmControl_iOS.podspec
@@ -9,7 +9,7 @@
 Pod::Spec.new do |s|
   s.name             = 'AgoraRtmControl_iOS'
   s.module_name      = 'AgoraRtmControl'
-  s.version          = ENV['LIB_VERSION'] || '1.8.3'
+  s.version          = ENV['LIB_VERSION'] || '1.8.4'
   s.summary          = 'Agora Real-time Messaging Wrapper.'
 
   s.description      = <<-DESC

diff --git a/AgoraRtmControl_macOS.podspec b/AgoraRtmControl_macOS.podspec
@@ -9,7 +9,7 @@
 Pod::Spec.new do |s|
   s.name             = 'AgoraRtmControl_macOS'
   s.module_name      = 'AgoraRtmControl'
-  s.version          = ENV['LIB_VERSION'] || '1.8.3'
+  s.version          = ENV['LIB_VERSION'] || '1.8.4'
   s.summary          = 'Agora Real-time Messaging Wrapper.'
 
   s.description      = <<-DESC

diff --git a/AgoraUIKit_iOS.podspec b/AgoraUIKit_iOS.podspec
@@ -9,7 +9,7 @@
 Pod::Spec.new do |s|
   s.name             = 'AgoraUIKit_iOS'
   s.module_name      = 'AgoraUIKit'
-  s.version          = ENV['LIB_VERSION'] || '1.8.3'
+  s.version          = ENV['LIB_VERSION'] || '1.8.4'
   s.summary          = 'Agora video session UIKit template.'
 
   s.description      = <<-DESC

diff --git a/AgoraUIKit_macOS.podspec b/AgoraUIKit_macOS.podspec
@@ -9,7 +9,7 @@
 Pod::Spec.new do |s|
   s.name             = 'AgoraUIKit_macOS'
   s.module_name      = 'AgoraUIKit'
-  s.version          = ENV['LIB_VERSION'] || '1.8.3'
+  s.version          = ENV['LIB_VERSION'] || '1.8.4'
   s.summary          = 'Agora video session AppKit template.'
 
   s.description      = <<-DESC

diff --git a/Sources/Agora-UIKit/AgoraCollectionViewer.swift b/Sources/Agora-UIKit/AgoraCollectionViewer.swift
@@ -15,7 +15,7 @@ import AppKit
 public class AgoraCollectionViewer: MPCollectionView {
 
     static let cellSpacing: CGFloat = 5
-    static var flowLayout: MPCollectionViewFlowLayout {
+    public static var flowLayout: MPCollectionViewFlowLayout {
         let flowLayout = MPCollectionViewFlowLayout()
         flowLayout.itemSize = CGSize(width: 100, height: 100)
         flowLayout.scrollDirection = .horizontal

diff --git a/Sources/Agora-UIKit/AgoraUIKit+AgoraRtmController+Extensions.swift b/Sources/Agora-UIKit/AgoraUIKit+AgoraRtmController+Extensions.swift
@@ -72,7 +72,9 @@ extension AgoraVideoViewer {
         get { self.connectionData }
         set { self.connectionData = newValue }
     }
+    /// AgoraRtcEngineKit being used by this AgoraVideoViewer.
     public var rtcEngine: AgoraRtcEngineKit { self.agkit }
+    /// Property used to access all the RTC connections to other broadcasters in an RTC channel.
     public var videoLookup: [UInt: AgoraSingleVideoView] { self.userVideoLookup }
 
 }
@@ -165,6 +167,9 @@ extension AgoraVideoViewer: RtmControllerDelegate {
     public func channel(_ channel: AgoraRtmChannel, memberJoined member: AgoraRtmMember) {
         self.sendPersonalData(to: member.userId)
     }
+
+    /// The local user's ``UserData`` object.
+    /// - Returns: ``UserData`` object of the local user.
     public func personalData() -> some Codable {
         let safeRtcId = AgoraUIKit.uintToInt(self.rtcId ?? 0)
         return UserData(

diff --git a/Sources/Agora-UIKit/AgoraUIKit.swift b/Sources/Agora-UIKit/AgoraUIKit.swift
@@ -22,7 +22,7 @@ public struct AgoraUIKit: Codable {
     /// Framework type of UIKit. "native", "flutter", "reactnative"
     fileprivate(set) var framework: String
     /// Version of UIKit being used
-    static let version = "1.8.3"
+    static let version = "1.8.4"
     /// Framework type of UIKit. "native", "flutter", "reactnative"
     static let framework = "native"
     #if os(iOS)

diff --git a/Sources/Agora-UIKit/AgoraVideoViewer+VideoControl.swift b/Sources/Agora-UIKit/AgoraVideoViewer+VideoControl.swift
@@ -323,6 +323,8 @@ extension AgoraVideoViewer {
         }
     }
 
+    /// Initialise RTM within Agora UIKit.
+    /// - Parameter callback: Return the rtm controller as a callback parameter.
     open func setupRtmController(callback: ((AgoraRtmController?) -> Void)? = nil) {
         if !self.agoraSettings.rtmEnabled { return }
         if self.rtmController == nil {