ESTSettingGPIONotificationEnable
@interface ESTSettingGPIONotificationEnable : ESTSettingReadWrite <NSCopying>
ESTSettingGPIONotificationEnable represents GPIO NotificationEnable value.
-
Designated initializer. Validates provided value internally with +validationErrorForValue:.
See
+[ESTSettingGPIONotificationEnable validationErrorForValue:]
Declaration
Objective-C
- (nonnull instancetype)initWithValue:(BOOL)enabled;
Swift
init(value enabled: Bool)
Parameters
enabled
GPIO NotificationEnable value.
Return Value
Initialized object. Nil if validation fails.
-
Returns current value of GPIO NotificationEnable setting.
Declaration
Objective-C
- (BOOL)getValue;
Swift
func getValue() -> Bool
Return Value
GPIO NotificationEnable value.
-
Method allows to read value of initialized GPIO NotificationEnable setting object.
Declaration
Objective-C
- (void)readValueWithCompletion: (nonnull ESTSettingGPIONotificationEnableCompletionBlock)completion;
Swift
func readValue(completion: @escaping ESTSettingGPIONotificationEnableCompletionBlock)
Parameters
completion
Block to be invoked when operation is complete.
-
Method allows to create write operation from already initialized GPIO NotificationEnable setting object. Value provided during initialization will be used as a desired value.
Declaration
Objective-C
- (void)writeValue:(BOOL)enabled completion: (nonnull ESTSettingGPIONotificationEnableCompletionBlock)completion;
Swift
func writeValue(_ enabled: Bool, completion: @escaping ESTSettingGPIONotificationEnableCompletionBlock)
Parameters
enabled
NotificationEnable 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
NotificationEnable value.
Return Value
Error object describing why validation failed. Nil if validation passes.