ESTTrigger

Deprecated

Deprecated since 4.31.0.


@interface ESTTrigger : NSObject

The ESTTrigger class defines the trigger object that is a part of Estimote Trigger Engine. Trigger allows to create real life situation definition based on particular set of rules. Trigger should be passed to <ESTTriggerManager> class object to start monitoring for its state changes.

  • Set of rules that should be fulfilled to change trigger state to YES. In all other cases state value is NO.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<ESTRule *> *_Nonnull rules;

    Swift

    var rules: [ESTRule] { get }
  • Unique trigger identifier allows to reference particular object.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull identifier;

    Swift

    var identifier: String { get }
  • State of trigger. Its value is YES when all defined rules are fulfilled.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly) BOOL state;

    Swift

    var state: Bool { get }
  • Initialization method that allows to create trigger obejct.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRules:(nonnull NSArray<ESTRule *> *)rules
                               identifier:(nonnull NSString *)identifier;

    Swift

    init(rules: [ESTRule], identifier: String)

    Parameters

    rules

    Array of <ESTRule> rule objects

    identifier

    Unique identifier of trigger

    Return Value

    create trigger object