ESTNearableRule
Deprecated
Deprecated since 4.31.0.
@interface ESTNearableRule : ESTRule
The ESTNearableRule
is abstract class defining base methods for all Estimote nearable related rules. It should not be used itself as it is not
defining any conditions.
-
Identifier of nearable that is going to be associated with this rule.
Declaration
Objective-C
@property (nonatomic, strong, readonly) NSString *_Nullable nearableIdentifier;
Swift
var nearableIdentifier: String? { get }
-
Type of nearable that is going to be associated with this rule.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readonly) ESTNearableType nearableType;
Swift
var nearableType: ESTNearableType { get }
-
Initialization method creating rule based on specific Estimote nearable identifier.
Declaration
Objective-C
- (nonnull instancetype)initWithNearableIdentifier: (nonnull NSString *)identifier;
Swift
init(nearableIdentifier identifier: String)
Parameters
identifier
Estimote nearable identifier
Return Value
created rule object
-
Initialization method creating rule based on specific Estimote nearable type.
Declaration
Objective-C
- (nonnull instancetype)initWithNearableType:(ESTNearableType)type;
Swift
init(nearableType type: ESTNearableType)
Parameters
type
Estimote nearable type
Return Value
created rule object
-
Method that is invoked by trigger manager object to update state of the rule.
When creating custom nearable related rule, this method should be implemented to update state property of this class, based on passed nearable object. For not nearable related rules
update
method of<ESTRule>
should be used instead.Declaration
Objective-C
- (void)updateWithNearable:(nonnull ESTNearable *)nearable;
Swift
func update(with nearable: ESTNearable)
Parameters
nearable
Estimote nearable object with most recent settings