Merge pull request #4814 from vector-im/steve/4734_room_vc_refacto

RoomVC: Add a delegate, factorize and reduce usage of AppDelegate

Riot/Modules/Room/RoomViewController.h

@@ -28,6 +28,9 @@
 #import "UIViewController+RiotSearch.h"
 
 @class BadgeLabel;
+@protocol RoomViewControllerDelegate;
+
+NS_ASSUME_NONNULL_BEGIN
 
 /**
  Notification string used to indicate call tile tapped in a room. Notification object will be the `RoomBubbleCellData` object.
@@ -41,28 +44,32 @@ extern NSNotificationName const RoomGroupCallTileTappedNotification;
 
 @interface RoomViewController : MXKRoomViewController
 
+
+// The delegate for the view controller.
+@property (weak, nonatomic, nullable) id<RoomViewControllerDelegate> delegate;
+
 // The preview header
-@property (weak, nonatomic) IBOutlet UIView *previewHeaderContainer;
-@property (weak, nonatomic) IBOutlet NSLayoutConstraint *previewHeaderContainerHeightConstraint;
+@property (weak, nonatomic, nullable) IBOutlet UIView *previewHeaderContainer;
+@property (weak, nonatomic, nullable) IBOutlet NSLayoutConstraint *previewHeaderContainerHeightConstraint;
 
 // The jump to last unread banner
-@property (weak, nonatomic) IBOutlet UIView *jumpToLastUnreadBannerContainer;
-@property (weak, nonatomic) IBOutlet UIView *jumpToLastUnreadBanner;
-@property (weak, nonatomic) IBOutlet UIImageView *jumpToLastUnreadImageView;
-@property (weak, nonatomic) IBOutlet UIButton *jumpToLastUnreadButton;
-@property (weak, nonatomic) IBOutlet UILabel *jumpToLastUnreadLabel;
-@property (weak, nonatomic) IBOutlet UIButton *resetReadMarkerButton;
-@property (weak, nonatomic) IBOutlet UIView *inputBackgroundView;
-@property (weak, nonatomic) IBOutlet UIButton *scrollToBottomButton;
-@property (weak, nonatomic) IBOutlet BadgeLabel *scrollToBottomBadgeLabel;
+@property (weak, nonatomic, nullable) IBOutlet UIView *jumpToLastUnreadBannerContainer;
+@property (weak, nonatomic, nullable) IBOutlet UIView *jumpToLastUnreadBanner;
+@property (weak, nonatomic, nullable) IBOutlet UIImageView *jumpToLastUnreadImageView;
+@property (weak, nonatomic, nullable) IBOutlet UIButton *jumpToLastUnreadButton;
+@property (weak, nonatomic, nullable) IBOutlet UILabel *jumpToLastUnreadLabel;
+@property (weak, nonatomic, nullable) IBOutlet UIButton *resetReadMarkerButton;
+@property (weak, nonatomic, nullable) IBOutlet UIView *inputBackgroundView;
+@property (weak, nonatomic, nullable) IBOutlet UIButton *scrollToBottomButton;
+@property (weak, nonatomic, nullable) IBOutlet BadgeLabel *scrollToBottomBadgeLabel;
 
 // Remove Jitsi widget container
-@property (weak, nonatomic) IBOutlet UIView *removeJitsiWidgetContainer;
+@property (weak, nonatomic, nullable) IBOutlet UIView *removeJitsiWidgetContainer;
 
 /**
  Preview data for a room invitation received by email, or a link to a room.
  */
-@property (nonatomic, readonly) RoomPreviewData *roomPreviewData;
+@property (nonatomic, readonly, nullable) RoomPreviewData *roomPreviewData;
 
 /**
  Tell whether a badge must be added next to the chevron (back button) showing number of unread rooms.
@@ -86,5 +93,100 @@ extern NSNotificationName const RoomGroupCallTileTappedNotification;
 
 - (IBAction)scrollToBottomAction:(id)sender;
 
+/**
+ Creates and returns a new `RoomViewController` object.
+ 
+ @return An initialized `RoomViewController` object.
+ */
++ (instancetype)instantiate;
+
+@end
+
+/**
+ `RoomViewController` delegate.
+ */
+@protocol RoomViewControllerDelegate <NSObject>
+
+/**
+ Tells the delegate that the user wants to open the room details (members, files, settings).
+ 
+ @param roomViewController the `RoomViewController` instance.
+ */
+- (void)roomViewControllerShowRoomDetails:(RoomViewController *)roomViewController;
+
+/**
+ Tells the delegate that the user wants to display the details of a room member.
+ 
+ @param roomViewController the `RoomViewController` instance.
+ @param roomMember the selected member
+ */
+- (void)roomViewController:(RoomViewController *)roomViewController
+         showMemberDetails:(MXRoomMember *)roomMember;
+
+/**
+ Tells the delegate that the user wants to display another room.
+ 
+ @param roomViewController the `RoomViewController` instance.
+ @param roomID the selected roomId
+ */
+- (void)roomViewController:(RoomViewController *)roomViewController
+            showRoomWithId:(NSString *)roomID;
+
+/**
+ Tells the delegate that the user wants to start a direct chat with a user.
+ 
+ @param roomViewController the `RoomViewController` instance.
+ @param userId the selected user id
+ @param completion Blocks called when the chat is created.
+ */
+- (void)roomViewController:(RoomViewController *)roomViewController
+       startChatWithUserId:(NSString*)userId
+                completion:(void (^)(void))completion;
+
+/**
+ Tells the delegate that the user wants to show complete security screen.
+ 
+ @param roomViewController the `RoomViewController` instance.
+ @param session The selected Matrix session.
+ */
+- (void)roomViewController:(RoomViewController *)roomViewController showCompleteSecurityForSession:(MXSession*)session;
+
+/**
+ Tells the delegate that the user left the room.
+ 
+ @param roomViewController the `RoomViewController` instance.
+ */
+- (void)roomViewControllerDidLeaveRoom:(RoomViewController *)roomViewController;
+
+/**
+ Tells the delegate that the user wants to cancel the room preview.
+ 
+ @param roomViewController the `RoomViewController` instance.
+ */
+- (void)roomViewControllerPreviewDidTapCancel:(RoomViewController *)roomViewController;
+
+/**
+ Handle the fragment of a universal link.
+ 
+ @param roomViewController the `RoomViewController` instance.
+ @param fragment the fragment part of the universal link.
+ @param universalLinkURL the unprocessed the universal link URL (optional).
+ @return true to indicate that the fragment has been handled, or false when the fragment is not supported.
+ */
+- (BOOL)roomViewController:(RoomViewController *)roomViewController
+handleUniversalLinkFragment:(NSString*)fragment
+                   fromURL:(nullable NSURL*)universalLinkURL;
+
+/**
+ Process universal link.
+
+ @param roomViewController the `RoomViewController` instance.
+ @param universalLinkURL the universal link URL.
+ @return YES in case of processing success.
+ */
+- (BOOL)roomViewController:(RoomViewController *)roomViewController
+    handleUniversalLinkURL:(NSURL*)universalLinkURL;
+
 @end
 
+NS_ASSUME_NONNULL_END