ESTDeviceDetails

@interface ESTDeviceDetails : ESTBaseVO

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

  • Device identifier.

    Declaration

    Objective-C

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

    Swift

    var identifier: String { get }

  • Type of hardware.

    Declaration

    Objective-C

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

    Swift

    var hardwareType: String { get }

  • Revision of hardware.

    Declaration

    Objective-C

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

    Swift

    var hardwareRevision: String { get }

  • Footprint of hardware.

    Declaration

    Objective-C

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

    Swift

    var hardwareFootprint: String { get }

  • Color of the device.

    Declaration

    Objective-C

    @property (nonatomic, readonly) ESTColor color;

    Swift

    var color: ESTColor { get }

  • Form-factor of the device.

    Declaration

    Objective-C

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

    Swift

    var formFactor: String { get }

  • Shadow object representing high level context device belongs to.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) ESTDeviceShadow *_Nonnull shadow;

    Swift

    var shadow: ESTDeviceShadow { get }

  • Object containing all settings of the device.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) ESTDeviceSettings *_Nonnull settings;

    Swift

    var settings: ESTDeviceSettings { get }

  • Object containing all pending settings of the device applied from both Estimote Cloud and SDK.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly)
    ESTDeviceSettings *_Nonnull pendingSettings;

    Swift

    var pendingSettings: ESTDeviceSettings { get }

  • Object containing all status information like battery level.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly)
    ESTDeviceStatusReport *_Nonnull statusReport;

    Swift

    var statusReport: ESTDeviceStatusReport { get }

  • Metadata returned by Estimote Cloud together with this device’s details JSON. Nil if metadata wasn’t present in the parsed response.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) ESTDeviceDetailsMeta *meta;

    Swift

    var meta: ESTDeviceDetailsMeta? { get }

  • Deprecated

    Use initWithDataDictionary:metaDictionary;

    Method allows to initialize value object with data coming from Estimote Cloud request ESTRequestGetDeviceDetails.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithCloudDictionary:
    (nonnull NSDictionary *)dictionary;

    Swift

    convenience init(cloudDictionary dictionary: [AnyHashable : Any])

    Parameters

    dictionary

    Dictionary containing parsed JSON data coming from cloud.

    Return Value

    Initialized object.

  • Designated initializer.

    Declaration

    Objective-C

    - (nonnull instancetype)
    initWithDataDictionary:(nonnull NSDictionary *)dataDictionary
            metaDictionary:(nonnull NSDictionary *)metaDictionary;

    Swift

    init(dataDictionary: [AnyHashable : Any], metaDictionary: [AnyHashable : Any])

    Parameters

    dataDictionary

    Dictionary stored usually under data key in response returned by Estimote Cloud.
    metaDictionary

    Metadata stored usually under meta key in response returned by Estimote Cloud.

    Return Value

    Initialized value object of device’s details.