mirror of
https://github.com/vector-im/element-ios.git
synced 2024-09-29 07:42:40 +00:00
112 lines
4.8 KiB
Objective-C
112 lines
4.8 KiB
Objective-C
//
|
|
// Copyright 2022 New Vector Ltd
|
|
//
|
|
// 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.
|
|
//
|
|
|
|
#ifndef SplitViewMasterViewControllerProtocol_h
|
|
#define SplitViewMasterViewControllerProtocol_h
|
|
|
|
@class RoomNavigationParameters;
|
|
@class RoomPreviewNavigationParameters;
|
|
@class ScreenPresentationParameters;
|
|
@class OnboardingCoordinatorBridgePresenter;
|
|
|
|
@protocol SplitViewMasterTabBarViewControllerProtocol <NSObject>
|
|
|
|
/// Refresh the missed conversations badges on tab bar icon
|
|
- (void)refreshTabBarBadges;
|
|
|
|
/// Emulated `UITabBarViewController.selectedViewController` property
|
|
@property (nonatomic, readonly, nullable) UIViewController *selectedViewController;
|
|
|
|
/// Emulated `UITabBarViewController.tabBar` property
|
|
@property (nonatomic, readonly, nullable) UITabBar *tabBar;
|
|
|
|
@end
|
|
|
|
/// `SplitViewMasterViewControllerProtocol` describe the methods and properties needed by
|
|
@protocol SplitViewMasterViewControllerProtocol <SplitViewMasterTabBarViewControllerProtocol>
|
|
|
|
/// Display the default onboarding flow.
|
|
- (void)showOnboardingFlow;
|
|
|
|
/// Display the onboarding flow configured to log back into a soft logout session.
|
|
///
|
|
/// @param softLogoutCredentials the credentials of the soft logout session.
|
|
- (void)showSoftLogoutOnboardingFlowWithCredentials:(MXCredentials*)softLogoutCredentials;
|
|
|
|
/// Open the room with the provided identifier in a specific matrix session.
|
|
///
|
|
/// @param parameters the presentation parameters that contains room information plus display information.
|
|
/// @param completion the block to execute at the end of the operation.
|
|
- (void)selectRoomWithParameters:(RoomNavigationParameters*)parameters completion:(void (^)(void))completion;
|
|
|
|
/// Open the RoomViewController to display the preview of a room that is unknown for the user.
|
|
/// This room can come from an email invitation link or a simple link to a room.
|
|
///
|
|
/// @param parameters the presentation parameters that contains room preview information plus display information.
|
|
/// @param completion the block to execute at the end of the operation.
|
|
- (void)selectRoomPreviewWithParameters:(RoomPreviewNavigationParameters*)parameters completion:(void (^)(void))completion;
|
|
|
|
/// Open a ContactDetailsViewController to display the information of the provided contact.
|
|
///
|
|
/// @param contact contact to be displayed
|
|
- (void)selectContact:(MXKContact*)contact;
|
|
|
|
/// Open a ContactDetailsViewController to display the information of the provided contact according to the presentation parameters.
|
|
///
|
|
/// @param contact contact to be displayed
|
|
/// @param presentationParameters the presentation parameters that contains room preview information plus display information.
|
|
- (void)selectContact:(MXKContact*)contact withPresentationParameters:(ScreenPresentationParameters*)presentationParameters;
|
|
|
|
/// Release the current selected item (if any).
|
|
- (void)releaseSelectedItem;
|
|
|
|
/// The current number of rooms with missed notifications, including the invites.
|
|
- (NSUInteger)missedDiscussionsCount;
|
|
|
|
/// The current number of rooms with unread highlighted messages.
|
|
- (NSUInteger)missedHighlightDiscussionsCount;
|
|
|
|
/// Verify the current device if needed.
|
|
///
|
|
/// @param session the matrix session.
|
|
- (void)presentVerifyCurrentSessionAlertIfNeededWithSession:(MXSession*)session;
|
|
|
|
/// Verify others device if needed.
|
|
///
|
|
/// @param session the matrix session.
|
|
- (void)presentReviewUnverifiedSessionsAlertIfNeededWithSession:(MXSession*)session;
|
|
|
|
/// Reference to the current onboarding flow. It is always nil unless the flow is being presented.
|
|
@property (nonatomic, readonly) OnboardingCoordinatorBridgePresenter *onboardingCoordinatorBridgePresenter;
|
|
|
|
/// Reference on the currently selected room
|
|
@property (nonatomic, readonly) NSString *selectedRoomId;
|
|
/// Reference on the currently selected event
|
|
@property (nonatomic, readonly) NSString *selectedEventId;
|
|
/// Reference on the currently selected room session
|
|
@property (nonatomic, readonly) MXSession *selectedRoomSession;
|
|
/// Reference on the currently selected room preview data
|
|
@property (nonatomic, readonly) RoomPreviewData *selectedRoomPreviewData;
|
|
|
|
/// Reference on the currently selected contact
|
|
@property (nonatomic, readonly) MXKContact *selectedContact;
|
|
|
|
/// `true` while the onboarding flow is displayed
|
|
@property (nonatomic, readonly) BOOL isOnboardingInProgress;
|
|
|
|
@end
|
|
|
|
#endif /* SplitViewMasterViewControllerProtocol_h */
|