ESTSettingEstimoteLocationInterval
@interface ESTSettingEstimoteLocationInterval : ESTSettingReadWrite <NSCopying>
ESTSettingEstimoteLocationInterval represents Estimote Location Advertising Interval value.
-
Designated initializer. Validates provided value internally with +validationErrorForValue:.
See
+[ESTSettingEstimoteLocationInterval validationErrorForValue:]
Declaration
Objective-C
- (instancetype _Nullable)initWithValue:(unsigned short)advertisingInterval;
Swift
init?(value advertisingInterval: UInt16)
Parameters
advertisingInterval
Estimote Location Advertising Interval value.
Return Value
Initialized object. Nil if validation fails.
-
Returns current value of Estimote Location Advertising Interval setting.
Declaration
Objective-C
- (unsigned short)getValue;
Swift
func getValue() -> UInt16
Return Value
Estimote Location Advertising Interval value.
-
Method allows to read value of initialized Estimote Location Advertising Interval setting object.
Declaration
Objective-C
- (void)readValueWithCompletion: (nonnull ESTSettingEstimoteLocationIntervalCompletionBlock)completion;
Swift
func readValue(completion: @escaping ESTSettingEstimoteLocationIntervalCompletionBlock)
Parameters
completion
Block to be invoked when operation is complete.
-
Method allows to create write operation from already initialized Estimote Location Advertising Interval setting object. Value provided during initialization will be used as a desired value.
Declaration
Objective-C
- (void)writeValue:(unsigned short)advertisingInterval completion:(nonnull ESTSettingEstimoteLocationIntervalCompletionBlock) completion;
Swift
func writeValue(_ advertisingInterval: UInt16, completion: @escaping ESTSettingEstimoteLocationIntervalCompletionBlock)
Parameters
advertisingInterval
Advertising Interval 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: (unsigned short)advertisingInterval;
Swift
class func validationError(forValue advertisingInterval: UInt16) -> Error?
Parameters
advertisingInterval
AdvertisingInterval value.
Return Value
Error object describing why validation failed. Nil if validation passes.