/*
Copyright 2024 New Vector Ltd.
Copyright 2020 Vector Creations Ltd
Copyright 2014 OpenMarket Ltd

SPDX-License-Identifier: AGPL-3.0-only
Please see LICENSE in the repository root for full details.
 */

#import <UIKit/UIKit.h>
#import <Foundation/Foundation.h>
#import <UserNotifications/UserNotifications.h>

@class MXSession;
@class MXEvent;
@class MXPushRule;
@class MXKAccount;
@class PushNotificationStore;
@protocol PushNotificationServiceDelegate;

NS_ASSUME_NONNULL_BEGIN

@interface PushNotificationService : NSObject <UNUserNotificationCenterDelegate>

- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;

/// Designated initializer
/// @param pushNotificationStore Push Notification Store instance
- (instancetype)initWithPushNotificationStore:(PushNotificationStore *)pushNotificationStore;

/**
 Is push really registered.
 */
@property (nonatomic, assign, readonly) BOOL isPushRegistered;

/**
 Delegate object.
 */
@property (nonatomic, weak) id<PushNotificationServiceDelegate> delegate;

/**
 Perform registration for user notification settings.
 */
- (void)registerUserNotificationSettings;

/**
 Perform registration for remote notifications.

 @param completion the block to be executed when registration finished.
 */
- (void)registerForRemoteNotificationsWithCompletion:(nullable void (^)(NSError *))completion;

- (void)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken;

- (void)didFailToRegisterForRemoteNotificationsWithError:(NSError *)error;

- (void)didReceiveRemoteNotification:(NSDictionary *)userInfo
              fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler;

/**
 Perform deregistration for remote notifications.
 */
- (void)deregisterRemoteNotifications;

/// Method to be called when the application resigns active..
- (void)applicationWillResignActive;

/// Method to be called when the application enters background..
- (void)applicationDidEnterBackground;

/// Method to be called when the application becomes active.
- (void)applicationDidBecomeActive;

/**
 Make sure the account has no more PushKit pusher.
 
 @param session The session on this account.
 */
- (void)checkPushKitPushersInSession:(MXSession*)session;


/**
 Remove delivered notifications for a given room id except call notifications

 @param roomId Room identifier
 @param completion Completion to be called when operation finished.
 */
- (void)removeDeliveredNotificationsWithRoomId:(NSString*)roomId completion:(nullable void (^)(void))completion;

@end


@protocol PushNotificationServiceDelegate <NSObject>

@optional

/**
 Will be called when the user interacts with a notification, which will be led the user to navigate to a specific room.

 @param pushNotificationService PushNotificationService object.
 @param roomId Room identifier to be navigated.
 @param userId ID of sender of the notification.
 */
- (void)pushNotificationService:(PushNotificationService *)pushNotificationService
     shouldNavigateToRoomWithId:(NSString *)roomId
                       threadId:(nullable NSString *)threadId
                         sender:(nullable NSString *)userId;

@end;

NS_ASSUME_NONNULL_END