Classes

The following classes are available globally.

  • Deprecated

    Deprecated since 4.31.0.

    ESTAnalyticsManager class is responsible for registering analytics requests and events, triggered by ranging and monitoring CLBeaconRegion. Manager sends to Estimote Cloud up to 100 registered analytics events every 20 seconds.

    Warning

    Important: works only with iBeacon devices returned by ESTBeaconManager and `ESTSecureBeaconManager.
    See more

    Declaration

    Objective-C

    
@interface ESTAnalyticsManager : NSObject

    Swift

    class ESTAnalyticsManager : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    ESTSecureBeacon represents single Estimote Beacon broadcasting iBeacon packet with Secure UUID feature enabled. Provided Proximity UUID, Major and Minor values represent actual beacon values, not randomised ones. ESTSecureBeacon should not be created manually. Objects of this class are returning from ESTSecureBeaconManager class during ranging.

    See more

    Declaration

    Objective-C

    
@interface ESTBeacon : NSObject <NSCopying, NSSecureCoding>

    Swift

    class ESTBeacon : NSObject, NSCopying, NSSecureCoding

  • Deprecated

    Deprecated since 4.31.0.

    The ESTBeaconConnection class defines the interface for interacting with a single Estimote beacon. It enables you to connect to the device, retrieve properties and change its configuration settings.

    The ESTBeaconConnection instance can be initialized using CLBeacon object or mac address being unique identifier of particular device. Fetch required beacon details you can use:

    • startRangingBeaconsInRegion: - which is a CoreLocation based scan and delivers CLBeacon objects.

    • startEstimoteBeaconsDiscovery - which is a CoreBluetooth based scan and delivers ESTBluetoothBeacon object containing mac address.

    Properties become editable once connected to the beacon. See connect for more details about connecting to the beacon. You will also need to assign a delegate to be notified about connection and disconnection events. The delegate needs to conform to the <ESTBeaconConnectionDelegate> protocol.

    See more

    Declaration

    Objective-C

    
@interface ESTBeaconConnection : NSObject

    Swift

    class ESTBeaconConnection : NSObject

  • ESTDeviceSettingsManager allows to manager device settings interaction like writing to peripheral and saving to the Estimote Cloud.

    See more

    Declaration

    Objective-C

    @interface ESTBeaconSettingsManager : NSObject

    Swift

    class ESTBeaconSettingsManager : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    Object of this class contains all settings that should be applied to the Estimote beacon device. It’s used by ESTBulkUpdater class as a part of ESTBeaconUpdateInfo object.

    See more

    Declaration

    Objective-C

    
@interface ESTBeaconUpdateConfig : NSObject <NSCoding, NSCopying>

    Swift

    class ESTBeaconUpdateConfig : NSObject, NSCoding, NSCopying

  • Deprecated

    Deprecated since 4.31.0.

    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.

    See more

    Declaration

    Objective-C

    
@interface ESTBeaconUpdateInfo : NSObject <NSCoding>

    Swift

    class ESTBeaconUpdateInfo : NSObject, NSCoding

  • Deprecated

    Deprecated since 4.31.0.

    Main class of the bulk updater that performs all update operations handled by objects of <ESBulkUpdaterSingleOperation> class. Updates are performed in the concurent queue and can work both in foreground and background.

    To star bulk update you need to prepare array of <ESBeaconUpdateInfo> objects containg beacons and update configuration. Then just invoke startWithBeaconInfos:timeout: method of this class to start update procedure. This class defines notifications that can be used to get progress of update procedure state.

    See more

    Declaration

    Objective-C

    
@interface ESTBulkUpdater : NSObject

    Swift

    class ESTBulkUpdater : NSObject

  • Deprecated

    Starting from SDK 3.5.0 use ESTConfig class and particular requests (eg. ESTRequestGetBeacons) to interact with Estimote Cloud API.

    ESTCloudManager class is responsible for Estimote Cloud integration. It allows you to invoke available Estimote Cloud API methods using block pattern to handle result.

    See more

    Declaration

    Objective-C

    
@interface ESTCloudManager : NSObject

    Swift

    class ESTCloudManager : NSObject

  • ESTConfig is used to configure Estimote Cloud API. It allows to authorize app using AppID and AppToken and configure Estimote Analytics settings.

    See more

    Declaration

    Objective-C

    @interface ESTConfig : NSObject

    Swift

    class ESTConfig : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    The ESTDateRule class defines single rule related to time during the day.

    See more

    Declaration

    Objective-C

    
@interface ESTDateRule : ESTRule

    Swift

    class ESTDateRule : ESTRule

  • ESTDeviceConnectable is a superclass for connectable Estimote devices.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceConnectable : ESTDevice

    Swift

    class ESTDeviceConnectable : ESTDevice

  • This Value Object represents complete information about particular beacon or nearable device including status, settings and pending settings.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceDetails : ESTBaseVO

    Swift

    class ESTDeviceDetails : ESTBaseVO

  • Deprecated

    Deprecated since 4.31.0.

    Class defines scanning & filtering attributes required by ESTDeviceManager to discover iBeacon devices. Results in -[ESTDeviceManagerDelegate deviceManager:didDiscoverDevices:] being called with collection of ESTBluetoothBeacon objects.

    Note. For now, ESTDeviceManager cannot retrieve Proximity UUID of the scanned devices. To find a particular iBeacon device use -initWithIdentifier: (the identifier property is unique for Estimote devices).

    See

    -[ESTDeviceManager startDeviceDiscoveryWithFilter:].
    See more

    Declaration

    Objective-C

    
@interface ESTDeviceFilterBeaconV1 : NSObject <ESTDeviceFilter>

    Swift

    class ESTDeviceFilterBeaconV1 : NSObject, ESTDeviceFilter

  • Class defines scanning & filtering attributes required by ESTDeviceManager to discover devices that can be connected to. Results in -[ESTDeviceManagerDelegate deviceManager:didDiscoverDevices:] being called with a collection of ESTDeviceLocationBeacon objects.

    See

    -[ESTDeviceManager startDeviceDiscoveryWithFilter:].
    See more

    Declaration

    Objective-C

    @interface ESTDeviceFilterLocationBeacon : NSObject <ESTDeviceFilter>

    Swift

    class ESTDeviceFilterLocationBeacon : NSObject, ESTDeviceFilter

  • Class defines scanning & filtering attributes required by ESTDeviceManager to discover devices that can be connected to. Results in -[ESTDeviceManagerDelegate deviceManager:didDiscoverDevices:] being called with a collection of ESTDeviceNearable objects.

    See

    -[ESTDeviceManager startDeviceDiscoveryWithFilter:].
    See more

    Declaration

    Objective-C

    @interface ESTDeviceFilterNearable : NSObject <ESTDeviceFilter>

    Swift

    class ESTDeviceFilterNearable : NSObject, ESTDeviceFilter

  • This Value Object represents physical location of the device.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceGeoLocation : ESTBaseVO

    Swift

    class ESTDeviceGeoLocation : ESTBaseVO

  • This Value Object represents Indoor Location location the device is assigned to.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceIndoorLocation : ESTBaseVO

    Swift

    class ESTDeviceIndoorLocation : ESTBaseVO

  • ESTDeviceLocationBeacon represents Next Generation beacon device. It allows to to establish connection to the device and change its settings.

    Object of this class is returned as a result of ESTUtilityManager scanning. It is not intended to be initialized manually.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceLocationBeacon : ESTDeviceConnectable

    Swift

    class ESTDeviceLocationBeacon : ESTDeviceConnectable

  • The ESTDeviceManager class defines the interface for utility methods related to Estimote devices. The main functionality allows to discover CoreBluetooth based representation of Estimote Beacon devices.

    One device manager instance can discover devices only with one filter at a time.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceManager : NSObject

    Swift

    class ESTDeviceManager : NSObject

  • ESTDeviceNearable represents Nearable device. It allows to establish connection to the device and change its settings.

    Object of this class is returned as a result of ESTUtilityManager scanning. It is not intended to be initialized manually.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceNearable : ESTDeviceConnectable

    Swift

    class ESTDeviceNearable : ESTDeviceConnectable

  • This Value Object represents schedule for conditional advertising.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceSchedule : ESTBaseVO

    Swift

    class ESTDeviceSchedule : ESTBaseVO

  • This Value Object represents device settings fetched from the Estimote Cloud.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceSettings : ESTBaseVO <NSCopying>

    Swift

    class ESTDeviceSettings : ESTBaseVO, NSCopying

  • This Value Object represents settings structure for generic packet.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceSettingsAdvertiser : ESTBaseVO <NSCopying>

    Swift

    class ESTDeviceSettingsAdvertiser : ESTBaseVO, NSCopying

  • ESTDeviceSettingsCollection represents collection of device settings.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceSettingsCollection : NSObject <NSCopying>

    Swift

    class ESTDeviceSettingsCollection : NSObject, NSCopying

  • This Value Object represents device settings.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceSettingsGeneral : ESTBaseVO <NSCopying>

    Swift

    class ESTDeviceSettingsGeneral : ESTBaseVO, NSCopying

  • This Value Object represents Device shadow as a high level object representing particular context.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceShadow : ESTBaseVO

    Swift

    class ESTDeviceShadow : ESTBaseVO

  • This Value Object represents status report related to the device.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceStatusReport : ESTBaseVO

    Swift

    class ESTDeviceStatusReport : ESTBaseVO

  • This Value Object represents update of pending settings and firmware information for single device. Object is used by ESTRequestV2DevicesUpdate.

    See more

    Declaration

    Objective-C

    @interface ESTDeviceUpdateInfo : ESTBaseVO

    Swift

    class ESTDeviceUpdateInfo : ESTBaseVO

  • Deprecated

    Deprecated since 4.31.0.

    Object of this class represents single Eddystone device, with all its available properties. ESTEddystone object should not be created manually. Instances are created by ESTEddystoneManager with discovery process and return in eddystoneManager:didDiscoverEddystones:withFilter: delegate method.

    See more

    Declaration

    Objective-C

    
@interface ESTEddystone : NSObject <NSCopying>

    Swift

    class ESTEddystone : NSObject, NSCopying

  • Deprecated

    Deprecated since 4.31.0.

    ESTEddystoneAttachment class represents attachments from resolving EID.

    See more

    Declaration

    Objective-C

    
@interface ESTEddystoneAttachment : NSObject <NSCopying>

    Swift

    class ESTEddystoneAttachment : NSObject, NSCopying

  • Deprecated

    Deprecated since 4.31.0.

    ESTEddystoneEID represents Eddystone Ephemeral ID packet coming from ESTEddystoneManager class. When device is registered packet will contain Namespace ID and Instance ID resolved from secure payload.

    See more

    Declaration

    Objective-C

    
@interface ESTEddystoneEID : ESTEddystone

    Swift

    class ESTEddystoneEID : ESTEddystone

  • Deprecated

    Deprecated since 4.31.0.

    Generic Eddystone based filter used by ESTEddystoneManager in discovery process. Instance of ESTEddystoneFilter can be used as a base for other filters.

    See more

    Declaration

    Objective-C

    
@interface ESTEddystoneFilter : NSObject

    Swift

    class ESTEddystoneFilter : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    Eddystone-UID based filter used by ESTEddystoneManager in discovery process. Filter should be initialized with namespaceID and instanceID that is matching device(s) should be discovered. Only Namespace ID is required, Instance ID can be provided optionally for better flexibility.

    See more

    Declaration

    Objective-C

    
@interface ESTEddystoneFilterUID : ESTEddystoneFilter

    Swift

    class ESTEddystoneFilterUID : ESTEddystoneFilter

  • Deprecated

    Deprecated since 4.31.0.

    Eddystone-URLDomain based filter used by ESTEddystoneManager in discovery process. Filter should be initialized with URL Domain string that is matching device(s) should be discovered. URL domain gives more flexibility then regular URL based filter. It allows to scan family of devices sharing same url domain in broadcasted packet.

    For example you can have two devices broadcasting http://go.esti.be/kitchen and http://go.esti.be/bedroom urls. In that case scanning with URL Domain defined as ‘go.esti.be’ will provided both devices as discovery process result.

    See more

    Declaration

    Objective-C

    
@interface ESTEddystoneFilterURLDomain : ESTEddystoneFilter

    Swift

    class ESTEddystoneFilterURLDomain : ESTEddystoneFilter

  • Deprecated

    Deprecated since 4.31.0.

    The ESTEddystoneManager class defines entry point to interact with Google Eddystones. As a core functionality it allows to discover Eddystone devices available in range.

    Discovery process is based on simple filtering mechanism. As Eddystone devices can advertise Eddystone-UID or Eddystone-URL packets, separate filters are available. Multiple filters can be used at the same time. When using more then one filter, manager will call eddystoneManager:didDiscoverEddystones:withFilter callback for each filter separately with corresponding filter provided.

    See more

    Declaration

    Objective-C

    
@interface ESTEddystoneManager : NSObject

    Swift

    class ESTEddystoneManager : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    ESTFeaturesetBackgroundMode encapsulates operations required for Background Mode’s functionality. The algorithm relies on Generic Adevrtiser, and this helper tool ensures that the settings are set properly.

    See more

    Declaration

    Objective-C

    
@interface ESTFeaturesetBackgroundMode : NSObject

    Swift

    class ESTFeaturesetBackgroundMode : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    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.

    See more

    Declaration

    Objective-C

    
@interface ESTFeaturesetEstimoteMonitoring : NSObject

    Swift

    class ESTFeaturesetEstimoteMonitoring : NSObject

  • ESTGPIOPortData is Value Object representing state of all available GPIO port.

    See more

    Declaration

    Objective-C

    @interface ESTGPIOPortsData : NSObject <NSCopying>

    Swift

    class ESTGPIOPortsData : NSObject, NSCopying

  • Class used by bulk updater to store a device identifier together with an array of settings operations that should be performed on that device after discovery and connection.

    See more

    Declaration

    Objective-C

    @interface ESTLocationBeaconBulkUpdateConfiguration : NSObject

    Swift

    class ESTLocationBeaconBulkUpdateConfiguration : NSObject

  • Class that can be used to perform bulk updates on new generation Estimote beacons. To start bulk update you need to prepare an array of ESTLocationBeaconBulkUpdateConfiguration objects containing a device identifier and an array of ESTSettingOperation objects that will be initialized with `ESTSettingReadWrite’ subclass objects designed for specific settings.

    See more

    Declaration

    Objective-C

    @interface ESTLocationBeaconBulkUpdater : NSObject

    Swift

    class ESTLocationBeaconBulkUpdater : NSObject

  • ESTLogger is a helper class to faciliate handling logs and debugging. Class is compatible with KZLinkedConsole.

    See more

    Declaration

    Objective-C

    @interface ESTLogger : NSObject

    Swift

    class ESTLogger : NSObject

  • ESTMesh represents object of Mesh network’s details stored in Estimote Cloud.

    See more

    Declaration

    Objective-C

    @interface ESTMesh : ESTBaseVO <NSCopying, NSCoding>

    Swift

    class ESTMesh : ESTBaseVO, NSCopying, NSCoding

  • Responsible for two way communication between Mesh network and Cloud. ESTMeshGateway serves two purposes:

    • listen for Mesh packets and send confirmations to Estimote Cloud,
    • periodically fetch pending Mesh buffers for user’s Mesh networks and apply them. Note that ESTMeshGateway requires appID and appToken (), which you can obtain via www.cloud.estimote.com See: + (void)setupAppID:(NSString *)appID andAppToken:(NSString *)appToken
    See more

    Declaration

    Objective-C

    @interface ESTMeshGateway : NSObject

    Swift

    class ESTMeshGateway : NSObject

  • ESTMeshManager is responsible for Mesh networks management and synchronising with Estimote Cloud.

    See more

    Declaration

    Objective-C

    @interface ESTMeshManager : NSObject

    Swift

    class ESTMeshManager : NSObject

  • ESTMeshNearablesScanReportVO represents full report of mesh scan report consisting of single scan results delivered from beacons scanning for stickers. Single record is represented by ESTMeshScanResultVO.

    See more

    Declaration

    Objective-C

    @interface ESTMeshNearablesScanReportVO : NSObject

    Swift

    class ESTMeshNearablesScanReportVO : NSObject

  • ESTMeshNearablesScanResultVO represents single sticker discovery recorded in delivered Mesh scan report.

    See more

    Declaration

    Objective-C

    @interface ESTMeshNearablesScanResultVO : NSObject

    Swift

    class ESTMeshNearablesScanResultVO : NSObject

  • Handles reading Bluetooth scan reports from device.

    See more

    Declaration

    Objective-C

    @interface ESTMeshScanReportsManager : NSObject

    Swift

    class ESTMeshScanReportsManager : NSObject

  • Deprecated

    Use ESTMonitoringV2Manager instead.

    ESTMonitoringManager handles monitoring Location Beacons on top of Estimote Location packet.

    In order to monitor multiple devices a separate instance of Monitoring Manager should be created for each monitored device.

    Estimote Monitoring uses Core Bluetooth and Core Location frameworks underneath. To make it work when the app is in background, make sure following entries are present in Info.plist file:

    • bluetooth-central

    • NSBluetoothPeripheralUsageDescription

    • NSLocationAlwaysUsageDescription

    See more

    Declaration

    Objective-C

    
@interface ESTMonitoringManager : NSObject

    Swift

    class ESTMonitoringManager : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    Handles beacon enter/exit events using Estimote Monitoring v2.0 algorithm.

    Estimote Monitoring uses Core Bluetooth and Core Location frameworks underneath. To make it work when the app is in background, make sure following entries are present in Info.plist file:

    • bluetooth-central, AKA Background Modes -> Uses Bluetooth LE accessories. Allows Core Bluetooth operation in background.

    • NSBluetoothPeripheralUsageDescription, description for Bluetooth alert.

    • NSLocationAlwaysUsageDescription, description for Location alert.

    See more

    Declaration

    Objective-C

    
@interface ESTMonitoringV2Manager : NSObject

    Swift

    class ESTMonitoringV2Manager : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    The ESTMotionRule class defines single rule related to motion state of the Estimote nearable device.

    Declaration

    Objective-C

    
@interface ESTMotionRule : ESTNearableRule

    Swift

    class ESTMotionRule : ESTNearableRule

  • Deprecated

    Deprecated since 4.31.0.

    The ESTNearable class defines the interface for interacting with a single Estimote nearable. It enables you to retrieve properties of the nearable. You do not create instances of this class directly. The <ESTNearableManager> object reports encountered beacons to its associated delegate object.

    The identity of a nearable is defined by its <identifier>` property. Identifier of the device is unique among all the Estimote nearables and can not be changed.

    See more

    Declaration

    Objective-C

    
@interface ESTNearable : NSObject <NSCopying, NSCoding>

    Swift

    class ESTNearable : NSObject, NSCopying, NSCoding

  • Deprecated

    Deprecated since 4.31.0.

    The ESTNearableManager class defines the interface for ranging and monitoring nearables.

    See more

    Declaration

    Objective-C

    
@interface ESTNearableManager : NSObject

    Swift

    class ESTNearableManager : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    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.

    See more

    Declaration

    Objective-C

    
@interface ESTNearableRule : ESTRule

    Swift

    class ESTNearableRule : ESTRule

  • Deprecated

    Deprecated since 4.31.0.

    The ESTOrientationRule class defines single rule related to physical orientation of the Estimote nearable device.

    Declaration

    Objective-C

    
@interface ESTOrientationRule : ESTNearableRule

    Swift

    class ESTOrientationRule : ESTNearableRule

  • ESTPeripheralTypeUtility is a wrapper around CBPeripheral object of beacon device. It allows to perform bluetooth only read/write operation on the device and reboot device;.

    See more

    Declaration

    Objective-C

    @interface ESTPeripheralTypeUtility : NSObject <ESTPeripheral>

    Swift

    class ESTPeripheralTypeUtility : NSObject, ESTPeripheral

  • Deprecated

    Deprecated since 4.31.0.

    The ESTProximityRule class defines single rule related to proximity from the Estimote nearable device.

    Declaration

    Objective-C

    
@interface ESTProximityRule : ESTNearableRule

    Swift

    class ESTProximityRule : ESTNearableRule

  • Deprecated

    Deprecated since 4.31.0.

    ESTRequestBeaconColor is used to assign GPS location to single beacon device. GPS Location can be provided during initialisation or taken automatically when nil provided.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestAssignGPSLocation : ESTRequestPutJSON

    Swift

    class ESTRequestAssignGPSLocation : ESTRequestPutJSON

  • Deprecated

    Deprecated since 4.31.0. Please use ESTRequestGetDeviceDetails instead.

    ESTRequestBeaconColor is used to fetch color of single beacon device.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestBeaconColor : ESTRequestGetJSON

    Swift

    class ESTRequestBeaconColor : ESTRequestGetJSON

  • Deprecated

    Deprecated since 4.31.0.

    ESTRequestBeaconMac allows to get MAC address for beacon based on CLBeacon (ProximityUUID, Major, Minor) identification. Method is publicly available for all beacons.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestBeaconMac : ESTRequestGetJSON

    Swift

    class ESTRequestBeaconMac : ESTRequestGetJSON

  • Deprecated

    Deprecated since 4.31.0. Please use ESTRequestDeletePendingSettings.

    This request is deleting the device’s pending settings from the Estimote Cloud for authorized user.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestCancelPendingSettings : ESTRequestDelete

    Swift

    class ESTRequestCancelPendingSettings : ESTRequestDelete

  • ESTRequestDeletePendingSettings allows to delete all pending settings for provided list of devices.

    See more

    Declaration

    Objective-C

    @interface ESTRequestDeletePendingSettings : ESTRequestPostJSON

    Swift

    class ESTRequestDeletePendingSettings : ESTRequestPostJSON

  • Deprecated

    Deprecated since 4.31.0. Please use ESTRequestGetDevices instead.

    ESTRequestGetBeacons is used to fetch list of all beacons that belongs to currently authorised user. All details are provided including beacon’s settings.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestGetBeacons : ESTRequestGetJSON

    Swift

    class ESTRequestGetBeacons : ESTRequestGetJSON

  • Deprecated

    Deprecated since 4.31.0. Please use ESTRequestGetDevices instead.

    Request allows to fetch information about group of beacons with identifiers provided during initialization.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestGetBeaconsDetails : ESTRequestGetJSON

    Swift

    class ESTRequestGetBeaconsDetails : ESTRequestGetJSON

  • Allows to get device details from the Estimote Cloud.

    See more

    Declaration

    Objective-C

    @interface ESTRequestGetDeviceDetails : ESTRequestGetJSON

    Swift

    class ESTRequestGetDeviceDetails : ESTRequestGetJSON

  • Allows to get user’s devices details from the Estimote Cloud API.

    See more

    Declaration

    Objective-C

    @interface ESTRequestGetDevices : ESTRequestGetJSON

    Swift

    class ESTRequestGetDevices : ESTRequestGetJSON

  • Deprecated

    Deprecated since 4.31.0. Please use ESTGetDevices instead.

    ESTRequestGetNearables is used to fetch details about all user nearables.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestGetNearables : ESTRequestGetJSON

    Swift

    class ESTRequestGetNearables : ESTRequestGetJSON

  • Deprecated

    Deprecated since 4.31.0. Please use ESTRequestGetDeviceDetails instead.

    This request is fetching all the pending settings from the Estimote Cloud for authorized user.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestGetPendingSettings : ESTRequestGetJSON

    Swift

    class ESTRequestGetPendingSettings : ESTRequestGetJSON

  • Deprecated

    Deprecated since 4.31.0.

    This request is fetching all device’s settings changes from the Estimote Cloud for authorized user.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestGetSettingsHistory : ESTRequestGetJSON

    Swift

    class ESTRequestGetSettingsHistory : ESTRequestGetJSON

  • Deprecated

    Deprecated since 4.31.0.

    Request allows to register device in Estimote Cloud. After registration device can remotely receive information about pending settings.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestRegisterDevice : ESTRequestPostJSON

    Swift

    class ESTRequestRegisterDevice : ESTRequestPostJSON

  • Deprecated

    Deprecated since 4.31.0. Please use ESTRequestDeletePendingSettings.

    ESTRequestV2DeletePendingSettings allows to delete all pending settings for provided list of devices.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestV2DeletePendingSettings : ESTRequestPostJSON

    Swift

    class ESTRequestV2DeletePendingSettings : ESTRequestPostJSON

  • Deprecated

    Deprecated since 4.31.0. Will be removed with next major release.

    ESTRequestV2DevicesUpdate allows to fetch information about all devices having pending changes to be applied. List includes both settings and firmware update.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestV2DevicesUpdate : ESTRequestGetJSON

    Swift

    class ESTRequestV2DevicesUpdate : ESTRequestGetJSON

  • Deprecated

    Please use ESTRequestGetDeviceDetails class for fetching device’s details from Estimote Cloud.

    ESTRequestV2GetDeviceDetails allows to get device details from the Estimote Cloud API v2.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestV2GetDeviceDetails : ESTRequestGetJSON

    Swift

    class ESTRequestV2GetDeviceDetails : ESTRequestGetJSON

  • Deprecated

    Please use ESTRequestGetDevices class for fetching user’s from Estimote Cloud.

    ESTRequestV2GetDeviceDetails allows to get user’s devices details from the Estimote Cloud API v2.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestV2GetDevices : ESTRequestGetJSON

    Swift

    class ESTRequestV2GetDevices : ESTRequestGetJSON

  • Deprecated

    Deprecated since 4.31.0. Will be renamed to ESTRequestGetDeviceOwner

    Allows to get email address of device’s owner from the Estimote Cloud.

    See more

    Declaration

    Objective-C

    
@interface ESTRequestV3GetDeviceOwner : ESTRequestGetJSON

    Swift

    class ESTRequestV3GetDeviceOwner : ESTRequestGetJSON

  • Request responsible for fetching dictionary of newest firmwares for each hardware revision.

    Declaration

    Objective-C

    @interface ESTRequestV3GetFirmwares : ESTRequestGetJSON

    Swift

    class ESTRequestV3GetFirmwares : ESTRequestGetJSON

  • Deprecated

    Deprecated since 4.31.0.

    The ESTRule class defines single rule of <ESTTrigger> object. Each rule has state value that indicates if it was fulfilled or not.

    See more

    Declaration

    Objective-C

    
@interface ESTRule : NSObject

    Swift

    class ESTRule : NSObject

  • ESTSettingBase defines a base class for all device related settings.

    See more

    Declaration

    Objective-C

    @interface ESTSettingBase : NSObject

    Swift

    class ESTSettingBase : NSObject

  • ESTSettingIBeaconMotionUUID represents iBeacon MotionUUID value. This is the iBeacon Proximity UUID device broadcasts when MotionUUID feature is enabled, and the device is in motion.

    See more

    Declaration

    Objective-C

    @interface ESTSettingIBeaconMotionUUID : ESTSettingReadOnly <NSCopying>

    Swift

    class ESTSettingIBeaconMotionUUID : ESTSettingReadOnly, NSCopying

  • ESTSettingOperation represents base class for setting operations mainly responsible for handling operation type.

    See more

    Declaration

    Objective-C

    @interface ESTSettingOperation : NSObject

    Swift

    class ESTSettingOperation : NSObject

  • ESTSettingReadOnly serves as a base class for Read Only settings defining set of methods required to create read operations.

    See more

    Declaration

    Objective-C

    @interface ESTSettingReadOnly : ESTSettingBase

    Swift

    class ESTSettingReadOnly : ESTSettingBase

  • ESTSettingSensorsTemperatureOffset represents Sensors TemperatureOffset value.

    You can use this setting to calibrate the beacon’s temperature sensor.

    For example, if you measure that the sensor in the beacon is off by 1.2 degree C (shows 21.2 instead of 20.0), set the temperature offset to -1.2.

    See more

    Declaration

    Objective-C

    @interface ESTSettingSensorsTemperatureOffset : ESTSettingReadWrite <NSCopying>

    Swift

    class ESTSettingSensorsTemperatureOffset : ESTSettingReadWrite, NSCopying

  • ESTSettingsConnectivity all settings related to connectivity packet;

    See more

    Declaration

    Objective-C

    @interface ESTSettingsConnectivity : NSObject

    Swift

    class ESTSettingsConnectivity : NSObject

  • ESTSettingsDeviceInfo represents group of settings related to device information.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsDeviceInfo : NSObject

    Swift

    class ESTSettingsDeviceInfo : NSObject

  • ESTSettingsEddystoneConfigurationService represents settings group related to Eddystone Configuration Service.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsEddystoneConfigurationService : NSObject

    Swift

    class ESTSettingsEddystoneConfigurationService : NSObject

  • ESTSettingsEddystoneEID represents group of settings realted to Eddystone EID packet.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsEddystoneEID : NSObject

    Swift

    class ESTSettingsEddystoneEID : NSObject

  • ESTSettingsEddystoneTLM represents a group of settings related to Eddystone Telemetry packet.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsEddystoneTLM : NSObject

    Swift

    class ESTSettingsEddystoneTLM : NSObject

  • ESTSettingsEddystoneUID represents group of settings related to Eddystone UID packet.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsEddystoneUID : NSObject

    Swift

    class ESTSettingsEddystoneUID : NSObject

  • ESTSettingsEddystoneURL represents group of settings related to Eddystone URL packet.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsEddystoneURL : NSObject

    Swift

    class ESTSettingsEddystoneURL : NSObject

  • ESTSettingsEstimoteLocation represents group of settings related to Estimote Location packet.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsEstimoteLocation : NSObject

    Swift

    class ESTSettingsEstimoteLocation : NSObject

  • ESTSettingsEstimoteTLM represents group of settings related to Estimote Telemetry packet.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsEstimoteTLM : NSObject

    Swift

    class ESTSettingsEstimoteTLM : NSObject

  • ESTSettingsGPIO represents group of settings related to GPIO features.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsGPIO : NSObject

    Swift

    class ESTSettingsGPIO : NSObject

  • ESTSettingsIBeacon represents group of settings related to Apple iBeacon packet.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsIBeacon : NSObject

    Swift

    class ESTSettingsIBeacon : NSObject

  • ESTSettingsPower represents group of settings related to power management.

    See more

    Declaration

    Objective-C

    @interface ESTSettingsPower : NSObject

    Swift

    class ESTSettingsPower : NSObject

  • ESTSettingsSensors

    See more

    Declaration

    Objective-C

    @interface ESTSettingsSensors : NSObject

    Swift

    class ESTSettingsSensors : NSObject

  • ESTStorageManager class is responsible for managing Location Beacon’s non-volatile storage.

    See more

    Declaration

    Objective-C

    @interface ESTStorageManager : NSObject

    Swift

    class ESTStorageManager : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    Class for objects carying data from telemetry packet.

    See more

    Declaration

    Objective-C

    
@interface ESTTelemetryInfo : NSObject

    Swift

    class ESTTelemetryInfo : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    ESTTelemetryNotificationAmbientLight class is used to initialize block that will be fired everytime new telemetry packet was ranged. As a parameter of ESTTelemetryNotificationAmbientLightCompletionBlock expect ESTTelemetryInfoAmbientLight object that transmits ambient light value (in lux) read by beacon.

    See more

    Declaration

    Objective-C

    
@interface ESTTelemetryNotificationAmbientLight
    : NSObject <ESTTelemetryNotificationProtocol>

    Swift

    class ESTTelemetryNotificationAmbientLight : NSObject, ESTTelemetryNotificationProtocol

  • Deprecated

    Deprecated since 4.31.0.

    ESTTelemetryNotificationMagnetometer class is used to initialize block that will be fired everytime new telemetry packet was ranged. As a parameter of ESTTelemetryNotificationMagnetometerNotificationBlock expect ESTTelemetryInfoMagnetometer object that transmits magnetometer values in X, Y, Z axises, read by beacon device.

    See more

    Declaration

    Objective-C

    
@interface ESTTelemetryNotificationMagnetometer
    : NSObject <ESTTelemetryNotificationProtocol>

    Swift

    class ESTTelemetryNotificationMagnetometer : NSObject, ESTTelemetryNotificationProtocol

  • Deprecated

    Deprecated since 4.31.0.

    ESTTelemetryNotificationMotion class is used to initialize block that will be fired everytime new telemetry packet was ranged. As a parameter of ESTTelemetryNotificationMotionCompletionBlock expect ESTTelemetryInfoMotion object that transmits axises X,Y,Z of beacon position and current and previous motion state duration.

    See more

    Declaration

    Objective-C

    
@interface ESTTelemetryNotificationMotion
    : NSObject <ESTTelemetryNotificationProtocol>

    Swift

    class ESTTelemetryNotificationMotion : NSObject, ESTTelemetryNotificationProtocol

  • Deprecated

    Deprecated since 4.31.0.

    ESTTelemetryNotificationPressure class is used to initialize block that will be fired everytime new telemetry packet was ranged. As a parameter of ESTTelemetryNotificationPressureCompletionBlock expect ESTTelemetryInfoPressure object that transmits atmospheric pressure value (in pascals) read by beacon.

    See more

    Declaration

    Objective-C

    
@interface ESTTelemetryNotificationPressure
    : NSObject <ESTTelemetryNotificationProtocol>

    Swift

    class ESTTelemetryNotificationPressure : NSObject, ESTTelemetryNotificationProtocol

  • Deprecated

    Deprecated since 4.31.0.

    ESTTelemetryNotificationSystemStatus class is used to initialize block that will be fired everytime new telemetry packet was ranged. As a parameter of ESTTelemetryNotificationSystemStatusNotificationBlock expect ESTTelemetryInfoSystemStatus object that transmits system status information (battery voltage and OS uptime)

    See more

    Declaration

    Objective-C

    
@interface ESTTelemetryNotificationSystemStatus
    : NSObject <ESTTelemetryNotificationProtocol>

    Swift

    class ESTTelemetryNotificationSystemStatus : NSObject, ESTTelemetryNotificationProtocol

  • Deprecated

    Deprecated since 4.31.0.

    ESTTelemetryNotificationTemperature class is used to initialize block that will be fired everytime new telemetry packet was ranged. As a parameter of ESTTelemetryNotificationTemperatureCompletionBlock expect ESTTelemetryInfoTemperature object that transmits current temperature readings from beacon.

    See more

    Declaration

    Objective-C

    
@interface ESTTelemetryNotificationTemperature
    : NSObject <ESTTelemetryNotificationProtocol>

    Swift

    class ESTTelemetryNotificationTemperature : NSObject, ESTTelemetryNotificationProtocol

  • Deprecated

    Deprecated since 4.31.0.

    The ESTTemperatureRule class defines single rule related to ambient temperature of the Estimote nearable device.

    Declaration

    Objective-C

    
@interface ESTTemperatureRule : ESTNearableRule

    Swift

    class ESTTemperatureRule : ESTNearableRule

  • ESTTime is an object wrapper around seconds since midnight. Represents given time of day, measuring seconds since midnight. Useful for representing time relative to midnight.

    See more

    Declaration

    Objective-C

    @interface ESTTime : NSObject <NSCopying>

    Swift

    class ESTTime : NSObject, NSCopying

  • ESTTimePeriod represents time interval using two time points. Can be used for time intervals of reoccuring events without a concrete absolute time.

    Start time later than end time is allowed. In that situation, the object represents interval spanning across adjacent days.

    See more

    Declaration

    Objective-C

    @interface ESTTimePeriod : NSObject <NSCopying>

    Swift

    class ESTTimePeriod : NSObject, NSCopying

  • Deprecated

    Deprecated since 4.31.0.

    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.

    See more

    Declaration

    Objective-C

    
@interface ESTTrigger : NSObject

    Swift

    class ESTTrigger : NSObject

  • Deprecated

    Deprecated since 4.31.0.

    The ESTTriggerManager class defines the interface for defining real life rules based triggers.

    See more

    Declaration

    Objective-C

    
@interface ESTTriggerManager : NSObject <ESTTriggerDelegate>

    Swift

    class ESTTriggerManager : NSObject, ESTTriggerDelegate

  • Deprecated

    Deprecated since 4.31.0.

    The ESTUtilityManager class defines the interface for utility methods related to Estimote Beacons. The main functionality allows to discover CoreBluetooth based representation of Estimote Beacon devices.

    See more

    Declaration

    Objective-C

    
@interface ESTUtilityManager : NSObject

    Swift

    class ESTUtilityManager : NSObject