PubNub Swift Chat SDK 0.20.0 release

.github/workflows/run-tests.yml

@@ -32,7 +32,7 @@ jobs:
     strategy:
       matrix:
         environment: [iOS]
-    timeout-minutes: 18
+    timeout-minutes: 21
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4

.swiftlint.yml

@@ -8,6 +8,8 @@ disabled_rules:
   - function_parameter_count
 included:
   - Sources/
+excluded:
+  - Tests/
 opt_in_rules:
   - force_unwrapping
   - overridden_super_call

PubNubSwiftChatSDK.xcodeproj/xcshareddata/xcschemes/PubNubSwiftChatSDK.xcscheme

@@ -30,7 +30,7 @@
       shouldUseLaunchSchemeArgsEnv = "YES">
       <TestPlans>
          <TestPlanReference
-            reference = "container:Tests/PubNubSwiftChatSDKTests.xctestplan"
+            reference = "container:Tests/PubNubSwiftChatSDKAsyncTests.xctestplan"
             default = "YES">
          </TestPlanReference>
       </TestPlans>

PubNubSwiftChatSDK.xcodeproj/xcshareddata/xcschemes/PubNubSwiftChatSDKAsyncTests.xcscheme

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1530"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES"
+      buildArchitectures = "Automatic">
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "3D46D4552D131EB2007D08DB"
+               BuildableName = "PubNubSwiftChatSDKAsyncTests.xctest"
+               BlueprintName = "PubNubSwiftChatSDKAsyncTests"
+               ReferencedContainer = "container:PubNubSwiftChatSDK.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/Channel.md

@@ -4,79 +4,112 @@
 
 ### Receiving Updates
 
+- ``streamUpdates()``
 - ``streamUpdates(callback:)``
+- ``streamUpdatesOn(channels:)``
 - ``streamUpdatesOn(channels:callback:)``
+- ``streamReadReceipts()``
 - ``streamReadReceipts(callback:)``
+- ``streamMessageReports()``
 - ``streamMessageReports(callback:)``
+- ``streamPresence()``
 - ``streamPresence(callback:)``
 
 ### Update and Delete a Channel
 
+- ``update(name:custom:description:status:type:)``
 - ``update(name:custom:description:status:type:completion:)``
+- ``delete(soft:)``
 - ``delete(soft:completion:)``
 
 ### Typing Indicator
 
+- ``startTyping()``
 - ``startTyping(completion:)``
+- ``stopTyping()``
 - ``stopTyping(completion:)``
+- ``getTyping()``
 - ``getTyping(callback:)``
 
 ### Presence Management
 
+- ``whoIsPresent()``
 - ``whoIsPresent(completion:)``
+- ``isPresent(userId:)``
 - ``isPresent(userId:completion:)``
+- ``join(custom:)``
 - ``join(custom:callback:completion:)``
+- ``leave()``
 - ``leave(completion:)``
+- ``streamPresence()``
 - ``streamPresence(callback:)``
 
 ### Memberships Management
 
+- ``invite(user:)``
 - ``invite(user:completion:)``
+- ``inviteMultiple(users:)``
 - ``inviteMultiple(users:completion:)``
+- ``getMembers(limit:page:filter:sort:)``
 - ``getMembers(limit:page:filter:sort:completion:)``
 
 ### Sending a text
 
 - ``InputFile``
-- ``sendText(text:meta:shouldStore:usePost:ttl:mentionedUsers:referencedChannels:textLinks:quotedMessage:files:completion:)``
+- ``sendText(text:meta:shouldStore:usePost:ttl:quotedMessage:files:usersToMention:)``
 - ``sendText(text:meta:shouldStore:usePost:ttl:quotedMessage:files:usersToMention:completion:)``
+- ``sendText(text:meta:shouldStore:usePost:ttl:mentionedUsers:referencedChannels:textLinks:quotedMessage:files:completion:)``
 
 ### Creating Message Draft
 
 - ``createMessageDraft(userSuggestionSource:isTypingIndicatorTriggered:userLimit:channelLimit:)``
 
 ### Messages Management
 
+- ``connect()``
 - ``connect(callback:)``
+- ``forward(message:)``
 - ``forward(message:completion:)``
+- ``getHistory(startTimetoken:endTimetoken:count:)``
 - ``getHistory(startTimetoken:endTimetoken:count:completion:)``
+- ``getMessage(timetoken:)``
 - ``getMessage(timetoken:completion:)``
 
 ### Pinning and Unpinning a Message
 
+- ``pinMessage(message:)``
 - ``pinMessage(message:completion:)``
+- ``unpinMessage()``
 - ``unpinMessage(completion:)``
+- ``getPinnedMessage()``
 - ``getPinnedMessage(completion:)``
 
 ### Push Management
 
+- ``registerForPush()``
 - ``registerForPush(completion:)``
+- ``unregisterFromPush()``
 - ``unregisterFromPush(completion:)``
 
 ### Delete a File
 
+- ``deleteFile(id:name:)``
 - ``deleteFile(id:name:completion:)``
 
 ### Getting Files
 
 - ``GetFileItem``
+- ``getFiles(limit:next:)``
 - ``getFiles(limit:next:completion:)``
 
 ### User Suggestions 
 
+- ``getUserSuggestions(text:limit:)``
 - ``getUserSuggestions(text:limit:completion:)``
 
 ### Message Reports
 
+- ``getMessageReportsHistory(startTimetoken:endTimetoken:count:)``
 - ``getMessageReportsHistory(startTimetoken:endTimetoken:count:completion:)``
+- ``streamMessageReports()``
 - ``streamMessageReports(callback:)``

PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/ChannelImpl.md

@@ -4,79 +4,112 @@
 
 ### Receiving Updates
 
+- ``streamUpdates()``
 - ``streamUpdates(callback:)``
+- ``streamUpdatesOn(channels:)``
 - ``streamUpdatesOn(channels:callback:)``
+- ``streamReadReceipts()``
 - ``streamReadReceipts(callback:)``
+- ``streamMessageReports()``
 - ``streamMessageReports(callback:)``
+- ``streamPresence()``
 - ``streamPresence(callback:)``
 
 ### Update and Delete a Channel
 
+- ``update(name:custom:description:status:type:)``
 - ``update(name:custom:description:status:type:completion:)``
+- ``delete(soft:)``
 - ``delete(soft:completion:)``
 
 ### Typing Indicator
 
+- ``startTyping()``
 - ``startTyping(completion:)``
+- ``stopTyping()``
 - ``stopTyping(completion:)``
+- ``getTyping()``
 - ``getTyping(callback:)``
 
 ### Presence Management
 
+- ``whoIsPresent()``
 - ``whoIsPresent(completion:)``
+- ``isPresent(userId:)``
 - ``isPresent(userId:completion:)``
+- ``join(custom:)``
 - ``join(custom:callback:completion:)``
+- ``leave()``
 - ``leave(completion:)``
+- ``streamPresence()``
 - ``streamPresence(callback:)``
 
 ### Memberships Management
 
+- ``invite(user:)``
 - ``invite(user:completion:)``
+- ``inviteMultiple(users:)``
 - ``inviteMultiple(users:completion:)``
+- ``getMembers(limit:page:filter:sort:)``
 - ``getMembers(limit:page:filter:sort:completion:)``
 
 ### Sending a text
 
 - ``InputFile``
-- ``sendText(text:meta:shouldStore:usePost:ttl:mentionedUsers:referencedChannels:textLinks:quotedMessage:files:completion:)``
+- ``sendText(text:meta:shouldStore:usePost:ttl:quotedMessage:files:usersToMention:)``
 - ``sendText(text:meta:shouldStore:usePost:ttl:quotedMessage:files:usersToMention:completion:)``
+- ``sendText(text:meta:shouldStore:usePost:ttl:mentionedUsers:referencedChannels:textLinks:quotedMessage:files:completion:)``
 
 ### Creating Message Draft
 
 - ``createMessageDraft(userSuggestionSource:isTypingIndicatorTriggered:userLimit:channelLimit:)``
 
 ### Messages Management
 
+- ``connect()``
 - ``connect(callback:)``
+- ``forward(message:)``
 - ``forward(message:completion:)``
+- ``getHistory(startTimetoken:endTimetoken:count:)``
 - ``getHistory(startTimetoken:endTimetoken:count:completion:)``
+- ``getMessage(timetoken:)``
 - ``getMessage(timetoken:completion:)``
 
 ### Pinning and Unpinning a Message
 
+- ``pinMessage(message:)``
 - ``pinMessage(message:completion:)``
+- ``unpinMessage()``
 - ``unpinMessage(completion:)``
+- ``getPinnedMessage()``
 - ``getPinnedMessage(completion:)``
 
 ### Push Management
 
+- ``registerForPush()``
 - ``registerForPush(completion:)``
+- ``unregisterFromPush()``
 - ``unregisterFromPush(completion:)``
 
 ### Delete a File
 
+- ``deleteFile(id:name:)``
 - ``deleteFile(id:name:completion:)``
 
 ### Getting Files
 
 - ``GetFileItem``
+- ``getFiles(limit:next:)``
 - ``getFiles(limit:next:completion:)``
 
 ### User Suggestions 
 
+- ``getUserSuggestions(text:limit:)``
 - ``getUserSuggestions(text:limit:completion:)``
 
 ### Message Reports
 
+- ``getMessageReportsHistory(startTimetoken:endTimetoken:count:)``
 - ``getMessageReportsHistory(startTimetoken:endTimetoken:count:completion:)``
+- ``streamMessageReports()``
 - ``streamMessageReports(callback:)``

PubNubSwiftChatSDK/PubNubSwiftChatSDK.docc/Chat.md

@@ -4,36 +4,56 @@
 
 ### Initializing a Chat instance
 
+- ``initialize()``
 - ``initialize(completion:)``
 
 ### Working with Conversations
 
 - ``CreateDirectConversationResult``
 - ``CreateGroupConversationResult``
+- ``createDirectConversation(invitedUser:channelId:channelName:channelDescription:channelCustom:channelStatus:membershipCustom:)``
 - ``createDirectConversation(invitedUser:channelId:channelName:channelDescription:channelCustom:channelStatus:membershipCustom:completion:)``
+- ``createGroupConversation(invitedUsers:channelId:channelName:channelDescription:channelCustom:channelStatus:membershipCustom:)``
 - ``createGroupConversation(invitedUsers:channelId:channelName:channelDescription:channelCustom:channelStatus:membershipCustom:completion:)``
+- ``createPublicConversation(channelId:channelName:channelDescription:channelCustom:channelStatus:)``
 - ``createPublicConversation(channelId:channelName:channelDescription:channelCustom:channelStatus:completion:)``
 
 ### Working with Channels
 
+- ``getChannel(channelId:)``
 - ``getChannel(channelId:completion:)``
+- ``getChannels(filter:sort:limit:page:)``
 - ``getChannels(filter:sort:limit:page:completion:)``
+- ``updateChannel(id:name:custom:description:status:type:)``
 - ``updateChannel(id:name:custom:description:status:type:completion:)``
+- ``deleteChannel(id:soft:)``
 - ``deleteChannel(id:soft:completion:)``
+- ``whoIsPresent(channelId:)``
 - ``whoIsPresent(channelId:completion:)``
+- ``getPushChannels()``
 - ``getPushChannels(completion:)``
+- ``registerPushChannels(channels:)``
 - ``registerPushChannels(channels:completion:)``
+- ``unregisterPushChannels(channels:)``
 - ``unregisterPushChannels(channels:completion:)``
+- ``unregisterAllPushChannels()``
 - ``unregisterAllPushChannels(completion:)``
 
 ### Working with Users
 
+- ``getUser(userId:)``
 - ``getUser(userId:completion:)``
+- ``createUser(id:name:externalId:profileUrl:email:custom:status:type:)``
 - ``createUser(id:name:externalId:profileUrl:email:custom:status:type:completion:)``
+- ``getUsers(filter:sort:limit:page:)``
 - ``getUsers(filter:sort:limit:page:completion:)``
+- ``updateUser(id:name:externalId:profileUrl:email:custom:status:type:)``
 - ``updateUser(id:name:externalId:profileUrl:email:custom:status:type:completion:)``
+- ``deleteUser(id:soft:)``
 - ``deleteUser(id:soft:completion:)``
+- ``wherePresent(userId:)``
 - ``wherePresent(userId:completion:)``
+- ``isPresent(userId:channelId:)``
 - ``isPresent(userId:channelId:completion:)``
 
 ### Working with Events
@@ -42,14 +62,19 @@
 - ``EventContent``
 - ``EventWrapper``
 - ``EmitEventMethod``
+- ``emitEvent(channelId:payload:mergePayloadWith:)``
 - ``emitEvent(channelId:payload:mergePayloadWith:completion:)``
+- ``listenForEvents(type:channelId:customMethod:)``
 - ``listenForEvents(type:channelId:customMethod:callback:)``
+- ``getEventsHistory(channelId:startTimetoken:endTimetoken:count:)``
 - ``getEventsHistory(channelId:startTimetoken:endTimetoken:count:completion:)``
 
 ### Working with Messages
 
 - ``GetUnreadMessagesCount``
+- ``getUnreadMessagesCount(limit:page:filter:sort:)``
 - ``getUnreadMessagesCount(limit:page:filter:sort:completion:)``
+- ``markAllMessagesAsRead(limit:page:filter:sort:)``
 - ``markAllMessagesAsRead(limit:page:filter:sort:completion:)``
 
 ### Retrieving Current User Mentions
@@ -59,6 +84,7 @@
 - ``ChannelMentionData``
 - ``ThreadMentionData``
 - ``GetCurrentUserMentionsResult``
+- ``getCurrentUserMentions(startTimetoken:endTimetoken:count:)``
 - ``getCurrentUserMentions(startTimetoken:endTimetoken:count:completion:)``
 
 ### Destroy