//
//   ______     _   _                 _          _____ _____  _  __
//  |  ____|   | | (_)               | |        / ____|  __ \| |/ /
//  | |__   ___| |_ _ _ __ ___   ___ | |_ ___  | (___ | |  | | ' /
//  |  __| / __| __| | '_ ` _ \ / _ \| __/ _ \  \___ \| |  | |  <
//  | |____\__ \ |_| | | | | | | (_) | ||  __/  ____) | |__| | . \
//  |______|___/\__|_|_| |_| |_|\___/ \__\___| |_____/|_____/|_|\_\
//
//
//  Copyright © 2016 Estimote. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "ESTLocationBeaconBulkUpdateConfiguration.h"

#define ESTLocationBeaconBulkUpdaterErrorDomain @"ESTLocationBeaconBulkUpdaterErrorDomain"

/**
 *  Defines types of errors that can occur inside the bulk updater mechanis.
 */
typedef NS_ENUM(NSInteger, ESTLocationBeaconBulkUpdaterError)
{
    /**
     *  Device passed as a part of bulk update was not in range.
     */
    ESTLocationBeaconBulkUpdaterErrorDeviceDiscoveryFailed
};

/**
 *  Defines the possible statuses of the whole bulk updater mechanism.
 */
typedef NS_ENUM(NSInteger, ESTBulkUpdaterStatus)
{
    /**
     * Bulk updater is ready to `startWithUpdateConfigurations:`.
     */
    ESTBulkUpdaterStatusIdle = 0,
    
    /**
     *  Bulk updater is performing bulk update actions. Cancel bulk before using `startWithUpdateConfigurations:` again.
     */
    ESTBulkUpdaterStatusRunning
};

/**
 *  Possible update statuses of a device contained in `ESTLocationBeaconBulkUpdateConfiguration`.
 */
typedef NS_ENUM(NSInteger, ESTBulkUpdaterDeviceUpdateStatus)
{
    /**
     * Not able to determine current update status.
     */
    ESTBulkUpdaterDeviceUpdateStatusUnknown,
    /**
     * Device not detected yet. Scanning in progress.
     */
    ESTBulkUpdaterDeviceUpdateStatusScanning,
    /**
     * Device detected. Waiting to connect and update settings.
     */
    ESTBulkUpdaterDeviceUpdateStatusPendingUpdate,
    /**
     * Device is beeing connected to and updated.
     */
    ESTBulkUpdaterDeviceUpdateStatusUpdating,
    /**
     * Device update succeeded.
     */
    ESTBulkUpdaterDeviceUpdateStatusSucceeded,
    /**
     * Device update failed.
     */
    ESTBulkUpdaterDeviceUpdateStatusFailed
};

@class ESTLocationBeaconBulkUpdater;

/**
 * `ESTLocationBeaconBulkUpdaterDelegate` protocol defines a list of delegate methods that bulk update will use to inform about its progress.
 */
@protocol ESTLocationBeaconBulkUpdaterDelegate <NSObject>

@optional

/**
 *  Informs bulkUpdater delegate about a change of status for certain device.
 *
 *  @param bulkUpdater Bulk updater that passes the status change information.
 *
 *  @param updateStatus New update status of a device.
 *
 *  @param deviceIdentifier Identifier of a device for which the update status was changed.
 */
- (void)bulkUpdater:(ESTLocationBeaconBulkUpdater *)bulkUpdater didUpdateStatus:(ESTBulkUpdaterDeviceUpdateStatus)updateStatus forDeviceWithIdentifier:(NSString *)deviceIdentifier;

/**
 *  Informs bulkUpdater delegate about successful end of bulk update procedure.
 *
 *  @param bulkUpdater Bulk updater that processed all `updateConfigurations`.
 */
- (void)bulkUpdaterDidFinish:(ESTLocationBeaconBulkUpdater *)bulkUpdater;

/**
 *  Informs bulkUpdater delegate about bulk update failure.
 *
 *  @param bulkUpdater Bulk updater that failed to process all `updateConfigurations`.
 *
 *  @param error Error containing helpful information about the failure.
 */
- (void)bulkUpdater:(ESTLocationBeaconBulkUpdater *)bulkUpdater didFailWithError:(NSError *)error;

@end

/**
 * Class that can be used to perform bulk updates on new generation Estimote beacons. 
 * To start bulk update you need to prepare an array of `ESTLocationBeaconBulkUpdateConfiguration` objects
 * containing a device identifier and an array of `ESTSettingOperation` objects that will be initialized with
 * `ESTSettingReadWrite' subclass objects designed for specific settings.
 */

@interface ESTLocationBeaconBulkUpdater : NSObject

/**
 *  Delegate object that conforms to `ESTLocationBeaconBulkUpdaterDelegate` protocol.
 */
@property (nonatomic, weak) id<ESTLocationBeaconBulkUpdaterDelegate> delegate;

/**
 *  Timeout for bulk update procedure in seconds. 0 means no timeout.
 */
@property (nonatomic, assign) NSTimeInterval timeout;

/**
 *  Informs about the current status of bulk updater.
 */
@property (nonatomic, assign, readonly) ESTBulkUpdaterStatus status;

/**
 *  Array of `ESTLocationBeaconBulkUpdateConfiguration` objects that were passed to bulk updater.
 */
@property (nonatomic, strong, readonly) NSArray <ESTLocationBeaconBulkUpdateConfiguration *> *updateConfigurations;

/**
 *  Starts `ESTLocationBeaconBulkUpdater` with current pending settings from Estimote Cloud.
 */
- (void)startCloudUpdate;

/**
 * Starts the bulk update procedure.
 * This method will not cause anything if bulk updater is currently performing updates.
 *
 * @see status
 *
 * @param updateConfigurations Array of `ESTLocationBeaconBulkUpdateConfiguration` objects.
 */
- (void)startWithUpdateConfigurations:(NSArray <ESTLocationBeaconBulkUpdateConfiguration *> *)updateConfigurations;

/**
 * Cancels the bulk update procedure.
 * Note that, if update for a certain device has already started it might not be canceled.
 */
- (void)cancel;

/**
 * Informs about the update status for a given device identifier.
 *
 * @param deviceIdentifier Identifier of a device.
 *
 * @return `ESTBulkUpdaterUpdateStatus` value, informing about the current update status.
 */
- (ESTBulkUpdaterDeviceUpdateStatus)statusForDeviceWithIdentifier:(NSString *)deviceIdentifier;

@end