ESTSettingPowerFlipToSleepEnable

@interface ESTSettingPowerFlipToSleepEnable : ESTSettingReadWrite <NSCopying>

ESTSettingPowerFlipToSleepEnable represents FlipToSleepEnable value.

  • Designated initializer. Validates provided value internally with +validationErrorForValue:.

    See

    +[ESTSettingPowerFlipToSleepEnable validationErrorForValue:]

    Declaration

    Objective-C

    - (nonnull instancetype)initWithValue:(BOOL)enabled;

    Swift

    init(value enabled: Bool)

    Parameters

    enabled

    FlipToSleepEnable value.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of FlipToSleepEnable setting.

    Declaration

    Objective-C

    - (BOOL)getValue;

    Swift

    func getValue() -> Bool

    Return Value

    FlipToSleepEnable value.

  • Method allows to read value of initialized FlipToSleepEnable setting object.

    Declaration

    Objective-C

    - (void)readValueWithCompletion:
    (nonnull ESTSettingPowerFlipToSleepEnableCompletionBlock)completion;

    Swift

    func readValue(completion: @escaping ESTSettingPowerFlipToSleepEnableCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

  • Method allows to create write operation from already initialized DeviceInfo FlipToSleepEnable setting object. Value provided during initialization will be used as a desired value.

    Declaration

    Objective-C

    - (void)writeValue:(BOOL)enabled
        completion:
            (nonnull ESTSettingPowerFlipToSleepEnableCompletionBlock)completion;

    Swift

    func writeValue(_ enabled: Bool, completion: @escaping ESTSettingPowerFlipToSleepEnableCompletionBlock)

    Parameters

    enabled

    FlipToSleepEnable value to be written to the device.
    completion

    Block to be invoked when operation is complete.

  • Method checks if provided value is allowed. Returns nil if validation passes.

    Declaration

    Objective-C

    + (NSError *_Nullable)validationErrorForValue:(BOOL)enabled;

    Swift

    class func validationError(forValue enabled: Bool) -> Error?

    Parameters

    enabled

    FlipToSleepEnable value.

    Return Value

    Error object describing why validation failed. Nil if validation passes.