Spaces: Add support for spaces Summary API

MatrixSDK/Contrib/Swift/JSONModels/MXEvent.swift

@@ -70,6 +70,7 @@ public enum MXEventType: Equatable, Hashable {
  case keyVerificationCancel
  case keyVerificationDone
  case taggedEvents
+ case spaceChild
 
  case custom(String)
 
@@ -116,6 +117,7 @@ public enum MXEventType: Equatable, Hashable {
  case .keyVerificationCancel: return kMXEventTypeStringKeyVerificationCancel
  case .keyVerificationDone: return kMXEventTypeStringKeyVerificationDone
  case .taggedEvents: return kMXEventTypeStringTaggedEvents
+ case .spaceChild: return kMXEventTypeStringSpaceChild
 
  // Swift converts any constant with the suffix "Notification" as the type `Notification.Name`
  // The original value can be reached using the `rawValue` property.

MatrixSDK/Contrib/Swift/MXRestClient.swift

@@ -1862,4 +1862,15 @@ public extension MXRestClient {
  return __deleteDevice(byDeviceId: deviceId, authParams: authParameters, success: currySuccess(completion), failure: curryFailure(completion))
  }
 
+ // MARK: - Spaces
+
+ /// Get the space children of a given space.
+ /// - Parameters:
+ /// - spaceId: The room id of the queried space.
+ /// - parameters: Space children request parameters.
+ /// - completion: A closure called when the operation completes.
+ /// - Returns: a `MXHTTPOperation` instance.
+ @nonobjc @discardableResult func getSpaceChildrenForSpace(withId spaceId: String, parameters: MXSpaceChildrenRequestParameters?, completion: @escaping (_ response: MXResponse<MXSpaceChildrenResponse>) -> Void) -> MXHTTPOperation {
+ return __getSpaceChildrenForSpace(withId: spaceId, parameters: parameters, success: currySuccess(completion), failure: curryFailure(completion))
+ }
 }

MatrixSDK/JSONModels/MXEvent.h

@@ -88,6 +88,7 @@ typedef NS_ENUM(NSInteger, MXEventType)
  MXEventTypeSecretSend,
  MXEventTypeSecretStorageDefaultKey,
  MXEventTypeTaggedEvents,
+ MXEventTypeSpaceChild,
 
  // The event is a custom event. Refer to its `MXEventTypeString` version
  MXEventTypeCustom = 1000
@@ -141,6 +142,7 @@ FOUNDATION_EXPORT NSString *const kMXEventTypeStringCallRejectReplacement;
 FOUNDATION_EXPORT NSString *const kMXEventTypeStringSticker;
 FOUNDATION_EXPORT NSString *const kMXEventTypeStringRoomTombStone;
 FOUNDATION_EXPORT NSString *const kMXEventTypeStringTaggedEvents;
+FOUNDATION_EXPORT NSString *const kMXEventTypeStringSpaceChild;
 
 // Interactive key verification
 FOUNDATION_EXPORT NSString *const kMXEventTypeStringKeyVerificationRequest;

MatrixSDK/JSONModels/MXEvent.m

@@ -79,6 +79,9 @@
 NSString *const kMXEventTypeStringSecretSend = @"m.secret.send";
 NSString *const kMXEventTypeStringSecretStorageDefaultKey = @"m.secret_storage.default_key";
 NSString *const kMXEventTypeStringTaggedEvents = @"m.tagged_events";
+//NSString *const kMXEventTypeStringSpaceChild = @"m.space.child";
+// Use temporary event type until the MSC approval
+NSString *const kMXEventTypeStringSpaceChild = @"org.matrix.msc1772.space.child";
 
 NSString *const kMXMessageTypeText = @"m.text";
 NSString *const kMXMessageTypeEmote = @"m.emote";

MatrixSDK/MXRestClient.h

@@ -41,9 +41,11 @@
 #import "MXPusher.h"
 #import "MXRoomCreationParameters.h"
 #import "MXTurnServerResponse.h"
+#import "MXSpaceChildrenResponse.h"
 
 @class MXThirdpartyProtocolsResponse;
 @class MXThirdPartyUsersResponse;
+@class MXSpaceChildrenRequestParameters;
 
 #pragma mark - Constants definitions
 /**
@@ -2680,4 +2682,17 @@ typedef MXHTTPOperation* (^MXRestClientIdentityServerAccessTokenHandler)(void (^
  success:(void (^)(MXAggregationPaginatedResponse *paginatedResponse))success
  failure:(void (^)(NSError *error))failure;
 
+#pragma mark - Spaces
+
+/// Get the space children of a given space.
+/// @param spaceId The room id of the queried space.
+/// @param parameters Space children request parameters.
+/// @param success A block object called when the operation succeeds. It provides a `MXSpaceChildrenResponse` object.
+/// @param failure A block object called when the operation fails.
+/// @return a MXHTTPOperation instance.
+- (MXHTTPOperation*)getSpaceChildrenForSpaceWithId:(NSString*)spaceId
+ parameters:(MXSpaceChildrenRequestParameters*)parameters
+ success:(void (^)(MXSpaceChildrenResponse *spaceChildrenResponse))success
+ failure:(void (^)(NSError *error))failure NS_REFINED_FOR_SWIFT;
+
 @end

MatrixSDK/MXRestClient.m

@@ -29,6 +29,8 @@
 #import "MXThirdpartyProtocolsResponse.h"
 #import "MXThirdPartyUsersResponse.h"
 
+#import "MatrixSDKSwiftHeader.h"
+
 #pragma mark - Constants definitions
 /**
  Prefix used in path of home server API requests.
@@ -5332,4 +5334,37 @@ - (MXHTTPOperation*)relationsForEvent:(NSString*)eventId
  }];
 }
 
+#pragma mark - Spaces
+
+- (MXHTTPOperation*)getSpaceChildrenForSpaceWithId:(NSString*)spaceId
+ parameters:(MXSpaceChildrenRequestParameters*)parameters
+ success:(void (^)(MXSpaceChildrenResponse *spaceChildrenResponse))success
+ failure:(void (^)(NSError *error))failure
+{
+ NSString *path = [NSString stringWithFormat:@"%@/org.matrix.msc2946/rooms/%@/spaces",
+ kMXAPIPrefixPathUnstable, spaceId];
+
+ MXWeakify(self);
+ return [httpClient requestWithMethod:@"POST"
+ path:path 
+ parameters:[parameters jsonDictionary] ?: @{}
+ success:^(NSDictionary *JSONResponse) {
+ MXStrongifyAndReturnIfNil(self);
+
+ if (success)
+ {
+ __block MXSpaceChildrenResponse *spaceChildrenResponse;
+ [self dispatchProcessing:^{
+ MXJSONModelSetMXJSONModel(spaceChildrenResponse, MXSpaceChildrenResponse, JSONResponse);
+ } andCompletion:^{
+ success(spaceChildrenResponse);
+ }];
+ }
+ }
+ failure:^(NSError *error) {
+ MXStrongifyAndReturnIfNil(self);
+ [self dispatchFailure:error inBlock:failure];
+ }];
+}
+
 @end

MatrixSDK/MatrixSDK.h

@@ -126,6 +126,8 @@ FOUNDATION_EXPORT NSString *MatrixSDKVersion;
 #import "MXAesKeyData.h"
 #import "MXRawDataKey.h"
 
+#import "MXSpaceChildContent.h"
+
 // Bridging to Swift
 #import "MXCryptoStore.h"
 #import "MXRealmCryptoStore.h"

MatrixSDK/Space/MXSpace.swift

@@ -16,6 +16,24 @@
 
 import Foundation
 
+/// MXSpace operation error
+public enum MXSpaceError: Int, Error {
+ case homeserverNameNotFound
+ case unknown
+}
+
+extension MXSpaceError: CustomNSError {
+ public static let errorDomain = "org.matrix.sdk.space"
+
+ public var errorCode: Int {
+ return Int(rawValue)
+ }
+
+ public var errorUserInfo: [String: Any] {
+ return [:]
+ }
+}
+
 /// A Matrix space enables to collect rooms together into groups. Such collections of rooms are referred as "spaces" (see https:/matrix-org/matrix-doc/blob/matthew/msc1772/proposals/1772-groups-as-rooms.md).
 public class MXSpace: NSObject {
 
@@ -24,15 +42,97 @@ public class MXSpace: NSObject {
  /// The underlying room
  public let room: MXRoom
 
+ /// Shortcut to the room roomId
+ public var spaceId: String {
+ return self.room.roomId
+ }
+
  /// Shortcut to the room summary
  public var summary: MXRoomSummary? {
  return self.room.summary
  }
 
  // MARK: - Setup
 
- init(room: MXRoom) {
+ public init(room: MXRoom) {
  self.room = room
  super.init()
  }
+
+ // MARK: - Public
+
+ /// Add child space or child room to the current space.
+ /// - Parameters:
+ /// - roomId: The room id of the child space or child room.
+ /// - viaServers: List of candidate servers that can be used to join the space. Children where via is not present are ignored.
+ /// If nil value is set current homeserver will be used as via server.
+ /// - order: Is a string which is used to provide a default ordering of siblings in the room list. Orders should be a string of ascii characters in the range \x20 (space) to \x7F (~), and should be less or equal 50 characters.
+ /// - autoJoin: Allows a space admin to list the sub-spaces and rooms in that space which should be automatically joined by members of that space.
+ /// - suggested: Indicates that the child should be advertised to members of the space by the client. This could be done by showing them eagerly in the room list.
+ /// - completion: A closure called when the operation completes. Provides the event id of the event generated on the home server on success.
+ /// - Returns: a `MXHTTPOperation` instance.
+ @discardableResult
+ public func addChild(roomId: String,
+ viaServers: [String]? = nil,
+ order: String? = nil,
+ autoJoin: Bool = false,
+ suggested: Bool = false,
+ completion: @escaping (_ response: MXResponse<String?>) -> Void) -> MXHTTPOperation? {
+
+ let finalViaServers: [String]
+
+ if let viaServers = viaServers {
+ finalViaServers = viaServers
+ } else {
+ // If viaServers is nil use the current homeserver as via server
+ guard let homeserverName = self.room.mxSession.credentials.homeServerName() else {
+ completion(.failure(MXSpaceError.homeserverNameNotFound))
+ return nil
+ }
+ finalViaServers = [homeserverName]
+ }
+
+ let spaceChild = MXSpaceChildContent()
+ spaceChild.via = finalViaServers
+ spaceChild.order = order
+ spaceChild.autoJoin = autoJoin
+ spaceChild.suggested = suggested
+
+ guard let stateEventContent = spaceChild.jsonDictionary() as? [String: Any] else {
+ fatalError("[MXSpace] MXSpaceChildContent dictionary cannot be nil")
+ }
+
+ return self.room.sendStateEvent(.spaceChild,
+ content: stateEventContent,
+ stateKey: roomId,
+ completion: completion)
+ }
+}
+
+// MARK: - Objective-C
+extension MXSpace {
+
+ /// Add child space or child room to the current space.
+ /// - Parameters:
+ /// - roomId: The room id of the child space or child room.
+ /// - viaServers: List of candidate servers that can be used to join the space. Children where via is not present are ignored.
+ /// If nil value is set current homeserver will be used as via server.
+ /// - order: Is a string which is used to provide a default ordering of siblings in the room list. Orders should be a string of ascii characters in the range \x20 (space) to \x7F (~), and should be less or equal 50 characters.
+ /// - autoJoin: Allows a space admin to list the sub-spaces and rooms in that space which should be automatically joined by members of that space.
+ /// - suggested: Indicates that the child should be advertised to members of the space by the client. This could be done by showing them eagerly in the room list.
+ /// - success: A closure called when the operation is complete. Provides the event id of the event generated on the home server on success.
+ /// - failure: A closure called when the operation fails.
+ /// - Returns: a `MXHTTPOperation` instance.
+ @discardableResult
+ public func addChild(roomId: String,
+ viaServers: [String]?,
+ order: String?,
+ autoJoin: Bool,
+ suggested: Bool,
+ success: @escaping (String?) -> Void,
+ failure: @escaping (Error) -> Void) -> MXHTTPOperation? {
+ return self.addChild(roomId: roomId, viaServers: viaServers, order: order, autoJoin: autoJoin, suggested: suggested) { (response) in
+ uncurryResponse(response, success: success, failure: failure)
+ }
+ }
 }

MatrixSDK/Space/MXSpaceChildContent.h

@@ -0,0 +1,47 @@
+// 
+// Copyright 2021 The Matrix.org Foundation C.I.C
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+#import <Foundation/Foundation.h>
+#import "MXJSONModel.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// MXSpaceChildContent represents the state event content of space child event type (MXEventType.spaceChild).
+@interface MXSpaceChildContent : MXJSONModel
+
+/// Key which gives a list of candidate servers that can be used to join the room
+/// Children where via is not present are ignored.
+@property (nonatomic, strong, nullable) NSArray<NSString*>* via;
+
+/// The order key is a string which is used to provide a default ordering of siblings in the room list.
+/// (Rooms are sorted based on a lexicographic ordering of order values; rooms with no order come last.
+/// orders which are not strings, or do not consist solely of ascii characters in the range \x20 (space) to \x7F (~),
+/// or consist of more than 50 characters, are forbidden and should be ignored if received.)
+@property (nonatomic, strong, nullable) NSString *order;
+
+/// The auto_join flag on a child listing allows a space admin to list the sub-spaces and rooms in that space which should be automatically joined by members of that space.
+/// (This is not a force-join, which are descoped for a future MSC; the user can subsequently part these room if they desire.)
+/// `NO` by default.
+@property (nonatomic) BOOL autoJoin;
+
+/// If `suggested` is set to `true`, that indicates that the child should be advertised to members of the space by the client. This could be done by showing them eagerly in the room list.
+/// This is should be ignored if `auto_join` is set to `true`.
+/// `NO` by default.
+@property (nonatomic) BOOL suggested;
+
+@end
+
+NS_ASSUME_NONNULL_END