Poll support

MatrixSDK/Aggregations/MXAggregations.h

@@ -111,7 +111,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (MXHTTPOperation*)reactionsEventsForEvent:(NSString*)eventId
                                      inRoom:(NSString*)roomId
                                        from:(nullable NSString*)from
-                                      limit:(NSUInteger)limit
+                                      limit:(NSInteger)limit
                                     success:(void (^)(MXAggregationPaginatedResponse *paginatedResponse))success
                                     failure:(void (^)(NSError *error))failure;
 
@@ -168,7 +168,7 @@ NS_ASSUME_NONNULL_BEGIN
                               isEncrypted:(BOOL)isEncrypted
                                    inRoom:(NSString*)roomId
                                      from:(nullable NSString*)from
-                                    limit:(NSUInteger)limit
+                                    limit:(NSInteger)limit
                                   success:(void (^)(MXAggregationPaginatedResponse *paginatedResponse))success
                                   failure:(void (^)(NSError *error))failure;
 
@@ -191,7 +191,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (MXHTTPOperation*)referenceEventsForEvent:(NSString*)eventId
                                    inRoom:(NSString*)roomId
                                      from:(nullable NSString*)from
-                                    limit:(NSUInteger)limit
+                                    limit:(NSInteger)limit
                                   success:(void (^)(MXAggregationPaginatedResponse *paginatedResponse))success
                                   failure:(void (^)(NSError *error))failure;
 

MatrixSDK/Aggregations/MXAggregations.m

@@ -90,7 +90,7 @@ - (void)removeListener:(id)listener
 - (MXHTTPOperation*)reactionsEventsForEvent:(NSString*)eventId
                                      inRoom:(NSString*)roomId
                                        from:(nullable NSString*)from
-                                      limit:(NSUInteger)limit
+                                      limit:(NSInteger)limit
                                     success:(void (^)(MXAggregationPaginatedResponse *paginatedResponse))success
                                     failure:(void (^)(NSError *error))failure
 {
@@ -126,7 +126,7 @@ - (MXHTTPOperation*)replaceEventsForEvent:(NSString*)eventId
                               isEncrypted:(BOOL)isEncrypted
                                    inRoom:(NSString*)roomId
                                      from:(nullable NSString*)from
-                                    limit:(NSUInteger)limit
+                                    limit:(NSInteger)limit
                                   success:(void (^)(MXAggregationPaginatedResponse *paginatedResponse))success
                                   failure:(void (^)(NSError *error))failure
 {
@@ -137,7 +137,7 @@ - (MXHTTPOperation*)replaceEventsForEvent:(NSString*)eventId
 - (MXHTTPOperation*)referenceEventsForEvent:(NSString*)eventId
                                      inRoom:(NSString*)roomId
                                        from:(nullable NSString*)from
-                                      limit:(NSUInteger)limit
+                                      limit:(NSInteger)limit
                                     success:(void (^)(MXAggregationPaginatedResponse *paginatedResponse))success
                                     failure:(void (^)(NSError *error))failure
 {

MatrixSDK/Data/MXRoom.h

@@ -28,6 +28,7 @@
 
 #import "MXEvent.h"
 #import "MXJSONModels.h"
+#import "MXEventContentPollStart.h"
 #import "MXRoomSummary.h"
 #import "MXRoomMember.h"
 #import "MXReceiptData.h"
@@ -931,6 +932,23 @@ FOUNDATION_EXPORT NSInteger const kMXRoomAlreadyJoinedErrorCode;
                              success:(void (^)(NSString *eventId))success
                              failure:(void (^)(NSError *error))failure NS_REFINED_FOR_SWIFT;
 
+#pragma mark - Polls
+
+- (MXHTTPOperation *)sendPollStartWithContent:(MXEventContentPollStart *)content
+                                    localEcho:(MXEvent **)localEcho
+                                      success:(void (^)(NSString *))success
+                                      failure:(void (^)(NSError *))failure;
+
+- (MXHTTPOperation*)sendPollResponseForEvent:(MXEvent *)pollEvent
+                       withAnswerIdentifiers:(NSArray<NSString *> *)answerIdentifiers
+                                   localEcho:(MXEvent **)localEcho
+                                     success:(void (^)(NSString *eventId))success
+                                     failure:(void (^)(NSError *error))failure;
+
+- (MXHTTPOperation*)sendPollEndForEvent:(MXEvent *)pollEvent
+                              localEcho:(MXEvent **)localEcho
+                                success:(void (^)(NSString *eventId))success
+                                failure:(void (^)(NSError *error))failure;
 
 #pragma mark - Events listeners on the live timeline
 /**

MatrixSDK/Data/MXRoom.m

@@ -35,6 +35,8 @@
 
 #import "MXRoomSync.h"
 
+#import "MXEventContentPollStart.h"
+
 NSString *const kMXRoomDidFlushDataNotification = @"kMXRoomDidFlushDataNotification";
 NSString *const kMXRoomInitialSyncNotification = @"kMXRoomInitialSyncNotification";
 NSInteger const kMXRoomAlreadyJoinedErrorCode = 9001;
@@ -618,11 +620,11 @@ - (MXHTTPOperation*)sendEventOfType:(MXEventTypeString)eventTypeString
             NSDictionary *contentCopyToEncrypt = nil;
 
             // Store the "m.relates_to" data and remove them from event clear content before encrypting the event content
-            if (contentCopy[@"m.relates_to"])
+            if (contentCopy[kMXEventRelationRelatesToKey])
             {
-                relatesToJSON = contentCopy[@"m.relates_to"];
+                relatesToJSON = contentCopy[kMXEventRelationRelatesToKey];
                 NSMutableDictionary *updatedContent = [contentCopy mutableCopy];
-                updatedContent[@"m.relates_to"] = nil;
+                updatedContent[kMXEventRelationRelatesToKey] = nil;
                 contentCopyToEncrypt = [updatedContent copy];
             }
             else
@@ -673,7 +675,7 @@ - (MXHTTPOperation*)sendEventOfType:(MXEventTypeString)eventTypeString
                     if (relatesToJSON)
                     {
                         NSMutableDictionary *updatedEncryptedContent = [encryptedContent mutableCopy];
-                        updatedEncryptedContent[@"m.relates_to"] = relatesToJSON;
+                        updatedEncryptedContent[kMXEventRelationRelatesToKey] = relatesToJSON;
                         finalEncryptedContent = [updatedEncryptedContent copy];
                     }
                     else
@@ -1968,7 +1970,7 @@ - (MXHTTPOperation*)sendReplyToEvent:(MXEvent*)eventToReply
         msgContent[@"msgtype"] = kMXMessageTypeText;
         msgContent[@"body"] = replyToBody;
         msgContent[@"formatted_body"] = replyToFormattedBody;
-        msgContent[@"m.relates_to"] = relatesToDict;
+        msgContent[kMXEventRelationRelatesToKey] = relatesToDict;
 
         operation = [self sendMessageWithContent:msgContent
                                        localEcho:localEcho
@@ -2274,6 +2276,85 @@ - (BOOL)canReplyToEvent:(MXEvent *)eventToReply
     return canReplyToEvent;
 }
 
+#pragma mark - Polls
+
+- (MXHTTPOperation *)sendPollStartWithContent:(MXEventContentPollStart *)content
+                                    localEcho:(MXEvent **)localEcho
+                                      success:(void (^)(NSString *))success
+                                      failure:(void (^)(NSError *))failure
+{
+    NSParameterAssert(content);
+
+    if (content.question.length == 0)
+    {
+        MXLogError(@"[MXRoom] Cannot send poll with empty question.");
+        return nil;
+    }
+
+    if (content.answerOptions.count < 2)
+    {
+        MXLogError(@"[MXRoom] Cannot send poll with less than 2 answer options.");
+        return nil;
+    }
+
+    for (MXEventContentPollStartAnswerOption *answerOption in content.answerOptions) {
+        if (answerOption.text.length == 0) {
+            MXLogError(@"[MXRoom] Cannot send poll with empty answer option.");
+            return nil;
+        }
+    }
+
+    return [self sendEventOfType:kMXEventTypeStringPollStart content:content.JSONDictionary localEcho:localEcho success:success failure:failure];
+}
+
+- (MXHTTPOperation *)sendPollResponseForEvent:(MXEvent *)pollStartEvent
+                        withAnswerIdentifiers:(NSArray<NSString *> *)answerIdentifiers
+                                    localEcho:(MXEvent **)localEcho
+                                      success:(void (^)(NSString *))success
+                                      failure:(void (^)(NSError *))failure
+{
+    NSParameterAssert(pollStartEvent);
+    NSAssert([pollStartEvent.type isEqualToString:kMXEventTypeStringPollStart], @"Invalid event type");
+    NSParameterAssert(answerIdentifiers);
+
+    for (NSString *answerIdentifier in answerIdentifiers)
+    {
+        if (answerIdentifier.length == 0) {
+            MXLogError(@"[MXRoom] Cannot send poll answer with empty identifier.");
+            return nil;
+        }
+    }
+
+    MXEventContentRelatesTo *relatesTo = [[MXEventContentRelatesTo alloc] initWithRelationType:MXEventRelationTypeReference
+                                                                                       eventId:pollStartEvent.eventId];
+
+    NSDictionary *content = @{
+        kMXEventRelationRelatesToKey: relatesTo.JSONDictionary,
+        kMXMessageContentKeyExtensiblePollResponse: @{ kMXMessageContentKeyExtensiblePollAnswers: answerIdentifiers }
+    };
+
+    return [self sendEventOfType:kMXEventTypeStringPollResponse content:content localEcho:localEcho success:success failure:failure];
+}
+
+- (MXHTTPOperation *)sendPollEndForEvent:(MXEvent *)pollStartEvent
+                               localEcho:(MXEvent **)localEcho
+                                 success:(void (^)(NSString *))success
+                                 failure:(void (^)(NSError *))failure
+{
+    NSParameterAssert(pollStartEvent);
+    NSAssert([pollStartEvent.type isEqualToString:kMXEventTypeStringPollStart], @"Invalid event type");
+
+    MXEventContentRelatesTo *relatesTo = [[MXEventContentRelatesTo alloc] initWithRelationType:MXEventRelationTypeReference
+                                                                                       eventId:pollStartEvent.eventId];
+
+    NSDictionary *content = @{
+        kMXEventRelationRelatesToKey: relatesTo.JSONDictionary,
+        kMXMessageContentKeyExtensiblePollEnd: @{}
+    };
+
+    return [self sendEventOfType:kMXEventTypeStringPollEnd content:content localEcho:localEcho success:success failure:failure];
+}
+
 #pragma mark - Message order preserving
 /**
  Make sure that `block` will be called in the order expected by the end user.

MatrixSDK/JSONModels/Event/Content/MXEventContentPollStart.h

@@ -0,0 +1,51 @@
+// 
+// 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
+
+@interface MXEventContentPollStartAnswerOption: MXJSONModel
+
+@property (nonatomic, readonly) NSString *uuid;
+
+@property (nonatomic, readonly) NSString *text;
+
+- (instancetype)initWithUUID:(NSString *)uuid
+                        text:(NSString *)text;
+
+@end
+
+@interface MXEventContentPollStart : MXJSONModel
+
+@property (nonatomic, readonly) NSString *question;
+
+@property (nonatomic, readonly) NSString *kind;
+
+@property (nonatomic, readonly) NSNumber *maxSelections;
+
+@property (nonatomic, readonly) NSArray<MXEventContentPollStartAnswerOption *> *answerOptions;
+
+- (instancetype)initWithQuestion:(NSString *)question
+                            kind:(NSString *)kind
+                   maxSelections:(NSNumber *)maxSelections
+                   answerOptions:(NSArray<MXEventContentPollStartAnswerOption *> *)answerOptions;
+
+@end
+
+NS_ASSUME_NONNULL_END

MatrixSDK/JSONModels/Event/Content/MXEventContentPollStart.m

@@ -0,0 +1,110 @@
+// 
+// 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 "MXEventContentPollStart.h"
+#import "MXEvent.h"
+
+@implementation MXEventContentPollStart
+
+- (instancetype)initWithQuestion:(NSString *)question
+                            kind:(NSString *)kind
+                   maxSelections:(NSNumber *)maxSelections
+                   answerOptions:(NSArray<MXEventContentPollStartAnswerOption *> *)answerOptions
+{
+    if (self = [super init]) {
+        _question = question;
+        _kind = kind;
+        _maxSelections = maxSelections;
+        _answerOptions = answerOptions;
+    }
+
+    return self;
+}
+
++ (instancetype)modelFromJSON:(NSDictionary *)JSONDictionary
+{
+    NSDictionary *content = JSONDictionary[kMXMessageContentKeyExtensiblePollStart];
+
+    NSString *question, *kind;
+    MXJSONModelSetString(question, content[kMXMessageContentKeyExtensiblePollQuestion]);
+    MXJSONModelSetString(kind, content[kMXMessageContentKeyExtensiblePollKind]);
+
+    NSNumber *maxSelections;
+    MXJSONModelSetNumber(maxSelections, content[kMXMessageContentKeyExtensiblePollMaxSelections]);
+
+    NSArray<MXEventContentPollStartAnswerOption *> *answerOptions = [MXEventContentPollStartAnswerOption modelsFromJSON:content[kMXMessageContentKeyExtensiblePollAnswers]];
+
+    return [[MXEventContentPollStart alloc] initWithQuestion:question
+                                                        kind:kind
+                                               maxSelections:maxSelections
+                                               answerOptions:answerOptions];
+}
+
+- (NSDictionary *)JSONDictionary
+{
+    NSMutableDictionary *content = [NSMutableDictionary dictionary];
+
+    content[kMXMessageContentKeyExtensiblePollQuestion] = self.question;
+    content[kMXMessageContentKeyExtensiblePollKind] = self.kind;
+    content[kMXMessageContentKeyExtensiblePollMaxSelections] = self.maxSelections;
+
+    NSMutableArray *answerOptions = [NSMutableArray arrayWithCapacity:self.answerOptions.count];
+    for (MXEventContentPollStartAnswerOption *answerOption in self.answerOptions)
+    {
+        [answerOptions addObject:answerOption.JSONDictionary];
+    }
+
+    content[kMXMessageContentKeyExtensiblePollAnswers] = answerOptions;
+
+    return @{kMXMessageContentKeyExtensiblePollStart: content};
+}
+
+@end
+
+
+@implementation MXEventContentPollStartAnswerOption
+
+- (instancetype)initWithUUID:(NSString *)uuid text:(NSString *)text
+{
+    if (self = [super init])
+    {
+        _uuid = uuid;
+        _text = text;
+    }
+
+    return self;
+}
+
++ (instancetype)modelFromJSON:(NSDictionary *)JSONDictionary
+{
+    NSString *uuid, *text;
+    MXJSONModelSetString(uuid, JSONDictionary[kMXMessageContentKeyExtensiblePollAnswerId]);
+    MXJSONModelSetString(text, JSONDictionary[kMXMessageContentKeyExtensibleText]);
+
+    return [[MXEventContentPollStartAnswerOption alloc] initWithUUID:uuid text:text];
+}
+
+- (NSDictionary *)JSONDictionary
+{
+    NSMutableDictionary *JSONDictionary = [NSMutableDictionary dictionary];
+
+    JSONDictionary[kMXMessageContentKeyExtensiblePollAnswerId] = self.uuid;
+    JSONDictionary[kMXMessageContentKeyExtensibleText] = self.text;
+
+    return JSONDictionary;
+}
+
+@end

MatrixSDK/JSONModels/Event/Content/MXEventContentRelatesTo.h

@@ -29,6 +29,13 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic, readonly) NSString *eventId;
 @property (nonatomic, readonly, nullable) NSString *key;
 
+- (instancetype)initWithRelationType:(NSString *)relationType
+                             eventId:(NSString *)eventId;
+
+- (instancetype)initWithRelationType:(NSString *)relationType
+                             eventId:(NSString *)eventId
+                                 key:(nullable NSString *)key;
+
 @end
 
 NS_ASSUME_NONNULL_END