ESTSettingEstimoteTLMInterval

@interface ESTSettingEstimoteTLMInterval : ESTSettingReadWrite <NSCopying>

ESTSettingEstimoteTLMInterval represents Estimote Telemetry Advertising Interval value.

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

    See

    +[ESTSettingEstimoteTLMInterval validationErrorForValue:]

    Declaration

    Objective-C

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

    Swift

    init?(value advertisingInterval: UInt16)

    Parameters

    advertisingInterval

    Estimote Telemetry Advertising Interval value.

    Return Value

    Initialized object. Nil if validation fails.

  • Returns current value of Estimote Telemetry Advertising Interval setting.

    Declaration

    Objective-C

    - (unsigned short)getValue;

    Swift

    func getValue() -> UInt16

    Return Value

    Estimote Telemetry AdvertisingInterval value.

  • Method allows to read value of initialized Estimote Telemetry Advertising Interval setting object.

    Declaration

    Objective-C

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

    Swift

    func readValue(completion: @escaping ESTSettingEstimoteTLMIntervalCompletionBlock)

    Parameters

    completion

    Block to be invoked when operation is complete.

    Return Value

    Initialized operation object.

  • Method allows to create write operation from already initialized Estimote Telemetry 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 ESTSettingEstimoteTLMIntervalCompletionBlock)completion;

    Swift

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

    Parameters

    advertisingInterval

    AdvertisingInterval value to be written to the device.

    completion

    Block to be invoked when operation is complete.

    Return Value

    Initialized operation object.

  • 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

    Advertising Interval value.

    Return Value

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