Add channel.config.sharedLocationsEnabled

Author: nuno-vieira

DemoApp/StreamChat/Components/CustomAttachments/DemoComposerVC.swift

@@ -12,8 +12,10 @@ class DemoComposerVC: ComposerVC {
 
     override var attachmentsPickerActions: [UIAlertAction] {
         var actions = super.attachmentsPickerActions
-        
-        if AppConfig.shared.demoAppConfig.isLocationAttachmentsEnabled && content.isInsideThread == false {
+
+        let isDemoAppLocationsEnabled = AppConfig.shared.demoAppConfig.isLocationAttachmentsEnabled
+        let isLocationEnabled = channelController?.channel?.config.sharedLocationsEnabled == true
+        if isLocationEnabled && isDemoAppLocationsEnabled && content.isInsideThread == false {
             let sendLocationAction = UIAlertAction(
                 title: "Send Current Location",
                 style: .default,

Sources/StreamChat/APIClient/Endpoints/Payloads/ChannelListPayload.swift

@@ -233,13 +233,14 @@ public class ChannelConfig: Codable {
         case updatedAt = "updated_at"
         case skipLastMsgAtUpdateForSystemMsg = "skip_last_msg_update_for_system_msgs"
         case messageRemindersEnabled = "user_message_reminders"
+        case sharedLocationsEnabled = "shared_locations"
     }
 
     /// If users are allowed to add reactions to messages. Enabled by default.
     public let reactionsEnabled: Bool
     /// Controls if typing indicators are shown. Enabled by default.
     public let typingEventsEnabled: Bool
-    /// Controls whether the chat shows how far you’ve read. Enabled by default.
+    /// Controls whether the chat shows how far you've read. Enabled by default.
     public let readEventsEnabled: Bool
     /// Determines if events are fired for connecting and disconnecting to a chat. Enabled by default.
     public let connectEventsEnabled: Bool
@@ -271,6 +272,8 @@ public class ChannelConfig: Codable {
     public let skipLastMsgAtUpdateForSystemMsg: Bool
     /// Determines if user message reminders are enabled.
     public let messageRemindersEnabled: Bool
+    /// Determines if shared locations are enabled.
+    public let sharedLocationsEnabled: Bool
 
     public required init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
@@ -297,6 +300,7 @@ public class ChannelConfig: Codable {
         pollsEnabled = try container.decodeIfPresent(Bool.self, forKey: .pollsEnabled) ?? false
         skipLastMsgAtUpdateForSystemMsg = try container.decodeIfPresent(Bool.self, forKey: .skipLastMsgAtUpdateForSystemMsg) ?? false
         messageRemindersEnabled = try container.decodeIfPresent(Bool.self, forKey: .messageRemindersEnabled) ?? false
+        sharedLocationsEnabled = try container.decodeIfPresent(Bool.self, forKey: .sharedLocationsEnabled) ?? false
     }
 
     internal required init(
@@ -313,6 +317,7 @@ public class ChannelConfig: Codable {
         urlEnrichmentEnabled: Bool = false,
         skipLastMsgAtUpdateForSystemMsg: Bool = false,
         messageRemindersEnabled: Bool = false,
+        sharedLocationsEnabled: Bool = false,
         messageRetention: String = "",
         maxMessageLength: Int = 0,
         commands: [Command] = [],
@@ -337,5 +342,6 @@ public class ChannelConfig: Codable {
         self.pollsEnabled = pollsEnabled
         self.skipLastMsgAtUpdateForSystemMsg = skipLastMsgAtUpdateForSystemMsg
         self.messageRemindersEnabled = messageRemindersEnabled
+        self.sharedLocationsEnabled = sharedLocationsEnabled
     }
 }

Sources/StreamChat/Database/DTOs/ChannelConfigDTO.swift

@@ -25,6 +25,7 @@ final class ChannelConfigDTO: NSManagedObject {
     @NSManaged var createdAt: DBDate
     @NSManaged var updatedAt: DBDate
     @NSManaged var commands: NSOrderedSet
+    @NSManaged var sharedLocationsEnabled: Bool
 
     func asModel() throws -> ChannelConfig {
         try isNotDeleted()
@@ -42,6 +43,7 @@ final class ChannelConfigDTO: NSManagedObject {
             urlEnrichmentEnabled: urlEnrichmentEnabled,
             skipLastMsgAtUpdateForSystemMsg: skipLastMsgAtUpdateForSystemMsg,
             messageRemindersEnabled: messageRemindersEnabled,
+            sharedLocationsEnabled: sharedLocationsEnabled,
             messageRetention: messageRetention,
             maxMessageLength: Int(maxMessageLength),
             commands: Array(Set(
@@ -83,6 +85,7 @@ extension ChannelConfig {
         dto.pollsEnabled = pollsEnabled
         dto.skipLastMsgAtUpdateForSystemMsg = skipLastMsgAtUpdateForSystemMsg
         dto.messageRemindersEnabled = messageRemindersEnabled
+        dto.sharedLocationsEnabled = sharedLocationsEnabled
         return dto
     }
 }

Sources/StreamChat/Database/StreamChatModel.xcdatamodeld/StreamChatModel.xcdatamodel/contents

@@ -29,6 +29,7 @@
         <attribute name="readEventsEnabled" attributeType="Boolean" defaultValueString="NO" usesScalarValueType="YES"/>
         <attribute name="repliesEnabled" attributeType="Boolean" defaultValueString="NO" usesScalarValueType="YES"/>
         <attribute name="searchEnabled" attributeType="Boolean" defaultValueString="NO" usesScalarValueType="YES"/>
+        <attribute name="sharedLocationsEnabled" optional="YES" attributeType="Boolean" defaultValueString="NO" usesScalarValueType="YES"/>
         <attribute name="skipLastMsgAtUpdateForSystemMsg" attributeType="Boolean" defaultValueString="NO" usesScalarValueType="YES"/>
         <attribute name="typingEventsEnabled" attributeType="Boolean" defaultValueString="NO" usesScalarValueType="YES"/>
         <attribute name="updatedAt" attributeType="Date" usesScalarValueType="NO"/>

TestTools/StreamChatTestTools/Fixtures/JSONs/Channel.json

@@ -1320,6 +1320,7 @@
       "automod" : "AI",
       "read_events" : true,
       "skip_last_msg_update_for_system_msgs": true,
+      "shared_locations": true,
       "commands" : [
         {
           "set" : "fun_set",

TestTools/StreamChatTestTools/Fixtures/JSONs/ChannelPayload.json

@@ -20,6 +20,7 @@
    "member_count":4,
    "updated_at":"2019-05-10T14:03:49.505006Z",
    "config":{
+      "shared_locations": true,
       "automod_behavior":"flag",
       "reactions":true,
       "typing_events":true,

TestTools/StreamChatTestTools/Mocks/Models + Extensions/ChatChannel_Mock.swift

@@ -19,6 +19,8 @@ public extension ChannelConfig {
         mutesEnabled: Bool = true,
         urlEnrichmentEnabled: Bool = true,
         skipLastMsgAtUpdateForSystemMsg: Bool = false,
+        messageRemindersEnabled: Bool = false,
+        sharedLocationsEnabled: Bool = false,
         messageRetention: String = "",
         maxMessageLength: Int = 0,
         commands: [Command] = [Command(name: "Giphy", description: "", set: "", args: "")],
@@ -37,6 +39,8 @@ public extension ChannelConfig {
             mutesEnabled: mutesEnabled,
             urlEnrichmentEnabled: urlEnrichmentEnabled,
             skipLastMsgAtUpdateForSystemMsg: skipLastMsgAtUpdateForSystemMsg,
+            messageRemindersEnabled: messageRemindersEnabled,
+            sharedLocationsEnabled: sharedLocationsEnabled,
             messageRetention: messageRetention,
             maxMessageLength: maxMessageLength,
             commands: commands,

TestTools/StreamChatTestTools/TestData/DummyData/ChannelPayload.swift

@@ -18,7 +18,8 @@ extension ChannelPayload {
         pinnedMessages: [MessagePayload] = [],
         channelReads: [ChannelReadPayload] = [],
         isHidden: Bool? = nil,
-        draft: DraftPayload? = nil
+        draft: DraftPayload? = nil,
+        sharedLocationsEnabled: Bool = false
     ) -> Self {
         .init(
             channel: channel,

Tests/StreamChatTests/APIClient/Endpoints/Payloads/ChannelListPayload_Tests.swift

@@ -332,6 +332,7 @@ final class ChannelPayload_Tests: XCTestCase {
         XCTAssertEqual(config.messageRetention, "infinite")
         XCTAssertEqual(config.maxMessageLength, 5000)
         XCTAssertEqual(config.skipLastMsgAtUpdateForSystemMsg, true)
+        XCTAssertEqual(config.sharedLocationsEnabled, true)
         XCTAssertEqual(
             config.commands,
             [.init(name: "giphy", description: "Post a random gif to the channel", set: "fun_set", args: "[text]")]

Tests/StreamChatTests/Database/DTOs/ChannelDTO_Tests.swift

@@ -397,6 +397,7 @@ final class ChannelDTO_Tests: XCTestCase {
             Assert.willBeEqual(payload.channel.config.createdAt, loadedChannel.config.createdAt)
             Assert.willBeEqual(payload.channel.config.updatedAt, loadedChannel.config.updatedAt)
             Assert.willBeEqual(payload.channel.config.messageRemindersEnabled, loadedChannel.config.messageRemindersEnabled)
+            Assert.willBeEqual(payload.channel.config.sharedLocationsEnabled, loadedChannel.config.sharedLocationsEnabled)
 
             // Own Capabilities
             Assert.willBeEqual(payload.channel.ownCapabilities, ["join-channel", "delete-channel"])