Type Definitions

The following type definitions are available globally.

  • Block used as a result of all operation success or failure of one of them.

    See

    performOperationsFromArray:completion:

    Declaration

    Objective-C

    typedef void (^ESTDeviceSettingsManagerOperationsCompletionBlock)(
        NSError *_Nullable)

    Swift

    typealias ESTDeviceSettingsManagerOperationsCompletionBlock = (Error?) -> Void

    Parameters

    error

    Error of operation. No error means success.

  • Notification Block used to inform about GPIO ports state change during connection.

    Declaration

    Objective-C

    typedef void (^ESTNotificationGPIODataBlock)(ESTGPIOPortsData *_Nonnull)

    Swift

    typealias ESTNotificationGPIODataBlock = (ESTGPIOPortsData) -> Void

    Parameters

    portsData

    current state of all GPIO ports.

  • Completion block fired when request is complete.

    Declaration

    Objective-C

    typedef void (^ESTRequestGetDeviceDetailsBlock)(ESTDeviceDetails *_Nullable,
                                                    NSError *_Nullable)

    Swift

    typealias ESTRequestGetDeviceDetailsBlock = (ESTDeviceDetails?, Error?) -> Void

    Parameters

    deviceDetails

    Details of the device wrapped in ESTDeviceDetails class object.

    error

    Error of request. No error means success.

  • Completion block fired when request is complete.

    Declaration

    Objective-C

    typedef void (^ESTRequestGetDevicesBlock)(
        NSArray<ESTDeviceDetails *> *_Nullable, NSNumber *_Nullable,
        NSNumber *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTRequestGetDevicesBlock = ([ESTDeviceDetails]?, NSNumber?, NSNumber?, Error?) -> Void

    Parameters

    devicesDetails

    Details of the devices wrapped in an array of ESTDeviceDetails class objects.

    totalCount

    Total count of devices assigned in Cloud.

    nextPage

    Index of the next available page of devices details. Nil value means there are no more details to fetch.

    error

    Error of request. No error means success.

  • Completion block fired when request is complete.

    Declaration

    Objective-C

    typedef void (^ESTRequestV2DeletePendingSettingsBlock)(id _Nullable,
                                                           NSError *_Nullable)

    Swift

    typealias ESTRequestV2DeletePendingSettingsBlock = (Any?, Error?) -> Void

    Parameters

    result

    Array of user’s devices identifiers, for which Cloud has pending changes.

    error

    Error of request. No error means success.

  • Completion block fired when request is complete.

    Declaration

    Objective-C

    typedef void (^ESTRequestV2GetDeviceDetailsBlock)(ESTDeviceDetails *_Nullable,
                                                      NSError *_Nullable)

    Swift

    typealias ESTRequestV2GetDeviceDetailsBlock = (ESTDeviceDetails?, Error?) -> Void

    Parameters

    deviceDetails

    Details of the device wrapped in ESTDeviceDetails class object.

    error

    Error of request. No error means success.

  • Completion block fired when request is complete.

    Declaration

    Objective-C

    typedef void (^ESTRequestV2GetDevicesBlock)(
        NSArray<ESTDeviceDetails *> *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTRequestV2GetDevicesBlock = ([ESTDeviceDetails]?, Error?) -> Void

    Parameters

    devicesDetails

    Array of user’s devices details, each wrapped in ESTDeviceDetails class object.

    error

    Error of request. No error means success.

  • Completion block fired when ESTRequestV3GetDeviceOwner request is complete.

    Declaration

    Objective-C

    typedef void (^ESTRequestV3GetDeviceOwnerBlock)(NSString *_Nullable,
                                                    NSError *_Nullable)

    Swift

    typealias ESTRequestV3GetDeviceOwnerBlock = (String?, Error?) -> Void

    Parameters

    emailAddress

    Email address of the device’s owner.

    error

    Request error object. No error means success.

  • Block used as a result of operation.

    Declaration

    Objective-C

    typedef void (^ESTSettingCompletionBlock)(ESTSettingBase *_Nullable,
                                              NSError *_Nullable)

    Swift

    typealias ESTSettingCompletionBlock = (ESTSettingBase?, Error?) -> Void

    Parameters

    setting

    Current setting.

    error

    Error of operation. No error means success.

  • Block used as a result of read/write setting Power operation for Connectivity packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingConnectivityPowerCompletionBlock)(
        ESTSettingConnectivityPower *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingConnectivityPowerCompletionBlock = (ESTSettingConnectivityPower?, Error?) -> Void

    Parameters

    powerSetting

    Power setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Color operation for DeviceInfo packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingDeviceInfoColorCompletionBlock)(
        ESTSettingDeviceInfoColor *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingDeviceInfoColorCompletionBlock = (ESTSettingDeviceInfoColor?, Error?) -> Void

    Parameters

    colorSetting

    Color setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Name operation for Device Info packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingDeviceInfoNameCompletionBlock)(
        ESTSettingDeviceInfoName *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingDeviceInfoNameCompletionBlock = (ESTSettingDeviceInfoName?, Error?) -> Void

    Parameters

    nameSetting

    Name setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Tags operation for Cloud packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingDeviceInfoTagsCompletionBlock)(
        ESTSettingDeviceInfoTags *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingDeviceInfoTagsCompletionBlock = (ESTSettingDeviceInfoTags?, Error?) -> Void

    Parameters

    tagsSetting

    Tags setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting UTCTime operation. Works with time interval since 1970, 1 second precision.

    Declaration

    Objective-C

    typedef void (^ESTSettingDeviceInfoUTCTimeCompletionBlock)(
        ESTSettingDeviceInfoUTCTime *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingDeviceInfoUTCTimeCompletionBlock = (ESTSettingDeviceInfoUTCTime?, Error?) -> Void

    Parameters

    utcTimeSetting

    UTCTime setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read setting Uptime operation for DeviceInfo packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingDeviceInfoUptimeCompletionBlock)(
        ESTSettingDeviceInfoUptime *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingDeviceInfoUptimeCompletionBlock = (ESTSettingDeviceInfoUptime?, Error?) -> Void

    Parameters

    uptimeSetting

    Uptime setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Power operation for EddystoneEID packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEddystoneEIDPowerCompletionBlock)(
        ESTSettingEddystoneEIDPower *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEddystoneEIDPowerCompletionBlock = (ESTSettingEddystoneEIDPower?, Error?) -> Void

    Parameters

    powerSetting

    Power setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Enable operation for Eddystone Telemetry packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEddystoneTLMEnableCompletionBlock)(
        ESTSettingEddystoneTLMEnable *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEddystoneTLMEnableCompletionBlock = (ESTSettingEddystoneTLMEnable?, Error?) -> Void

    Parameters

    enabledSetting

    Enable setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Advertising Interval operation for Eddystone Telemetry packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEddystoneTLMIntervalCompletionBlock)(
        ESTSettingEddystoneTLMInterval *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEddystoneTLMIntervalCompletionBlock = (ESTSettingEddystoneTLMInterval?, Error?) -> Void

    Parameters

    advertisingIntervalSetting

    Advertising Interval setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Power operation for Eddystone Telemetry packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEddystoneTLMPowerCompletionBlock)(
        ESTSettingEddystoneTLMPower *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEddystoneTLMPowerCompletionBlock = (ESTSettingEddystoneTLMPower?, Error?) -> Void

    Parameters

    powerSetting

    Power setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting AdvertisingInterval operation for Eddystone UID packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEddystoneUIDIntervalCompletionBlock)(
        ESTSettingEddystoneUIDInterval *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEddystoneUIDIntervalCompletionBlock = (ESTSettingEddystoneUIDInterval?, Error?) -> Void

    Parameters

    advertisingIntervalSetting

    AdvertisingInterval setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Power operation for Eddystone UID packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEddystoneUIDPowerCompletionBlock)(
        ESTSettingEddystoneUIDPower *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEddystoneUIDPowerCompletionBlock = (ESTSettingEddystoneUIDPower?, Error?) -> Void

    Parameters

    powerSetting

    Power setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting URL Data operation for Eddystone URL packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEddystoneURLDataCompletionBlock)(
        ESTSettingEddystoneURLData *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEddystoneURLDataCompletionBlock = (ESTSettingEddystoneURLData?, Error?) -> Void

    Parameters

    eddystoneURLSetting

    URL Data setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Power operation for Eddystone URL packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEddystoneURLPowerCompletionBlock)(
        ESTSettingEddystoneURLPower *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEddystoneURLPowerCompletionBlock = (ESTSettingEddystoneURLPower?, Error?) -> Void

    Parameters

    powerSetting

    Power setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Enable operation for Estimote Telemetry packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEstimoteTLMEnableCompletionBlock)(
        ESTSettingEstimoteTLMEnable *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEstimoteTLMEnableCompletionBlock = (ESTSettingEstimoteTLMEnable?, Error?) -> Void

    Parameters

    enabledSetting

    Enable setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Advertising Interval operation for Estimote Telemetry packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEstimoteTLMIntervalCompletionBlock)(
        ESTSettingEstimoteTLMInterval *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEstimoteTLMIntervalCompletionBlock = (ESTSettingEstimoteTLMInterval?, Error?) -> Void

    Parameters

    advertisingIntervalSetting

    Advertising Interval setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Power operation for Estimote Telemetry packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingEstimoteTLMPowerCompletionBlock)(
        ESTSettingEstimoteTLMPower *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingEstimoteTLMPowerCompletionBlock = (ESTSettingEstimoteTLMPower?, Error?) -> Void

    Parameters

    powerSetting

    Power setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting ConfigPort0 operation for GPIO packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingGPIOConfigPort0CompletionBlock)(
        ESTSettingGPIOConfigPort0 *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingGPIOConfigPort0CompletionBlock = (ESTSettingGPIOConfigPort0?, Error?) -> Void

    Parameters

    configSetting

    ConfigPort0 setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting ConfigPort1 operation for GPIO packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingGPIOConfigPort1CompletionBlock)(
        ESTSettingGPIOConfigPort1 *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingGPIOConfigPort1CompletionBlock = (ESTSettingGPIOConfigPort1?, Error?) -> Void

    Parameters

    configSetting

    ConfigPort1 setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting PortsData operation for GPIO packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingGPIOPortsDataCompletionBlock)(
        ESTSettingGPIOPortsData *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingGPIOPortsDataCompletionBlock = (ESTSettingGPIOPortsData?, Error?) -> Void

    Parameters

    portsDataSetting

    PortsData setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting GenericAdvertiserData operation for GenericAdvertiser packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingGenericAdvertiserDataCompletionBlock)(
        ESTSettingGenericAdvertiserData *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingGenericAdvertiserDataCompletionBlock = (ESTSettingGenericAdvertiserData?, Error?) -> Void

    Parameters

    genericAdvertiserDataSetting

    GenericAdvertiserData setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting GenericAdvertiserEnabled operation for GenericAdvertiser packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingGenericAdvertiserEnableCompletionBlock)(
        ESTSettingGenericAdvertiserEnable *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingGenericAdvertiserEnableCompletionBlock = (ESTSettingGenericAdvertiserEnable?, Error?) -> Void

    Parameters

    genericAdvertiserEnabledSetting

    GenericAdvertiserEnabled setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting GenericAdvertiserPower operation for GenericAdvertiser packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingGenericAdvertiserPowerCompletionBlock)(
        ESTSettingGenericAdvertiserPower *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingGenericAdvertiserPowerCompletionBlock = (ESTSettingGenericAdvertiserPower?, Error?) -> Void

    Parameters

    genericAdvertiserPowerSetting

    GenericAdvertiserPower setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Enable operation for iBeacon packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingIBeaconEnableCompletionBlock)(
        ESTSettingIBeaconEnable *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingIBeaconEnableCompletionBlock = (ESTSettingIBeaconEnable?, Error?) -> Void

    Parameters

    iBeaconEnableSetting

    IBeaconEnable setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Advertising Interval operation for iBeacon packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingIBeaconIntervalCompletionBlock)(
        ESTSettingIBeaconInterval *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingIBeaconIntervalCompletionBlock = (ESTSettingIBeaconInterval?, Error?) -> Void

    Parameters

    advertisingIntervalSetting

    Advertising Interval setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting major operation.

    Declaration

    Objective-C

    typedef void (^ESTSettingIBeaconMajorCompletionBlock)(
        ESTSettingIBeaconMajor *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingIBeaconMajorCompletionBlock = (ESTSettingIBeaconMajor?, Error?) -> Void

    Parameters

    major

    Major setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Minor operation for iBeacon packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingIBeaconMinorCompletionBlock)(
        ESTSettingIBeaconMinor *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingIBeaconMinorCompletionBlock = (ESTSettingIBeaconMinor?, Error?) -> Void

    Parameters

    minor

    Minor setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read setting MotionUUID operation for iBeacon packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingIBeaconMotionUUIDCompletionBlock)(
        ESTSettingIBeaconMotionUUID *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingIBeaconMotionUUIDCompletionBlock = (ESTSettingIBeaconMotionUUID?, Error?) -> Void

    Parameters

    motionUUIDSetting

    MotionUUID setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Power operation for iBeacon packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingIBeaconPowerCompletionBlock)(
        ESTSettingIBeaconPower *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingIBeaconPowerCompletionBlock = (ESTSettingIBeaconPower?, Error?) -> Void

    Parameters

    powerSetting

    Power setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Interval operation for Nearable packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingNearableIntervalCompletionBlock)(
        ESTSettingNearableInterval *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingNearableIntervalCompletionBlock = (ESTSettingNearableInterval?, Error?) -> Void

    Parameters

    intervalSetting

    Interval setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting Power operation for Nearable packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingNearablePowerCompletionBlock)(
        ESTSettingNearablePower *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingNearablePowerCompletionBlock = (ESTSettingNearablePower?, Error?) -> Void

    Parameters

    powerSetting

    Power setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read setting Pressure operation for Sensors packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingSensorsPressureCompletionBlock)(
        ESTSettingSensorsPressure *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingSensorsPressureCompletionBlock = (ESTSettingSensorsPressure?, Error?) -> Void

    Parameters

    pressureSetting

    Pressure setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read setting Temperature operation for Sensors packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingSensorsTemperatureCompletionBlock)(
        ESTSettingSensorsTemperature *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingSensorsTemperatureCompletionBlock = (ESTSettingSensorsTemperature?, Error?) -> Void

    Parameters

    temperatureSetting

    Temperature setting carrying value.

    error

    Operation error. No error means success.

  • Block used as a result of read/write setting ShakeToConnectEnable operation for Connectivity packet.

    Declaration

    Objective-C

    typedef void (^ESTSettingShakeToConnectEnableCompletionBlock)(
        ESTSettingShakeToConnectEnable *_Nullable, NSError *_Nullable)

    Swift

    typealias ESTSettingShakeToConnectEnableCompletionBlock = (ESTSettingShakeToConnectEnable?, Error?) -> Void

    Parameters

    shakeToConnectEnableSetting

    ShakeToConnectEnable setting carrying value.

    error

    Operation error. No error means success.