ESTSettingEddystoneUIDInterval

@interface ESTSettingEddystoneUIDInterval : ESTSettingReadWrite <NSCopying>

ESTSettingEddystoneUIDInterval represents Eddystone UID AdvertisingInterval value.

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

    See

    +[ESTSettingEddystoneUIDInterval validationErrorForValue:]

    Declaration

    Objective-C

    - (instancetype _Nullable)initWithValue:(unsigned short)advertisingInterval;

    Swift

    init?(value advertisingInterval: UInt16)

    Parameters

    advertisingInterval

    Eddystone UID AdvertisingInterval value in ms. It should be between 100 and 2000.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of Eddystone UID AdvertisingInterval setting in ms.

    Declaration

    Objective-C

    - (unsigned short)getValue;

    Swift

    func getValue() -> UInt16

    Return Value

    Eddystone UID AdvertisingInterval value.

  • Method allows to read value of initialized Eddystone UID AdvertisingInterval setting object.

    Declaration

    Objective-C

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

    Swift

    func readValue(completion: @escaping ESTSettingEddystoneUIDIntervalCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

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

    Declaration

    Objective-C

    - (void)writeValue:(unsigned short)advertisingInterval
        completion:
            (nonnull ESTSettingEddystoneUIDIntervalCompletionBlock)completion;

    Swift

    func writeValue(_ advertisingInterval: UInt16, completion: @escaping ESTSettingEddystoneUIDIntervalCompletionBlock)

    Parameters

    advertisingInterval

    AdvertisingInterval value in ms to be written to the device. It should be between 100 and 2000.
    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.