ESTFeaturesetEstimoteMonitoring

@interface ESTFeaturesetEstimoteMonitoring : NSObject

ESTFeaturesetEstimoteMonitoring encapsulates operations required for Estimote Monitoring’s functionality. The algorithm relies on Estimote Location being advertised, and this helper tool ensures that the settings are set properly.

  • Designated initializer.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDevice:
        (nonnull ESTDeviceLocationBeacon *)device;

    Swift

    init(device: ESTDeviceLocationBeacon)

    Parameters

    device

    Next Gen device the settings are to be applied to.

  • Perform read operations for settings related to Estimote Monitoring, decide whether they satisfy prerequisites for Estimote Monitoring and call completion when all are done.

    @discussion If all underlying operations succeed, completion‘s featuresetEnabled tells whether Estimote Monitoring prerequisites are met, errors is nil.

    If any of underlying operation fails, completion’s featuresetEnabled is set to NO, and errors array contains errors resulting from failed operations.

    Declaration

    Objective-C

    - (void)readSettingsWithCompletion:
        (nonnull void (^)(BOOL, NSArray<NSError *> *_Nullable))completion;

    Swift

    func readSettings(completion: @escaping (Bool, [Error]?) -> Void)

    Parameters

    completion

    Completion block invoked after all operations are done (either successfully or not).

  • Write Estimote Monitoring values for settings related to EM algorithms. Call completion when all setting operations are done.

    @discussion If all underlying operations succeed, completion‘s errors is nil.

    If any of underlying operation fails, completion’s errors array contains errors resulting from failed operations.

    Declaration

    Objective-C

    - (void)writeEnableSettings:(BOOL)enabled
                 withCompletion:
                     (nonnull void (^)(NSArray<NSError *> *_Nullable))completion;

    Swift

    func writeEnableSettings(_ enabled: Bool, withCompletion completion: @escaping ([Error]?) -> Void)

    Parameters

    completion

    Completion block invoked after all operations are done (either successfully or not).

  • Settings written when executing this featureset.

    Declaration

    Objective-C

    + (nonnull NSDictionary<NSString *, ESTSettingBase *> *)classNamesToSettings;

    Swift

    class func classNamesToSettings() -> [String : ESTSettingBase]

    Return Value

    Dictionary with setting class names as keys, setting objects as values.

  • Return an array containing write operations from given featureset

    Declaration

    Objective-C

    + (nonnull NSArray<id<ESTBeaconOperationProtocol>> *)getWriteOperations;

    Swift

    class func getWriteOperations() -> [ESTBeaconOperationProtocol]