BLUBeaconEncryptionSettings Class Reference
Inherits from | NSObject |
---|---|
Conforms to | NSCopying NSSecureCoding |
Declared in | BLUBeaconEncryptionSettings.h |
Overview
BLUBeaconEncryptionSettings
objects represent the encryption settings of a beacon configuration.
Encryption settings control the encryption modes used for a beacon’s advertisements.
General properties
encryptionSyncMode
The beacon’s desired encryption time synchroization mode.
@property (nonatomic, assign) BLUBeaconEncryptionSyncMode encryptionSyncMode
Discussion
The beacon’s desired encryption time synchroization mode.
For security reasons a beacon’s sync mode can’t be read as part of its configuration.
See Also
Declared In
BLUBeaconEncryptionSettings.h
rotationInterval
The beacon’s desired rotation interval in seconds.
@property (nonatomic, assign) NSTimeInterval rotationInterval
Discussion
The beacon’s desired rotation interval in seconds.
If this value is set to 0 these settings will disable all advertisement encryption on beacons they are written to.
The minimum allowed rotation interval are 120 seconds. Lower values will be auto-corrected as they could cause a beacon to always rotate before a connection can be established - thereby rendering the beacon unconnectable.
Declared In
BLUBeaconEncryptionSettings.h
Advertisement type properties
sBeaconEncryptionSettings
The beacon’s desired sBeacon encryption settings.
@property (nonatomic, copy) BLUSBeaconEncryptionSettings *sBeaconEncryptionSettings
Discussion
The beacon’s desired sBeacon encryption settings.
See Also
Declared In
BLUBeaconEncryptionSettings.h
iBeaconEncryptionSettings
The beacon’s desired iBeacon encryption settings.
@property (nonatomic, copy) BLUIBeaconEncryptionSettings *iBeaconEncryptionSettings
Discussion
The beacon’s desired iBeacon encryption settings.
See Also
Declared In
BLUBeaconEncryptionSettings.h
Initialization
+ defaultEncryptionSettings
Initializes a BLUBeaconEncryptionSettings
instance with default values.
These settings can be added as part of a scheduled beacon configuration.
+ (instancetype)defaultEncryptionSettings
Return Value
Returns a newly initialized encryption settings instance with default values.
Discussion
Initializes a BLUBeaconEncryptionSettings
instance with default values.
These settings can be added as part of a scheduled beacon configuration.
The default settings are set to a time synchronization mode of BLUBeaconEncryptionSyncModeNone
, a time interval of
300 seconds and the default configurations of BLUSBeaconEncryptionSettings
and BLUIBeaconEncryptionSettings
.
Declared In
BLUBeaconEncryptionSettings.h
+ encryptionSettingsWithEncryptionSyncMode:rotationInterval:
Initializes a BLUBeaconEncryptionSettings
instance with the specified encryption time synchronization mode, rotation interval and
default sBeacon and iBeacon encryption settings.
These settings can be added as part of a scheduled beacon configuration.
+ (instancetype)encryptionSettingsWithEncryptionSyncMode:(BLUBeaconEncryptionSyncMode)encryptionSyncMode rotationInterval:(NSTimeInterval)rotationInterval
Parameters
encryptionSyncMode |
The time synchronization mode that shall be used for the beacon’s advertisement encryption. |
---|---|
rotationInterval |
The encryption’s rotation interval in seconds. |
Return Value
Returns a newly initialized encryption settings instance with the specified encryption time synchronization mode, rotation interval and default sBeacon and iBeacon encryption settings.
Discussion
Initializes a BLUBeaconEncryptionSettings
instance with the specified encryption time synchronization mode, rotation interval and
default sBeacon and iBeacon encryption settings.
These settings can be added as part of a scheduled beacon configuration.
The default settings are set to the default configurations of BLUSBeaconEncryptionSettings
and BLUIBeaconEncryptionSettings
.
Declared In
BLUBeaconEncryptionSettings.h