ESTSettingEstimoteTLMPower

@interface ESTSettingEstimoteTLMPower : ESTSettingReadWrite <NSCopying>

ESTSettingEstimoteTLMPower represents Estimote Telemetry Power value.

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

    See

    +[ESTSettingEstimoteTLMPower validationErrorForValue:]

    Declaration

    Objective-C

    - (instancetype _Nullable)initWithValue:(ESTEstimoteTLMPower)power;

    Swift

    init?(value power: ESTEstimoteTLMPower)

    Parameters

    power

    Estimote Telemetry Power value.

    Return Value

    Initialized object. Returns nil if validation fails.

  • Returns current value of Estimote Telemetry Power setting.

    Declaration

    Objective-C

    - (ESTEstimoteTLMPower)getValue;

    Swift

    func getValue() -> ESTEstimoteTLMPower

    Return Value

    Estimote Telemetry Power value.

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

    Declaration

    Objective-C

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

    Swift

    func readValue(completion: @escaping ESTSettingEstimoteTLMPowerCompletionBlock)

    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 Power setting object. Value provided during initialization will be used as a desired value.

    Declaration

    Objective-C

    - (void)writeValue:(ESTEstimoteTLMPower)power
            completion:
                (nonnull ESTSettingEstimoteTLMPowerCompletionBlock)completion;

    Swift

    func writeValue(_ power: ESTEstimoteTLMPower, completion: @escaping ESTSettingEstimoteTLMPowerCompletionBlock)

    Parameters

    power

    Power 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:(ESTEstimoteTLMPower)power;

    Swift

    class func validationError(forValue power: ESTEstimoteTLMPower) -> Error?

    Parameters

    power

    Power value.

    Return Value

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