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

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

@class ESTSettingPowerFlipToSleepEnable;

NS_ASSUME_NONNULL_BEGIN

/**
 *  Block used as a result of read/write setting FlipToSleepEnable operation for Power group.
 *
 *  @param enabled FlipToSleepEnable setting carrying value.
 *  @param error Operation error. No error means success.
 */
typedef void(^ESTSettingPowerFlipToSleepEnableCompletionBlock)(ESTSettingPowerFlipToSleepEnable * _Nullable enabledSetting, NSError * _Nullable error);


/**
 *  ESTSettingPowerFlipToSleepEnable represents FlipToSleepEnable value.
 */
@interface ESTSettingPowerFlipToSleepEnable : ESTSettingReadWrite <NSCopying>

/**
 *  Designated initializer. Validates provided value internally with +validationErrorForValue:.
 *
 *  @see +[ESTSettingPowerFlipToSleepEnable validationErrorForValue:]
 *
 *  @param enabled FlipToSleepEnable value.
 *
 *  @return Initialized object. Nil if validation fails.
 */
- (instancetype)initWithValue:(BOOL)enabled;

/**
 *  Returns current value of FlipToSleepEnable setting.
 *
 *  @return FlipToSleepEnable value.
 */
- (BOOL)getValue;

/**
 *  Method allows to read value of initialized FlipToSleepEnable setting object.
 *
 *  @param completion Block to be invoked when operation is complete.
 *
 *  @return Initialized operation object.
 */
- (void)readValueWithCompletion:(ESTSettingPowerFlipToSleepEnableCompletionBlock)completion;

/**
 *  Method allows to create write operation from already initialized DeviceInfo FlipToSleepEnable setting object.
 *  Value provided during initialization will be used as a desired value.
 *
 *  @param enabled FlipToSleepEnable value to be written to the device.
 *  @param completion Block to be invoked when operation is complete.
 *
 *  @return Initialized operation object.
 */
- (void)writeValue:(BOOL)enabled completion:(ESTSettingPowerFlipToSleepEnableCompletionBlock)completion;

/**
 *  Method checks if provided value is allowed. Returns nil if validation passes.
 *
 *  @param enabled FlipToSleepEnable value.
 *
 *  @return Error object describing why validation failed. Nil if validation passes.
 */
+ (NSError * _Nullable)validationErrorForValue:(BOOL)enabled;

@end

NS_ASSUME_NONNULL_END