ESTBeaconUpdateInfo
Deprecated
Deprecated since 4.31.0.
@interface ESTBeaconUpdateInfo : NSObject <NSCoding>
The ESBeaconUpdateInfo
class represents all required data for single Estimote beacon bulk update operation. It should be intialized by device Mac Address that should be updated and <ESBeaconUpdateConfig>
config object that describes how update is going to be performed.
-
Delegate object described with
ESBeaconUpdateInfoDelegate
protocol.Declaration
Objective-C
@property (nonatomic, weak, readwrite) id<ESBeaconUpdateInfoDelegate> _Nullable delegate;
Swift
weak var delegate: ESBeaconUpdateInfoDelegate? { get set }
-
Beacon about which this info is for.
Declaration
Objective-C
@property (nonatomic, strong, readwrite) ESTBeaconConnection *_Nonnull beaconConnection;
Swift
var beaconConnection: ESTBeaconConnection { get set }
-
Device mac address about which this info is for.
Declaration
Objective-C
@property (nonatomic, strong, readwrite) NSString *_Nonnull macAddress;
Swift
var macAddress: String { get set }
-
Configuration based on which update should be performed.
Declaration
Objective-C
@property (nonatomic, strong, readwrite) ESTBeaconUpdateConfig *_Nonnull config;
Swift
var config: ESTBeaconUpdateConfig { get set }
-
Current status of beacon update.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite) ESBeaconUpdateInfoStatus status;
Swift
var status: ESBeaconUpdateInfoStatus { get set }
-
Settings creation timestamp.
Declaration
Objective-C
@property (nonatomic, strong, readwrite) NSDate *_Nullable createdAt;
Swift
var createdAt: Date? { get set }
-
Time when settings were applied to the device.
Declaration
Objective-C
@property (nonatomic, strong, readwrite) NSDate *_Nullable syncedAt;
Swift
var syncedAt: Date? { get set }
-
Error object if beacon failed to update.
Declaration
Objective-C
@property (nonatomic, strong, readwrite) NSError *_Nullable error;
Swift
var error: Error? { get set }
-
Initialize object with beacon that is going to be (or was) updated and proper config file containing description how update should be performed.
Declaration
Objective-C
- (nonnull instancetype)initWithMacAddress:(nonnull NSString *)macAddress config: (nonnull ESTBeaconUpdateConfig *)config;
Swift
convenience init(macAddress: String, config: ESTBeaconUpdateConfig)
Parameters
macAddress
Mac Address of beacon.
config
Config description for update.
Return Value
initialized instance of this class
-
Initialize object with beacon that is going to be (or was) updated and proper config file containing description how update should be performed with delegate object.
Declaration
Objective-C
- (nonnull instancetype) initWithMacAddress:(nonnull NSString *)macAddress config:(nonnull ESTBeaconUpdateConfig *)config delegate:(id<ESBeaconUpdateInfoDelegate> _Nullable)delegate;
Swift
init(macAddress: String, config: ESTBeaconUpdateConfig, delegate: ESBeaconUpdateInfoDelegate?)
Parameters
macAddress
Mac Address of beacon.
config
Config description for update.
delegate
Delegate to receive events.
Return Value
initialized instance of this class
-
Scans for peripheral related with the beacon.
Declaration
Objective-C
- (void)findPeripheralWithTimeout:(NSTimeInterval)timeout;
Swift
func findPeripheral(withTimeout timeout: TimeInterval)
-
Allows to update config for the related beacon. Overrides previous settings.
Declaration
Objective-C
- (void)updateWithConfig:(nonnull ESTBeaconUpdateConfig *)config;
Swift
func update(with config: ESTBeaconUpdateConfig)
Parameters
config
new config object
-
Custom description method of Beacon update information.
Declaration
Objective-C
- (nonnull NSString *)description;
Swift
func description() -> String
Return Value
description string