Tuya iOS Smart Life App SDK 5.15.0
ThingSmartDevice Class Reference

The basic operation class of ThingSmartDevice contains the model of basic information, including the device, DPs to send, update device information, and other common API operations. More...

#import <ThingSmartDevice.h>

Inheritance diagram for ThingSmartDevice:
ThingSmartBLEDevice ThingSmartBLEDevice ThingSmartBLELockDevice ThingSmartBLELockDevice ThingSmartBLEMeshDevice ThingSmartBLEMeshDevice ThingSmartLockDevice ThingSmartLockDevice ThingSmartSIGMeshDevice ThingSmartSIGMeshDevice ThingSmartSweeperDevice ThingSmartSweeperDevice ThingSmartWiFiLockDevice ThingSmartWiFiLockDevice ThingSmartZigbeeLockDevice ThingSmartZigbeeLockDevice

Instance Methods

(nullable instancetype) - initWithDeviceId:
 
(instancetype) - NS_UNAVAILABLE
 
(ThingDeviceOnlineMode- onlineMode
 Returns the device online status. More...
 
(void) - publishDps:success:failure:
 
(void) - publishDps:mode:success:failure:
 
(void) - publishDps:communicationTypes:success:failure:
 
(void) - updateName:success:failure:
 
(void) - updateIcon:success:failure:
 
(void) - updateIconWithCloudKey:success:failure:
 
(void) - updateIconWithURL:success:failure:
 
(void) - syncWithCloud:failure:
 
(void) - remove:failure:
 
(void) - removeFromCloud:failure:
 
(void) - resetFactory:failure:
 
(void) - resetFactoryFromCloud:failure:
 
(void) - getSubDeviceListFromCloudWithSuccess:failure:
 
(void) - syncLocationToDeviceWithSucecess:failure:
 
(void) - getFirmwareUpgradeInfo:failure:
 
(void) - upgradeFirmware:success:failure:
 
(void) - cancelUpgradeFirmware:success:failure:
 
("This method is deprecated") - __deprecated_msg
 Cancels the firmware update request. More...
 
(void) - updateDeviceVersion:type:success:failure:
 
(void) - getAutoUpgradeSwitchInfoWithSuccess:failure:
 
(void) - saveUpgradeInfoWithSwitchValue:success:failure:
 
(void) - getDevPropertyWithSuccess:failure:
 
(void) - setDevPropertyWithCode:value:success:failure:
 
(void) - publishDpWithCommands:success:failure:
 
(void) - getThingModelWithSuccess:failure:
 
(void) - publishThingMessageWithType:payload:success:failure:
 
(void) - queryDeviceOperateLogWithDpIds:offset:limit:startTime:endTime:isASC:success:failure:
 
(void) - sendCacheDps:validity:dpCacheType:success:failure:
 
(void) - infraredPublishDps:actionDps:reportDps:success:failure:
 
(nullable instancetype) - initWithDeviceId:
 
(instancetype) - NS_UNAVAILABLE
 
(ThingDeviceOnlineMode- onlineMode
 Returns the device online status. More...
 
(void) - publishDps:success:failure:
 
(void) - publishDps:mode:success:failure:
 
(void) - publishDps:communicationTypes:success:failure:
 
(void) - updateName:success:failure:
 
(void) - updateIcon:success:failure:
 
(void) - updateIconWithCloudKey:success:failure:
 
(void) - updateIconWithURL:success:failure:
 
(void) - syncWithCloud:failure:
 
(void) - remove:failure:
 
(void) - removeFromCloud:failure:
 
(void) - resetFactory:failure:
 
(void) - resetFactoryFromCloud:failure:
 
(void) - getSubDeviceListFromCloudWithSuccess:failure:
 
(void) - syncLocationToDeviceWithSucecess:failure:
 
(void) - getFirmwareUpgradeInfo:failure:
 
(void) - upgradeFirmware:success:failure:
 
(void) - cancelUpgradeFirmware:success:failure:
 
("This method is deprecated") - __deprecated_msg
 Cancels the firmware update request. More...
 
(void) - updateDeviceVersion:type:success:failure:
 
(void) - getAutoUpgradeSwitchInfoWithSuccess:failure:
 
(void) - saveUpgradeInfoWithSwitchValue:success:failure:
 
(void) - getDevPropertyWithSuccess:failure:
 
(void) - setDevPropertyWithCode:value:success:failure:
 
(void) - publishDpWithCommands:success:failure:
 
(void) - getThingModelWithSuccess:failure:
 
(void) - publishThingMessageWithType:payload:success:failure:
 
(void) - queryDeviceOperateLogWithDpIds:offset:limit:startTime:endTime:isASC:success:failure:
 
(void) - sendCacheDps:validity:dpCacheType:success:failure:
 
(void) - infraredPublishDps:actionDps:reportDps:success:failure:
 
(nullable instancetype) - initWithDeviceId:
 
(instancetype) - NS_UNAVAILABLE
 
(ThingDeviceOnlineMode- onlineMode
 Returns the device online status. More...
 
(void) - publishDps:success:failure:
 
(void) - publishDps:mode:success:failure:
 
(void) - publishDps:communicationTypes:success:failure:
 
(void) - updateName:success:failure:
 
(void) - updateIcon:success:failure:
 
(void) - updateIconWithCloudKey:success:failure:
 
(void) - updateIconWithURL:success:failure:
 
(void) - syncWithCloud:failure:
 
(void) - remove:failure:
 
(void) - removeFromCloud:failure:
 
(void) - resetFactory:failure:
 
(void) - resetFactoryFromCloud:failure:
 
(void) - getSubDeviceListFromCloudWithSuccess:failure:
 
(void) - syncLocationToDeviceWithSucecess:failure:
 
(void) - getFirmwareUpgradeInfo:failure:
 
(void) - upgradeFirmware:success:failure:
 
(void) - cancelUpgradeFirmware:success:failure:
 
("This method is deprecated") - __deprecated_msg
 Cancels the firmware update request. More...
 
(void) - updateDeviceVersion:type:success:failure:
 
(void) - getAutoUpgradeSwitchInfoWithSuccess:failure:
 
(void) - saveUpgradeInfoWithSwitchValue:success:failure:
 
(void) - getDevPropertyWithSuccess:failure:
 
(void) - setDevPropertyWithCode:value:success:failure:
 
(void) - publishDpWithCommands:success:failure:
 
(void) - getThingModelWithSuccess:failure:
 
(void) - publishThingMessageWithType:payload:success:failure:
 
(void) - queryDeviceOperateLogWithDpIds:offset:limit:startTime:endTime:isASC:success:failure:
 
(void) - sendCacheDps:validity:dpCacheType:success:failure:
 
(void) - infraredPublishDps:actionDps:reportDps:success:failure:
 
(nullable instancetype) - initWithDeviceId:
 
(instancetype) - NS_UNAVAILABLE
 
(ThingDeviceOnlineMode- onlineMode
 Returns the device online status. More...
 
(void) - publishDps:success:failure:
 
(void) - publishDps:mode:success:failure:
 
(void) - publishDps:communicationTypes:success:failure:
 
(void) - updateName:success:failure:
 
(void) - updateIcon:success:failure:
 
(void) - updateIconWithCloudKey:success:failure:
 
(void) - updateIconWithURL:success:failure:
 
(void) - syncWithCloud:failure:
 
(void) - remove:failure:
 
(void) - removeFromCloud:failure:
 
(void) - resetFactory:failure:
 
(void) - resetFactoryFromCloud:failure:
 
(void) - getSubDeviceListFromCloudWithSuccess:failure:
 
(void) - syncLocationToDeviceWithSucecess:failure:
 
(void) - getFirmwareUpgradeInfo:failure:
 
(void) - upgradeFirmware:success:failure:
 
(void) - cancelUpgradeFirmware:success:failure:
 
("This method is deprecated") - __deprecated_msg
 Cancels the firmware update request. More...
 
(void) - updateDeviceVersion:type:success:failure:
 
(void) - getAutoUpgradeSwitchInfoWithSuccess:failure:
 
(void) - saveUpgradeInfoWithSwitchValue:success:failure:
 
(void) - getDevPropertyWithSuccess:failure:
 
(void) - setDevPropertyWithCode:value:success:failure:
 
(void) - publishDpWithCommands:success:failure:
 
(void) - getThingModelWithSuccess:failure:
 
(void) - publishThingMessageWithType:payload:success:failure:
 
(void) - queryDeviceOperateLogWithDpIds:offset:limit:startTime:endTime:isASC:success:failure:
 
(void) - sendCacheDps:validity:dpCacheType:success:failure:
 
(void) - infraredPublishDps:actionDps:reportDps:success:failure:
 
(void) - connectDeviceWithParams:success:failure:
 
(void) - connectDeviceWithParams:success:failure:
 
(void) - connectDeviceWithParams:success:failure:
 
(void) - connectDeviceWithParams:success:failure:
 
(void) - disconnect:
 
(void) - disconnect:
 
(void) - disconnect:
 
(void) - disconnect:
 
(ThingDoorBellError- answerDoorBellCallWithType:messageId:
 
(ThingDoorBellError- answerDoorBellCallWithType:messageId:
 
(ThingDoorBellError- hangupDoorBellCallWithType:messageId:
 
(ThingDoorBellError- hangupDoorBellCallWithType:messageId:
 
(ThingDoorBellError- sendHeartbeatWithType:messageId:
 
(ThingDoorBellError- sendHeartbeatWithType:messageId:
 
(void) - handleRemoteControlGroup:success:failure:
 
(void) - handleRemoteControlGroup:success:failure:
 
(void) - handleRemoteControlGroup:success:failure:
 
(void) - handleRemoteControlGroup:success:failure:
 
(void) - updateLocalKeySuccess:failure:
 Update device local key. More...
 
(void) - updateLocalKeySuccess:failure:
 Update device local key. More...
 
(void) - updateLocalKeySuccess:failure:
 Update device local key. More...
 
(void) - updateLocalKeySuccess:failure:
 Update device local key. More...
 
(void) - getOfflineReminderSupportStatusWithSuccess:failure:
 
(void) - getOfflineReminderSupportStatusWithSuccess:failure:
 
(void) - getOfflineReminderSupportStatusWithSuccess:failure:
 
(void) - getOfflineReminderSupportStatusWithSuccess:failure:
 
(void) - getOfflineReminderStatusWithSuccess:failure:
 
(void) - getOfflineReminderStatusWithSuccess:failure:
 
(void) - getOfflineReminderStatusWithSuccess:failure:
 
(void) - getOfflineReminderStatusWithSuccess:failure:
 
(void) - setOfflineReminderStatus:success:failure:
 
(void) - setOfflineReminderStatus:success:failure:
 
(void) - setOfflineReminderStatus:success:failure:
 
(void) - setOfflineReminderStatus:success:failure:
 
(void) - requestCachedDps:failure:
 
(void) - requestCachedDps:failure:
 
(void) - pushDpsWithHttp:success:failure:
 
(void) - pushDpsWithHttp:success:failure:
 
(void) - checkFirmwareUpgrade:failure:
 
(void) - checkFirmwareUpgrade:failure:
 
(void) - checkFirmwareUpgrade:failure:
 
(void) - checkFirmwareUpgrade:failure:
 
(void) - checkFirmwareUpgradeWithExtraInfo:success:failure:
 
(void) - checkFirmwareUpgradeWithExtraInfo:success:failure:
 
(void) - checkFirmwareUpgradeWithExtraInfo:success:failure:
 
(void) - checkFirmwareUpgradeWithExtraInfo:success:failure:
 
(void) - startFirmwareUpgrade:
 
(void) - startFirmwareUpgrade:
 
(void) - startFirmwareUpgrade:
 
(void) - startFirmwareUpgrade:
 
(void) - confirmWarningUpgradeTask:
 
(void) - confirmWarningUpgradeTask:
 
(void) - confirmWarningUpgradeTask:
 
(void) - confirmWarningUpgradeTask:
 
(void) - cancelFirmwareUpgrade:failure:
 
(void) - cancelFirmwareUpgrade:failure:
 
(void) - cancelFirmwareUpgrade:failure:
 
(void) - cancelFirmwareUpgrade:failure:
 
(void) - getFirmwareUpgradingStatus:failure:
 
(void) - getFirmwareUpgradingStatus:failure:
 
(void) - getFirmwareUpgradingStatus:failure:
 
(void) - getFirmwareUpgradingStatus:failure:
 
(void) - getDeviceLocalFirmwareInfo:failure:
 
(void) - getDeviceLocalFirmwareInfo:failure:
 
(void) - getDeviceLocalFirmwareInfo:failure:
 
(void) - getDeviceLocalFirmwareInfo:failure:
 
(BOOL) - isSupportCheckFirmware
 Determine if the device can check the firmware. More...
 
(BOOL) - isSupportCheckFirmware
 Determine if the device can check the firmware. More...
 
(BOOL) - isSupportCheckFirmware
 Determine if the device can check the firmware. More...
 
(BOOL) - isSupportCheckFirmware
 Determine if the device can check the firmware. More...
 
(void) - memberCheckFirmwareStatus:failure:
 
(void) - memberCheckFirmwareStatus:failure:
 
(void) - memberCheckFirmwareStatus:failure:
 
(void) - memberCheckFirmwareStatus:failure:
 
(void) - updateBootOTAWithSingleBootStatus:
 
(void) - updateBootOTAWithSingleBootStatus:
 
(void) - updateBootOTAWithSingleBootStatus:
 
(void) - updateBootOTAWithSingleBootStatus:
 
(void) - getShareInfoWithSuccess:failure:
 
(void) - getShareInfoWithSuccess:failure:
 
(void) - getShareInfoWithSuccess:failure:
 
(void) - getShareInfoWithSuccess:failure:
 
(void) - removeReceiveDeviceShareWithSuccess:failure:
 
(void) - removeReceiveDeviceShareWithSuccess:failure:
 
(void) - removeReceiveDeviceShareWithSuccess:failure:
 
(void) - removeReceiveDeviceShareWithSuccess:failure:
 
(void) - tsod_publishDPWithCode:DPValue:success:failure:
 
(void) - tsod_publishDPWithCode:DPValue:success:failure:
 

Class Methods

(nullable instancetype) + deviceWithDeviceId:
 
(void) + syncDeviceInfoWithDevId:success:failure:
 
(void) + syncSubDeviceInfoWithGatewayId:devId:success:failure:
 
(void) + syncSubDeviceLocalKeyWithGatewayId:nodeIds:success:failure:
 
(void) + getThingModelWithProductId:productVersion:success:failure:
 
(nullable instancetype) + deviceWithDeviceId:
 
(void) + syncDeviceInfoWithDevId:success:failure:
 
(void) + syncSubDeviceInfoWithGatewayId:devId:success:failure:
 
(void) + syncSubDeviceLocalKeyWithGatewayId:nodeIds:success:failure:
 
(void) + getThingModelWithProductId:productVersion:success:failure:
 
(nullable instancetype) + deviceWithDeviceId:
 
(void) + syncDeviceInfoWithDevId:success:failure:
 
(void) + syncSubDeviceInfoWithGatewayId:devId:success:failure:
 
(void) + syncSubDeviceLocalKeyWithGatewayId:nodeIds:success:failure:
 
(void) + getThingModelWithProductId:productVersion:success:failure:
 
(nullable instancetype) + deviceWithDeviceId:
 
(void) + syncDeviceInfoWithDevId:success:failure:
 
(void) + syncSubDeviceInfoWithGatewayId:devId:success:failure:
 
(void) + syncSubDeviceLocalKeyWithGatewayId:nodeIds:success:failure:
 
(void) + getThingModelWithProductId:productVersion:success:failure:
 
(void) + syncDeviceInfoWithDevId:homeId:success:failure:
 
(void) + syncDeviceInfoWithDevId:homeId:success:failure:
 
(void) + syncDeviceInfoWithDevId:homeId:success:failure:
 
(void) + syncDeviceInfoWithDevId:homeId:success:failure:
 

Properties

NSString * devId
 Returns the device id. More...
 
ThingSmartDeviceModeldeviceModel
 Returns the model of basic device information. More...
 
id< ThingSmartDeviceDelegatedelegate
 

Detailed Description

The basic operation class of ThingSmartDevice contains the model of basic information, including the device, DPs to send, update device information, and other common API operations.

All types of devices can be controlled after you initialize an instance of this class if the function is supported.

Definition at line 196 of file ThingSmartDevice.h.

Method Documentation

◆ __deprecated_msg [1/4]

- ("This method is deprecated") __deprecated_msg

Cancels the firmware update request.

◆ __deprecated_msg [2/4]

- ("This method is deprecated") __deprecated_msg

Cancels the firmware update request.

◆ __deprecated_msg [3/4]

- ("This method is deprecated") __deprecated_msg

Cancels the firmware update request.

◆ __deprecated_msg [4/4]

- ("This method is deprecated") __deprecated_msg

Cancels the firmware update request.

◆ answerDoorBellCallWithType:messageId: [1/2]

- (ThingDoorBellError) answerDoorBellCallWithType: (ThingSmartDoorBellType)  type
messageId: (NSString *)  messageId 

Provided by category ThingSmartDevice(doorbell).

◆ answerDoorBellCallWithType:messageId: [2/2]

- (ThingDoorBellError) answerDoorBellCallWithType: (ThingSmartDoorBellType)  type
messageId: (NSString *)  messageId 

Provided by category ThingSmartDevice(doorbell).

◆ cancelFirmwareUpgrade:failure: [1/4]

- (void) cancelFirmwareUpgrade: (ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Cancel firmware upgrade Notice: it only support for the task status equal to ThingSmartDeviceUpgradeStatusWaitingExectue

Provided by category ThingSmartDevice(OTA).

◆ cancelFirmwareUpgrade:failure: [2/4]

- (void) cancelFirmwareUpgrade: (ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Cancel firmware upgrade Notice: it only support for the task status equal to ThingSmartDeviceUpgradeStatusWaitingExectue

Provided by category ThingSmartDevice(OTA).

◆ cancelFirmwareUpgrade:failure: [3/4]

- (void) cancelFirmwareUpgrade: (ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Cancel firmware upgrade Notice: it only support for the task status equal to ThingSmartDeviceUpgradeStatusWaitingExectue

Provided by category ThingSmartDevice(OTA).

◆ cancelFirmwareUpgrade:failure: [4/4]

- (void) cancelFirmwareUpgrade: (ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Cancel firmware upgrade Notice: it only support for the task status equal to ThingSmartDeviceUpgradeStatusWaitingExectue

Provided by category ThingSmartDevice(OTA).

◆ cancelUpgradeFirmware:success:failure: [1/4]

- (void) cancelUpgradeFirmware: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice cancelFirmwareUpgrade:failure:] 

Cancels the firmware updates. Only the update tasks that have not been published can be canceled.

Parameters
typeThe device type of ThingSmartFirmwareUpgradeModel.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ cancelUpgradeFirmware:success:failure: [2/4]

- (void) cancelUpgradeFirmware: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice cancelFirmwareUpgrade:failure:] 

Cancels the firmware updates. Only the update tasks that have not been published can be canceled.

Parameters
typeThe device type of ThingSmartFirmwareUpgradeModel.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ cancelUpgradeFirmware:success:failure: [3/4]

- (void) cancelUpgradeFirmware: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice cancelFirmwareUpgrade:failure:] 

Cancels the firmware updates. Only the update tasks that have not been published can be canceled.

Parameters
typeThe device type of ThingSmartFirmwareUpgradeModel.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ cancelUpgradeFirmware:success:failure: [4/4]

- (void) cancelUpgradeFirmware: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice cancelFirmwareUpgrade:failure:] 

Cancels the firmware updates. Only the update tasks that have not been published can be canceled.

Parameters
typeThe device type of ThingSmartFirmwareUpgradeModel.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ checkFirmwareUpgrade:failure: [1/4]

- (void) checkFirmwareUpgrade: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *firmwares))  success
failure: (nullable ThingFailureError failure 

Returns firmware upgrade information. ( for general device.) Contains current firmwares and upgradeable firmwares. Notice: equal to checkFirmwareUpgradeWithExtraInfo:nil success:success failure:failure

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ checkFirmwareUpgrade:failure: [2/4]

- (void) checkFirmwareUpgrade: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *firmwares))  success
failure: (nullable ThingFailureError failure 

Returns firmware upgrade information. ( for general device.) Contains current firmwares and upgradeable firmwares. Notice: equal to checkFirmwareUpgradeWithExtraInfo:nil success:success failure:failure

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ checkFirmwareUpgrade:failure: [3/4]

- (void) checkFirmwareUpgrade: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *firmwares))  success
failure: (nullable ThingFailureError failure 

Returns firmware upgrade information. ( for general device.) Contains current firmwares and upgradeable firmwares. Notice: equal to checkFirmwareUpgradeWithExtraInfo:nil success:success failure:failure

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ checkFirmwareUpgrade:failure: [4/4]

- (void) checkFirmwareUpgrade: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *firmwares))  success
failure: (nullable ThingFailureError failure 

Returns firmware upgrade information. ( for general device.) Contains current firmwares and upgradeable firmwares. Notice: equal to checkFirmwareUpgradeWithExtraInfo:nil success:success failure:failure

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ checkFirmwareUpgradeWithExtraInfo:success:failure: [1/4]

- (void) checkFirmwareUpgradeWithExtraInfo: (nullable NSDictionary *)  extraInfo
success: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *firmwares))  success
failure: (nullable ThingFailureError failure 

Returns firmware upgrade information. ( for general device and some special device. ) Contains current firmwares and upgradeable firmwares. Exta info's ussage:

  1. extra info = nil For most general device.
  2. extra info = {"types": "0,1, ....", "versions": "0.0.1,0.0.2, ...."}. For the AP Directly device, which used local lan to upgrade. You can use -getDeviceLocalFirmwareInfo:failure: to get and cached the info type & currentVersion.
    Parameters
    extraInfoSome special device need extra info to check firmwares.
    successCalled when the task is finished.
    failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ checkFirmwareUpgradeWithExtraInfo:success:failure: [2/4]

- (void) checkFirmwareUpgradeWithExtraInfo: (nullable NSDictionary *)  extraInfo
success: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *firmwares))  success
failure: (nullable ThingFailureError failure 

Returns firmware upgrade information. ( for general device and some special device. ) Contains current firmwares and upgradeable firmwares. Exta info's ussage:

  1. extra info = nil For most general device.
  2. extra info = {"types": "0,1, ....", "versions": "0.0.1,0.0.2, ...."}. For the AP Directly device, which used local lan to upgrade. You can use -getDeviceLocalFirmwareInfo:failure: to get and cached the info type & currentVersion.
    Parameters
    extraInfoSome special device need extra info to check firmwares.
    successCalled when the task is finished.
    failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ checkFirmwareUpgradeWithExtraInfo:success:failure: [3/4]

- (void) checkFirmwareUpgradeWithExtraInfo: (nullable NSDictionary *)  extraInfo
success: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *firmwares))  success
failure: (nullable ThingFailureError failure 

Returns firmware upgrade information. ( for general device and some special device. ) Contains current firmwares and upgradeable firmwares. Exta info's ussage:

  1. extra info = nil For most general device.
  2. extra info = {"types": "0,1, ....", "versions": "0.0.1,0.0.2, ...."}. For the AP Directly device, which used local lan to upgrade. You can use -getDeviceLocalFirmwareInfo:failure: to get and cached the info type & currentVersion.
    Parameters
    extraInfoSome special device need extra info to check firmwares.
    successCalled when the task is finished.
    failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ checkFirmwareUpgradeWithExtraInfo:success:failure: [4/4]

- (void) checkFirmwareUpgradeWithExtraInfo: (nullable NSDictionary *)  extraInfo
success: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *firmwares))  success
failure: (nullable ThingFailureError failure 

Returns firmware upgrade information. ( for general device and some special device. ) Contains current firmwares and upgradeable firmwares. Exta info's ussage:

  1. extra info = nil For most general device.
  2. extra info = {"types": "0,1, ....", "versions": "0.0.1,0.0.2, ...."}. For the AP Directly device, which used local lan to upgrade. You can use -getDeviceLocalFirmwareInfo:failure: to get and cached the info type & currentVersion.
    Parameters
    extraInfoSome special device need extra info to check firmwares.
    successCalled when the task is finished.
    failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ confirmWarningUpgradeTask: [1/4]

- (void) confirmWarningUpgradeTask: (BOOL)  isContinue

Confirm continue or not when a upgrading task callback the warning error ThingOTAErrorCodeSignalStrengthNotSatisfy.

Parameters
isContinuecontinue or not.

Provided by category ThingSmartDevice(OTA).

◆ confirmWarningUpgradeTask: [2/4]

- (void) confirmWarningUpgradeTask: (BOOL)  isContinue

Confirm continue or not when a upgrading task callback the warning error ThingOTAErrorCodeSignalStrengthNotSatisfy.

Parameters
isContinuecontinue or not.

Provided by category ThingSmartDevice(OTA).

◆ confirmWarningUpgradeTask: [3/4]

- (void) confirmWarningUpgradeTask: (BOOL)  isContinue

Confirm continue or not when a upgrading task callback the warning error ThingOTAErrorCodeSignalStrengthNotSatisfy.

Parameters
isContinuecontinue or not.

Provided by category ThingSmartDevice(OTA).

◆ confirmWarningUpgradeTask: [4/4]

- (void) confirmWarningUpgradeTask: (BOOL)  isContinue

Confirm continue or not when a upgrading task callback the warning error ThingOTAErrorCodeSignalStrengthNotSatisfy.

Parameters
isContinuecontinue or not.

Provided by category ThingSmartDevice(OTA).

◆ connectDeviceWithParams:success:failure: [1/4]

- (void) connectDeviceWithParams: (ThingDeviceConnectParams *)  connectParams
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

connect device with params

Parameters
successsuccess
failurefailure

Provided by category ThingSmartDevice(Connect).

◆ connectDeviceWithParams:success:failure: [2/4]

- (void) connectDeviceWithParams: (ThingDeviceConnectParams *)  connectParams
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

connect device with params

Parameters
successsuccess
failurefailure

Provided by category ThingSmartDevice(Connect).

◆ connectDeviceWithParams:success:failure: [3/4]

- (void) connectDeviceWithParams: (ThingDeviceConnectParams *)  connectParams
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

connect device with params

Parameters
successsuccess
failurefailure

Provided by category ThingSmartDevice(Connect).

◆ connectDeviceWithParams:success:failure: [4/4]

- (void) connectDeviceWithParams: (ThingDeviceConnectParams *)  connectParams
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

connect device with params

Parameters
successsuccess
failurefailure

Provided by category ThingSmartDevice(Connect).

◆ deviceWithDeviceId: [1/4]

+ (nullable instancetype) deviceWithDeviceId: (NSString *)  devId

Returns the ThingSmartDevice instance. If the current user does not have this device, a value of nil is returned.

Parameters
devIdThe device ID.

◆ deviceWithDeviceId: [2/4]

+ (nullable instancetype) deviceWithDeviceId: (NSString *)  devId

Returns the ThingSmartDevice instance. If the current user does not have this device, a value of nil is returned.

Parameters
devIdThe device ID.

◆ deviceWithDeviceId: [3/4]

+ (nullable instancetype) deviceWithDeviceId: (NSString *)  devId

Returns the ThingSmartDevice instance. If the current user does not have this device, a value of nil is returned.

Parameters
devIdThe device ID.

◆ deviceWithDeviceId: [4/4]

+ (nullable instancetype) deviceWithDeviceId: (NSString *)  devId

Returns the ThingSmartDevice instance. If the current user does not have this device, a value of nil is returned.

Parameters
devIdThe device ID.

◆ disconnect: [1/4]

- (void) disconnect: (ThingDeviceDisconnectParams *)  disconnectParams

Disconnect the device. Note If the sigmesh device is used, the sigmesh network is disconnected

Parameters
disconnectParamsdisconnectParams

Provided by category ThingSmartDevice(Connect).

◆ disconnect: [2/4]

- (void) disconnect: (ThingDeviceDisconnectParams *)  disconnectParams

Disconnect the device. Note If the sigmesh device is used, the sigmesh network is disconnected

Parameters
disconnectParamsdisconnectParams

Provided by category ThingSmartDevice(Connect).

◆ disconnect: [3/4]

- (void) disconnect: (ThingDeviceDisconnectParams *)  disconnectParams

Disconnect the device. Note If the sigmesh device is used, the sigmesh network is disconnected

Parameters
disconnectParamsdisconnectParams

Provided by category ThingSmartDevice(Connect).

◆ disconnect: [4/4]

- (void) disconnect: (ThingDeviceDisconnectParams *)  disconnectParams

Disconnect the device. Note If the sigmesh device is used, the sigmesh network is disconnected

Parameters
disconnectParamsdisconnectParams

Provided by category ThingSmartDevice(Connect).

◆ getAutoUpgradeSwitchInfoWithSuccess:failure: [1/4]

- (void) getAutoUpgradeSwitchInfoWithSuccess: (nullable ThingSuccessID success
failure: (nullable ThingFailureError failure 

Returns the switch value for the automatic device OTA updates.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getAutoUpgradeSwitchInfoWithSuccess:failure: [2/4]

- (void) getAutoUpgradeSwitchInfoWithSuccess: (nullable ThingSuccessID success
failure: (nullable ThingFailureError failure 

Returns the switch value for the automatic device OTA updates.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getAutoUpgradeSwitchInfoWithSuccess:failure: [3/4]

- (void) getAutoUpgradeSwitchInfoWithSuccess: (nullable ThingSuccessID success
failure: (nullable ThingFailureError failure 

Returns the switch value for the automatic device OTA updates.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getAutoUpgradeSwitchInfoWithSuccess:failure: [4/4]

- (void) getAutoUpgradeSwitchInfoWithSuccess: (nullable ThingSuccessID success
failure: (nullable ThingFailureError failure 

Returns the switch value for the automatic device OTA updates.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getDeviceLocalFirmwareInfo:failure: [1/4]

- (void) getDeviceLocalFirmwareInfo: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *infos))  success
failure: (ThingFailureError failure 

Fetch the device's local firmware version info. ( now only used for the AP Directly device ) Notice:

  1. The device need link to app by the LAN.
  2. get avaliable infos from the model.type and model.currentVersion properties.
    Parameters
    successCalled when the task is finished.
    failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ getDeviceLocalFirmwareInfo:failure: [2/4]

- (void) getDeviceLocalFirmwareInfo: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *infos))  success
failure: (ThingFailureError failure 

Fetch the device's local firmware version info. ( now only used for the AP Directly device ) Notice:

  1. The device need link to app by the LAN.
  2. get avaliable infos from the model.type and model.currentVersion properties.
    Parameters
    successCalled when the task is finished.
    failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ getDeviceLocalFirmwareInfo:failure: [3/4]

- (void) getDeviceLocalFirmwareInfo: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *infos))  success
failure: (ThingFailureError failure 

Fetch the device's local firmware version info. ( now only used for the AP Directly device ) Notice:

  1. The device need link to app by the LAN.
  2. get avaliable infos from the model.type and model.currentVersion properties.
    Parameters
    successCalled when the task is finished.
    failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ getDeviceLocalFirmwareInfo:failure: [4/4]

- (void) getDeviceLocalFirmwareInfo: (void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *infos))  success
failure: (ThingFailureError failure 

Fetch the device's local firmware version info. ( now only used for the AP Directly device ) Notice:

  1. The device need link to app by the LAN.
  2. get avaliable infos from the model.type and model.currentVersion properties.
    Parameters
    successCalled when the task is finished.
    failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ getDevPropertyWithSuccess:failure: [1/4]

- (void) getDevPropertyWithSuccess: (ThingSuccessDict success
failure: (nullable ThingFailureError failure 

Manages the device custom data, such as recording and storing of custom data information.

Parameters
successCalled when the task is finished. The device property is returned.
failureCalled when the task is interrupted by an error.

◆ getDevPropertyWithSuccess:failure: [2/4]

- (void) getDevPropertyWithSuccess: (ThingSuccessDict success
failure: (nullable ThingFailureError failure 

Manages the device custom data, such as recording and storing of custom data information.

Parameters
successCalled when the task is finished. The device property is returned.
failureCalled when the task is interrupted by an error.

◆ getDevPropertyWithSuccess:failure: [3/4]

- (void) getDevPropertyWithSuccess: (ThingSuccessDict success
failure: (nullable ThingFailureError failure 

Manages the device custom data, such as recording and storing of custom data information.

Parameters
successCalled when the task is finished. The device property is returned.
failureCalled when the task is interrupted by an error.

◆ getDevPropertyWithSuccess:failure: [4/4]

- (void) getDevPropertyWithSuccess: (ThingSuccessDict success
failure: (nullable ThingFailureError failure 

Manages the device custom data, such as recording and storing of custom data information.

Parameters
successCalled when the task is finished. The device property is returned.
failureCalled when the task is interrupted by an error.

◆ getFirmwareUpgradeInfo:failure: [1/4]

- (void) getFirmwareUpgradeInfo: (nullable void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *upgradeModelList))  success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice checkFirmwareUpgrade:failure:] 

Returns firmware update information.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getFirmwareUpgradeInfo:failure: [2/4]

- (void) getFirmwareUpgradeInfo: (nullable void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *upgradeModelList))  success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice checkFirmwareUpgrade:failure:] 

Returns firmware update information.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getFirmwareUpgradeInfo:failure: [3/4]

- (void) getFirmwareUpgradeInfo: (nullable void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *upgradeModelList))  success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice checkFirmwareUpgrade:failure:] 

Returns firmware update information.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getFirmwareUpgradeInfo:failure: [4/4]

- (void) getFirmwareUpgradeInfo: (nullable void(^)(NSArray< ThingSmartFirmwareUpgradeModel * > *upgradeModelList))  success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice checkFirmwareUpgrade:failure:] 

Returns firmware update information.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getFirmwareUpgradingStatus:failure: [1/4]

- (void) getFirmwareUpgradingStatus: (void(^)(ThingSmartFirmwareUpgradeStatusModel *status))  success
failure: (nullable ThingFailureError failure 

Fetch the firmware upgrading task's status or progress. ( progress maybe 0 ) Notice: it only support for the task status equal to ThingSmartDeviceUpgradeStatusUpgrading or ThingSmartDeviceUpgradeStatusWaitingExectue

Parameters
successCalled when the task's status/progress can provide
failureCalled when the task's status/progress can't provide

Provided by category ThingSmartDevice(OTA).

◆ getFirmwareUpgradingStatus:failure: [2/4]

- (void) getFirmwareUpgradingStatus: (void(^)(ThingSmartFirmwareUpgradeStatusModel *status))  success
failure: (nullable ThingFailureError failure 

Fetch the firmware upgrading task's status or progress. ( progress maybe 0 ) Notice: it only support for the task status equal to ThingSmartDeviceUpgradeStatusUpgrading or ThingSmartDeviceUpgradeStatusWaitingExectue

Parameters
successCalled when the task's status/progress can provide
failureCalled when the task's status/progress can't provide

Provided by category ThingSmartDevice(OTA).

◆ getFirmwareUpgradingStatus:failure: [3/4]

- (void) getFirmwareUpgradingStatus: (void(^)(ThingSmartFirmwareUpgradeStatusModel *status))  success
failure: (nullable ThingFailureError failure 

Fetch the firmware upgrading task's status or progress. ( progress maybe 0 ) Notice: it only support for the task status equal to ThingSmartDeviceUpgradeStatusUpgrading or ThingSmartDeviceUpgradeStatusWaitingExectue

Parameters
successCalled when the task's status/progress can provide
failureCalled when the task's status/progress can't provide

Provided by category ThingSmartDevice(OTA).

◆ getFirmwareUpgradingStatus:failure: [4/4]

- (void) getFirmwareUpgradingStatus: (void(^)(ThingSmartFirmwareUpgradeStatusModel *status))  success
failure: (nullable ThingFailureError failure 

Fetch the firmware upgrading task's status or progress. ( progress maybe 0 ) Notice: it only support for the task status equal to ThingSmartDeviceUpgradeStatusUpgrading or ThingSmartDeviceUpgradeStatusWaitingExectue

Parameters
successCalled when the task's status/progress can provide
failureCalled when the task's status/progress can't provide

Provided by category ThingSmartDevice(OTA).

◆ getOfflineReminderStatusWithSuccess:failure: [1/4]

- (void) getOfflineReminderStatusWithSuccess: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Returns the device offline notification status.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ getOfflineReminderStatusWithSuccess:failure: [2/4]

- (void) getOfflineReminderStatusWithSuccess: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Returns the device offline notification status.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ getOfflineReminderStatusWithSuccess:failure: [3/4]

- (void) getOfflineReminderStatusWithSuccess: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Returns the device offline notification status.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ getOfflineReminderStatusWithSuccess:failure: [4/4]

- (void) getOfflineReminderStatusWithSuccess: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Returns the device offline notification status.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ getOfflineReminderSupportStatusWithSuccess:failure: [1/4]

- (void) getOfflineReminderSupportStatusWithSuccess: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Checks whether the device supports offline alerts.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ getOfflineReminderSupportStatusWithSuccess:failure: [2/4]

- (void) getOfflineReminderSupportStatusWithSuccess: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Checks whether the device supports offline alerts.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ getOfflineReminderSupportStatusWithSuccess:failure: [3/4]

- (void) getOfflineReminderSupportStatusWithSuccess: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Checks whether the device supports offline alerts.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ getOfflineReminderSupportStatusWithSuccess:failure: [4/4]

- (void) getOfflineReminderSupportStatusWithSuccess: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Checks whether the device supports offline alerts.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ getShareInfoWithSuccess:failure: [1/4]

- (void) getShareInfoWithSuccess: (void(^)(ThingSmartReceivedShareUserModel *model))  success
failure: (ThingFailureError failure 

Get users for device sharing.

Parameters
successCalled when the task finishes successfully. ThingSmartReceivedShareUserModel will be returned.
failureIf error occurred while adding the task, this block will be called.

Provided by category ThingSmartDevice(ShareInfo).

◆ getShareInfoWithSuccess:failure: [2/4]

- (void) getShareInfoWithSuccess: (void(^)(ThingSmartReceivedShareUserModel *model))  success
failure: (ThingFailureError failure 

Get users for device sharing.

Parameters
successCalled when the task finishes successfully. ThingSmartReceivedShareUserModel will be returned.
failureIf error occurred while adding the task, this block will be called.

Provided by category ThingSmartDevice(ShareInfo).

◆ getShareInfoWithSuccess:failure: [3/4]

- (void) getShareInfoWithSuccess: (void(^)(ThingSmartReceivedShareUserModel *model))  success
failure: (ThingFailureError failure 

Get users for device sharing.

Parameters
successCalled when the task finishes successfully. ThingSmartReceivedShareUserModel will be returned.
failureIf error occurred while adding the task, this block will be called.

Provided by category ThingSmartDevice(ShareInfo).

◆ getShareInfoWithSuccess:failure: [4/4]

- (void) getShareInfoWithSuccess: (void(^)(ThingSmartReceivedShareUserModel *model))  success
failure: (ThingFailureError failure 

Get users for device sharing.

Parameters
successCalled when the task finishes successfully. ThingSmartReceivedShareUserModel will be returned.
failureIf error occurred while adding the task, this block will be called.

Provided by category ThingSmartDevice(ShareInfo).

◆ getSubDeviceListFromCloudWithSuccess:failure: [1/4]

- (void) getSubDeviceListFromCloudWithSuccess: (nullable void(^)(NSArray< ThingSmartDeviceModel * > *subDeviceList))  success
failure: (nullable ThingFailureError failure 

Returns a sub-device list of the current gateway.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getSubDeviceListFromCloudWithSuccess:failure: [2/4]

- (void) getSubDeviceListFromCloudWithSuccess: (nullable void(^)(NSArray< ThingSmartDeviceModel * > *subDeviceList))  success
failure: (nullable ThingFailureError failure 

Returns a sub-device list of the current gateway.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getSubDeviceListFromCloudWithSuccess:failure: [3/4]

- (void) getSubDeviceListFromCloudWithSuccess: (nullable void(^)(NSArray< ThingSmartDeviceModel * > *subDeviceList))  success
failure: (nullable ThingFailureError failure 

Returns a sub-device list of the current gateway.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getSubDeviceListFromCloudWithSuccess:failure: [4/4]

- (void) getSubDeviceListFromCloudWithSuccess: (nullable void(^)(NSArray< ThingSmartDeviceModel * > *subDeviceList))  success
failure: (nullable ThingFailureError failure 

Returns a sub-device list of the current gateway.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getThingModelWithProductId:productVersion:success:failure: [1/4]

+ (void) getThingModelWithProductId: (NSString *)  pid
productVersion: (NSString *)  productVersion
success: (nullable void(^)(ThingSmartThingModel *_Nullable thingModel))  success
failure: (nullable ThingFailureError failure 

Get thing model from cloud and update cache.

Parameters
pidproductId
productVersionproduct version
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getThingModelWithProductId:productVersion:success:failure: [2/4]

+ (void) getThingModelWithProductId: (NSString *)  pid
productVersion: (NSString *)  productVersion
success: (nullable void(^)(ThingSmartThingModel *_Nullable thingModel))  success
failure: (nullable ThingFailureError failure 

Get thing model from cloud and update cache.

Parameters
pidproductId
productVersionproduct version
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getThingModelWithProductId:productVersion:success:failure: [3/4]

+ (void) getThingModelWithProductId: (NSString *)  pid
productVersion: (NSString *)  productVersion
success: (nullable void(^)(ThingSmartThingModel *_Nullable thingModel))  success
failure: (nullable ThingFailureError failure 

Get thing model from cloud and update cache.

Parameters
pidproductId
productVersionproduct version
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getThingModelWithProductId:productVersion:success:failure: [4/4]

+ (void) getThingModelWithProductId: (NSString *)  pid
productVersion: (NSString *)  productVersion
success: (nullable void(^)(ThingSmartThingModel *_Nullable thingModel))  success
failure: (nullable ThingFailureError failure 

Get thing model from cloud and update cache.

Parameters
pidproductId
productVersionproduct version
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getThingModelWithSuccess:failure: [1/4]

- (void) getThingModelWithSuccess: (nullable void(^)(ThingSmartThingModel *_Nullable thingModel))  success
failure: (nullable ThingFailureError failure 

Get thing model from cloud and update cache.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getThingModelWithSuccess:failure: [2/4]

- (void) getThingModelWithSuccess: (nullable void(^)(ThingSmartThingModel *_Nullable thingModel))  success
failure: (nullable ThingFailureError failure 

Get thing model from cloud and update cache.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getThingModelWithSuccess:failure: [3/4]

- (void) getThingModelWithSuccess: (nullable void(^)(ThingSmartThingModel *_Nullable thingModel))  success
failure: (nullable ThingFailureError failure 

Get thing model from cloud and update cache.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ getThingModelWithSuccess:failure: [4/4]

- (void) getThingModelWithSuccess: (nullable void(^)(ThingSmartThingModel *_Nullable thingModel))  success
failure: (nullable ThingFailureError failure 

Get thing model from cloud and update cache.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ handleRemoteControlGroup:success:failure: [1/4]

- (void) handleRemoteControlGroup: (ThingSmartRemoteControlAuthParams *)  remoteControlModel
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Provided by category ThingSmartDevice(FittingDevice).

◆ handleRemoteControlGroup:success:failure: [2/4]

- (void) handleRemoteControlGroup: (ThingSmartRemoteControlAuthParams *)  remoteControlModel
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Provided by category ThingSmartDevice(FittingDevice).

◆ handleRemoteControlGroup:success:failure: [3/4]

- (void) handleRemoteControlGroup: (ThingSmartRemoteControlAuthParams *)  remoteControlModel
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Provided by category ThingSmartDevice(FittingDevice).

◆ handleRemoteControlGroup:success:failure: [4/4]

- (void) handleRemoteControlGroup: (ThingSmartRemoteControlAuthParams *)  remoteControlModel
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Provided by category ThingSmartDevice(FittingDevice).

◆ hangupDoorBellCallWithType:messageId: [1/2]

- (ThingDoorBellError) hangupDoorBellCallWithType: (ThingSmartDoorBellType)  type
messageId: (NSString *)  messageId 

Provided by category ThingSmartDevice(doorbell).

◆ hangupDoorBellCallWithType:messageId: [2/2]

- (ThingDoorBellError) hangupDoorBellCallWithType: (ThingSmartDoorBellType)  type
messageId: (NSString *)  messageId 

Provided by category ThingSmartDevice(doorbell).

◆ infraredPublishDps:actionDps:reportDps:success:failure: [1/4]

- (void) infraredPublishDps: (NSString *)  subDevId
actionDps: (NSDictionary *)  actionDps
reportDps: (NSDictionary *)  reportDps
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Suitable infrared control device publish dps. When publish success, will update dps to cloud and local manually.

**Note: Only suitable for infrared device. **

Parameters
subDevIdThe sub device id.
actionDpsThe action dps.
reportDpsThe report dps.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ infraredPublishDps:actionDps:reportDps:success:failure: [2/4]

- (void) infraredPublishDps: (NSString *)  subDevId
actionDps: (NSDictionary *)  actionDps
reportDps: (NSDictionary *)  reportDps
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Suitable infrared control device publish dps. When publish success, will update dps to cloud and local manually.

**Note: Only suitable for infrared device. **

Parameters
subDevIdThe sub device id.
actionDpsThe action dps.
reportDpsThe report dps.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ infraredPublishDps:actionDps:reportDps:success:failure: [3/4]

- (void) infraredPublishDps: (NSString *)  subDevId
actionDps: (NSDictionary *)  actionDps
reportDps: (NSDictionary *)  reportDps
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Suitable infrared control device publish dps. When publish success, will update dps to cloud and local manually.

**Note: Only suitable for infrared device. **

Parameters
subDevIdThe sub device id.
actionDpsThe action dps.
reportDpsThe report dps.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ infraredPublishDps:actionDps:reportDps:success:failure: [4/4]

- (void) infraredPublishDps: (NSString *)  subDevId
actionDps: (NSDictionary *)  actionDps
reportDps: (NSDictionary *)  reportDps
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Suitable infrared control device publish dps. When publish success, will update dps to cloud and local manually.

**Note: Only suitable for infrared device. **

Parameters
subDevIdThe sub device id.
actionDpsThe action dps.
reportDpsThe report dps.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ initWithDeviceId: [1/4]

- (nullable instancetype) initWithDeviceId: (NSString *)  NS_DESIGNATED_INITIALIZER

Returns the ThingSmartDevice instance. If the current user does not have this device, a value of nil is returned.

Parameters
devIdThe device ID.

Implemented in ThingSmartWiFiLockDevice, and ThingSmartWiFiLockDevice.

◆ initWithDeviceId: [2/4]

- (nullable instancetype) initWithDeviceId: (NSString *)  NS_DESIGNATED_INITIALIZER

Returns the ThingSmartDevice instance. If the current user does not have this device, a value of nil is returned.

Parameters
devIdThe device ID.

Implemented in ThingSmartWiFiLockDevice, and ThingSmartWiFiLockDevice.

◆ initWithDeviceId: [3/4]

- (nullable instancetype) initWithDeviceId: (NSString *)  NS_DESIGNATED_INITIALIZER

Returns the ThingSmartDevice instance. If the current user does not have this device, a value of nil is returned.

Parameters
devIdThe device ID.

Implemented in ThingSmartWiFiLockDevice, and ThingSmartWiFiLockDevice.

◆ initWithDeviceId: [4/4]

- (nullable instancetype) initWithDeviceId: (NSString *)  NS_DESIGNATED_INITIALIZER

Returns the ThingSmartDevice instance. If the current user does not have this device, a value of nil is returned.

Parameters
devIdThe device ID.

Implemented in ThingSmartWiFiLockDevice, and ThingSmartWiFiLockDevice.

◆ isSupportCheckFirmware [1/4]

- (BOOL) isSupportCheckFirmware

Determine if the device can check the firmware.

Provided by category ThingSmartDevice(OTA).

◆ isSupportCheckFirmware [2/4]

- (BOOL) isSupportCheckFirmware

Determine if the device can check the firmware.

Provided by category ThingSmartDevice(OTA).

◆ isSupportCheckFirmware [3/4]

- (BOOL) isSupportCheckFirmware

Determine if the device can check the firmware.

Provided by category ThingSmartDevice(OTA).

◆ isSupportCheckFirmware [4/4]

- (BOOL) isSupportCheckFirmware

Determine if the device can check the firmware.

Provided by category ThingSmartDevice(OTA).

◆ memberCheckFirmwareStatus:failure: [1/4]

- (void) memberCheckFirmwareStatus: (void(^)(NSArray< ThingSmartMemberCheckFirmwareInfo * > *infos))  success
failure: (ThingFailureError failure 

Returns firmware information. Notice: This api is for common member role user use.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ memberCheckFirmwareStatus:failure: [2/4]

- (void) memberCheckFirmwareStatus: (void(^)(NSArray< ThingSmartMemberCheckFirmwareInfo * > *infos))  success
failure: (ThingFailureError failure 

Returns firmware information. Notice: This api is for common member role user use.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ memberCheckFirmwareStatus:failure: [3/4]

- (void) memberCheckFirmwareStatus: (void(^)(NSArray< ThingSmartMemberCheckFirmwareInfo * > *infos))  success
failure: (ThingFailureError failure 

Returns firmware information. Notice: This api is for common member role user use.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ memberCheckFirmwareStatus:failure: [4/4]

- (void) memberCheckFirmwareStatus: (void(^)(NSArray< ThingSmartMemberCheckFirmwareInfo * > *infos))  success
failure: (ThingFailureError failure 

Returns firmware information. Notice: This api is for common member role user use.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OTA).

◆ NS_UNAVAILABLE [1/4]

- (instancetype) NS_UNAVAILABLE

◆ NS_UNAVAILABLE [2/4]

- (instancetype) NS_UNAVAILABLE

◆ NS_UNAVAILABLE [3/4]

- (instancetype) NS_UNAVAILABLE

◆ NS_UNAVAILABLE [4/4]

- (instancetype) NS_UNAVAILABLE

◆ onlineMode [1/4]

- (ThingDeviceOnlineMode) onlineMode

Returns the device online status.

◆ onlineMode [2/4]

- (ThingDeviceOnlineMode) onlineMode

Returns the device online status.

◆ onlineMode [3/4]

- (ThingDeviceOnlineMode) onlineMode

Returns the device online status.

◆ onlineMode [4/4]

- (ThingDeviceOnlineMode) onlineMode

Returns the device online status.

◆ publishDps:communicationTypes:success:failure: [1/4]

- (void) publishDps: (NSDictionary *)  dps
communicationTypes: (NSArray *)  communicationTypes
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe dp dictionary.
communicationTypesUse communication order to publish dps. (Array element's value reference enum ThingCommunicationType)
successCalled when the task finishes successfully.
failureCalled when the task is interrupted by an error.

◆ publishDps:communicationTypes:success:failure: [2/4]

- (void) publishDps: (NSDictionary *)  dps
communicationTypes: (NSArray *)  communicationTypes
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe dp dictionary.
communicationTypesUse communication order to publish dps. (Array element's value reference enum ThingCommunicationType)
successCalled when the task finishes successfully.
failureCalled when the task is interrupted by an error.

◆ publishDps:communicationTypes:success:failure: [3/4]

- (void) publishDps: (NSDictionary *)  dps
communicationTypes: (NSArray *)  communicationTypes
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe dp dictionary.
communicationTypesUse communication order to publish dps. (Array element's value reference enum ThingCommunicationType)
successCalled when the task finishes successfully.
failureCalled when the task is interrupted by an error.

◆ publishDps:communicationTypes:success:failure: [4/4]

- (void) publishDps: (NSDictionary *)  dps
communicationTypes: (NSArray *)  communicationTypes
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe dp dictionary.
communicationTypesUse communication order to publish dps. (Array element's value reference enum ThingCommunicationType)
successCalled when the task finishes successfully.
failureCalled when the task is interrupted by an error.

◆ publishDps:mode:success:failure: [1/4]

- (void) publishDps: (NSDictionary *)  dps
mode: (ThingDevicePublishMode mode
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe DP dictionary.
modePublish mode(Lan/Internet/Auto).
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDps:mode:success:failure: [2/4]

- (void) publishDps: (NSDictionary *)  dps
mode: (ThingDevicePublishMode mode
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe DP dictionary.
modePublish mode(Lan/Internet/Auto).
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDps:mode:success:failure: [3/4]

- (void) publishDps: (NSDictionary *)  dps
mode: (ThingDevicePublishMode mode
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe DP dictionary.
modePublish mode(Lan/Internet/Auto).
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDps:mode:success:failure: [4/4]

- (void) publishDps: (NSDictionary *)  dps
mode: (ThingDevicePublishMode mode
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe DP dictionary.
modePublish mode(Lan/Internet/Auto).
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDps:success:failure: [1/4]

- (void) publishDps: (NSDictionary *)  dps
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe DP dictionary.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDps:success:failure: [2/4]

- (void) publishDps: (NSDictionary *)  dps
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe DP dictionary.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDps:success:failure: [3/4]

- (void) publishDps: (NSDictionary *)  dps
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe DP dictionary.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDps:success:failure: [4/4]

- (void) publishDps: (NSDictionary *)  dps
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
dpsThe DP dictionary.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDpWithCommands:success:failure: [1/4]

- (void) publishDpWithCommands: (NSDictionary *)  commands
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
commandsThe dictionary of DP values.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDpWithCommands:success:failure: [2/4]

- (void) publishDpWithCommands: (NSDictionary *)  commands
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
commandsThe dictionary of DP values.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDpWithCommands:success:failure: [3/4]

- (void) publishDpWithCommands: (NSDictionary *)  commands
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
commandsThe dictionary of DP values.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishDpWithCommands:success:failure: [4/4]

- (void) publishDpWithCommands: (NSDictionary *)  commands
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Sends DPs.

Parameters
commandsThe dictionary of DP values.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishThingMessageWithType:payload:success:failure: [1/4]

- (void) publishThingMessageWithType: (ThingSmartThingMessageType)  thingMessageType
payload: (NSDictionary *)  payload
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Publish the thing message Example: type == property: payload = { "color":"green", "brightness": 50 } type == action: payload = { "actionCode": "testAction", "inputParams": { "inputParam1":"value1", "inputParam2":"value2" } }

Parameters
thingMessageTypething message type
payloadmessage payload
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishThingMessageWithType:payload:success:failure: [2/4]

- (void) publishThingMessageWithType: (ThingSmartThingMessageType)  thingMessageType
payload: (NSDictionary *)  payload
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Publish the thing message Example: type == property: payload = { "color":"green", "brightness": 50 } type == action: payload = { "actionCode": "testAction", "inputParams": { "inputParam1":"value1", "inputParam2":"value2" } }

Parameters
thingMessageTypething message type
payloadmessage payload
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishThingMessageWithType:payload:success:failure: [3/4]

- (void) publishThingMessageWithType: (ThingSmartThingMessageType)  thingMessageType
payload: (NSDictionary *)  payload
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Publish the thing message Example: type == property: payload = { "color":"green", "brightness": 50 } type == action: payload = { "actionCode": "testAction", "inputParams": { "inputParam1":"value1", "inputParam2":"value2" } }

Parameters
thingMessageTypething message type
payloadmessage payload
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ publishThingMessageWithType:payload:success:failure: [4/4]

- (void) publishThingMessageWithType: (ThingSmartThingMessageType)  thingMessageType
payload: (NSDictionary *)  payload
success: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Publish the thing message Example: type == property: payload = { "color":"green", "brightness": 50 } type == action: payload = { "actionCode": "testAction", "inputParams": { "inputParam1":"value1", "inputParam2":"value2" } }

Parameters
thingMessageTypething message type
payloadmessage payload
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ pushDpsWithHttp:success:failure: [1/2]

- (void) pushDpsWithHttp: (NSDictionary *)  dps
success: (void(^)(void))  success
failure: (void(^)(NSError *error))  failure 

Provided by category ThingSmartDevice(offlineSupport).

◆ pushDpsWithHttp:success:failure: [2/2]

- (void) pushDpsWithHttp: (NSDictionary *)  dps
success: (void(^)(void))  success
failure: (void(^)(NSError *error))  failure 

Provided by category ThingSmartDevice(offlineSupport).

◆ queryDeviceOperateLogWithDpIds:offset:limit:startTime:endTime:isASC:success:failure: [1/4]

- (void) queryDeviceOperateLogWithDpIds: (NSArray *)  dpIds
offset: (NSInteger)  offset
limit: (NSInteger)  limit
startTime: (NSDate *)  startTime
endTime: (NSDate *)  endTime
isASC: (BOOL)  isASC
success: (ThingSuccessID success
failure: (ThingFailureError failure 

Query the device operate log

Parameters
dpIdsthe dp id array, such as @["1", @"2"]
offsetoffset
limitlimit
startTimestartTime
endTimeendTime
isASCYES=ASC NO=DESC
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ queryDeviceOperateLogWithDpIds:offset:limit:startTime:endTime:isASC:success:failure: [2/4]

- (void) queryDeviceOperateLogWithDpIds: (NSArray *)  dpIds
offset: (NSInteger)  offset
limit: (NSInteger)  limit
startTime: (NSDate *)  startTime
endTime: (NSDate *)  endTime
isASC: (BOOL)  isASC
success: (ThingSuccessID success
failure: (ThingFailureError failure 

Query the device operate log

Parameters
dpIdsthe dp id array, such as @["1", @"2"]
offsetoffset
limitlimit
startTimestartTime
endTimeendTime
isASCYES=ASC NO=DESC
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ queryDeviceOperateLogWithDpIds:offset:limit:startTime:endTime:isASC:success:failure: [3/4]

- (void) queryDeviceOperateLogWithDpIds: (NSArray *)  dpIds
offset: (NSInteger)  offset
limit: (NSInteger)  limit
startTime: (NSDate *)  startTime
endTime: (NSDate *)  endTime
isASC: (BOOL)  isASC
success: (ThingSuccessID success
failure: (ThingFailureError failure 

Query the device operate log

Parameters
dpIdsthe dp id array, such as @["1", @"2"]
offsetoffset
limitlimit
startTimestartTime
endTimeendTime
isASCYES=ASC NO=DESC
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ queryDeviceOperateLogWithDpIds:offset:limit:startTime:endTime:isASC:success:failure: [4/4]

- (void) queryDeviceOperateLogWithDpIds: (NSArray *)  dpIds
offset: (NSInteger)  offset
limit: (NSInteger)  limit
startTime: (NSDate *)  startTime
endTime: (NSDate *)  endTime
isASC: (BOOL)  isASC
success: (ThingSuccessID success
failure: (ThingFailureError failure 

Query the device operate log

Parameters
dpIdsthe dp id array, such as @["1", @"2"]
offsetoffset
limitlimit
startTimestartTime
endTimeendTime
isASCYES=ASC NO=DESC
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ remove:failure: [1/4]

- (void) remove: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Removes the device and unbinds the device from the current user.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ remove:failure: [2/4]

- (void) remove: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Removes the device and unbinds the device from the current user.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ remove:failure: [3/4]

- (void) remove: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Removes the device and unbinds the device from the current user.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ remove:failure: [4/4]

- (void) remove: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Removes the device and unbinds the device from the current user.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ removeFromCloud:failure: [1/4]

- (void) removeFromCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Only the device is deleted from the cloud. The device is not reset

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ removeFromCloud:failure: [2/4]

- (void) removeFromCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Only the device is deleted from the cloud. The device is not reset

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ removeFromCloud:failure: [3/4]

- (void) removeFromCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Only the device is deleted from the cloud. The device is not reset

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ removeFromCloud:failure: [4/4]

- (void) removeFromCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Only the device is deleted from the cloud. The device is not reset

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ removeReceiveDeviceShareWithSuccess:failure: [1/4]

- (void) removeReceiveDeviceShareWithSuccess: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Remove Received Shared.

Parameters
successCalled when the task finishes successfully.
failureIf error occurred while adding the task, this block will be called.

Provided by category ThingSmartDevice(ShareInfo).

◆ removeReceiveDeviceShareWithSuccess:failure: [2/4]

- (void) removeReceiveDeviceShareWithSuccess: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Remove Received Shared.

Parameters
successCalled when the task finishes successfully.
failureIf error occurred while adding the task, this block will be called.

Provided by category ThingSmartDevice(ShareInfo).

◆ removeReceiveDeviceShareWithSuccess:failure: [3/4]

- (void) removeReceiveDeviceShareWithSuccess: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Remove Received Shared.

Parameters
successCalled when the task finishes successfully.
failureIf error occurred while adding the task, this block will be called.

Provided by category ThingSmartDevice(ShareInfo).

◆ removeReceiveDeviceShareWithSuccess:failure: [4/4]

- (void) removeReceiveDeviceShareWithSuccess: (ThingSuccessHandler success
failure: (ThingFailureError failure 

Remove Received Shared.

Parameters
successCalled when the task finishes successfully.
failureIf error occurred while adding the task, this block will be called.

Provided by category ThingSmartDevice(ShareInfo).

◆ requestCachedDps:failure: [1/2]

- (void) requestCachedDps: (void(^)(void))  success
failure: (void(^)(NSError *error))  failure 

Provided by category ThingSmartDevice(offlineSupport).

◆ requestCachedDps:failure: [2/2]

- (void) requestCachedDps: (void(^)(void))  success
failure: (void(^)(NSError *error))  failure 

Provided by category ThingSmartDevice(offlineSupport).

◆ resetFactory:failure: [1/4]

- (void) resetFactory: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Restores factory settings.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ resetFactory:failure: [2/4]

- (void) resetFactory: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Restores factory settings.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ resetFactory:failure: [3/4]

- (void) resetFactory: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Restores factory settings.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ resetFactory:failure: [4/4]

- (void) resetFactory: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Restores factory settings.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ resetFactoryFromCloud:failure: [1/4]

- (void) resetFactoryFromCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Delete device and clear data from cloud. The device is not reset

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ resetFactoryFromCloud:failure: [2/4]

- (void) resetFactoryFromCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Delete device and clear data from cloud. The device is not reset

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ resetFactoryFromCloud:failure: [3/4]

- (void) resetFactoryFromCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Delete device and clear data from cloud. The device is not reset

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ resetFactoryFromCloud:failure: [4/4]

- (void) resetFactoryFromCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Delete device and clear data from cloud. The device is not reset

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ saveUpgradeInfoWithSwitchValue:success:failure: [1/4]

- (void) saveUpgradeInfoWithSwitchValue: (NSInteger)  switchValue
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Saves the switch value for automatic device over-the-air (OTA) updates.

Parameters
switchValueThe value of the auto switch. 0 means off, and 1 means on.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ saveUpgradeInfoWithSwitchValue:success:failure: [2/4]

- (void) saveUpgradeInfoWithSwitchValue: (NSInteger)  switchValue
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Saves the switch value for automatic device over-the-air (OTA) updates.

Parameters
switchValueThe value of the auto switch. 0 means off, and 1 means on.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ saveUpgradeInfoWithSwitchValue:success:failure: [3/4]

- (void) saveUpgradeInfoWithSwitchValue: (NSInteger)  switchValue
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Saves the switch value for automatic device over-the-air (OTA) updates.

Parameters
switchValueThe value of the auto switch. 0 means off, and 1 means on.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ saveUpgradeInfoWithSwitchValue:success:failure: [4/4]

- (void) saveUpgradeInfoWithSwitchValue: (NSInteger)  switchValue
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Saves the switch value for automatic device over-the-air (OTA) updates.

Parameters
switchValueThe value of the auto switch. 0 means off, and 1 means on.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ sendCacheDps:validity:dpCacheType:success:failure: [1/4]

- (void) sendCacheDps: (NSDictionary *)  dps
validity: (NSUInteger)  validity
dpCacheType: (NSUInteger)  dpCacheType
success: (ThingSuccessID success
failure: (ThingFailureError failure 

Publish dps cached in the cloud, and then the device itself requests to pull OR receives push from cloud.

Note: Only suitable for low-power device. When the device is dormant, sending dps through this API will be cached in the cloud for a period of time. When the device wakes up within the validity period, the device can get the cached dps.

Parameters
dpsThe DP dictionary.
validityThe cached dps validity period. (Unit: second, Range: 1 ~ 172800).
dpCacheTypeThe dps cache type. ( 0: device itself requests to pull, 1: device receives push from cloud).
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ sendCacheDps:validity:dpCacheType:success:failure: [2/4]

- (void) sendCacheDps: (NSDictionary *)  dps
validity: (NSUInteger)  validity
dpCacheType: (NSUInteger)  dpCacheType
success: (ThingSuccessID success
failure: (ThingFailureError failure 

Publish dps cached in the cloud, and then the device itself requests to pull OR receives push from cloud.

Note: Only suitable for low-power device. When the device is dormant, sending dps through this API will be cached in the cloud for a period of time. When the device wakes up within the validity period, the device can get the cached dps.

Parameters
dpsThe DP dictionary.
validityThe cached dps validity period. (Unit: second, Range: 1 ~ 172800).
dpCacheTypeThe dps cache type. ( 0: device itself requests to pull, 1: device receives push from cloud).
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ sendCacheDps:validity:dpCacheType:success:failure: [3/4]

- (void) sendCacheDps: (NSDictionary *)  dps
validity: (NSUInteger)  validity
dpCacheType: (NSUInteger)  dpCacheType
success: (ThingSuccessID success
failure: (ThingFailureError failure 

Publish dps cached in the cloud, and then the device itself requests to pull OR receives push from cloud.

Note: Only suitable for low-power device. When the device is dormant, sending dps through this API will be cached in the cloud for a period of time. When the device wakes up within the validity period, the device can get the cached dps.

Parameters
dpsThe DP dictionary.
validityThe cached dps validity period. (Unit: second, Range: 1 ~ 172800).
dpCacheTypeThe dps cache type. ( 0: device itself requests to pull, 1: device receives push from cloud).
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ sendCacheDps:validity:dpCacheType:success:failure: [4/4]

- (void) sendCacheDps: (NSDictionary *)  dps
validity: (NSUInteger)  validity
dpCacheType: (NSUInteger)  dpCacheType
success: (ThingSuccessID success
failure: (ThingFailureError failure 

Publish dps cached in the cloud, and then the device itself requests to pull OR receives push from cloud.

Note: Only suitable for low-power device. When the device is dormant, sending dps through this API will be cached in the cloud for a period of time. When the device wakes up within the validity period, the device can get the cached dps.

Parameters
dpsThe DP dictionary.
validityThe cached dps validity period. (Unit: second, Range: 1 ~ 172800).
dpCacheTypeThe dps cache type. ( 0: device itself requests to pull, 1: device receives push from cloud).
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ sendHeartbeatWithType:messageId: [1/2]

- (ThingDoorBellError) sendHeartbeatWithType: (ThingSmartDoorBellType)  type
messageId: (NSString *)  messageId 

Provided by category ThingSmartDevice(doorbell).

◆ sendHeartbeatWithType:messageId: [2/2]

- (ThingDoorBellError) sendHeartbeatWithType: (ThingSmartDoorBellType)  type
messageId: (NSString *)  messageId 

Provided by category ThingSmartDevice(doorbell).

◆ setDevPropertyWithCode:value:success:failure: [1/4]

- (void) setDevPropertyWithCode: (NSString *)  code
value: (id)  value
success: (ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Sets the device custom data to record and store custom data information.

Parameters
codeThe custom data key.
valueThe custom data value.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ setDevPropertyWithCode:value:success:failure: [2/4]

- (void) setDevPropertyWithCode: (NSString *)  code
value: (id)  value
success: (ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Sets the device custom data to record and store custom data information.

Parameters
codeThe custom data key.
valueThe custom data value.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ setDevPropertyWithCode:value:success:failure: [3/4]

- (void) setDevPropertyWithCode: (NSString *)  code
value: (id)  value
success: (ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Sets the device custom data to record and store custom data information.

Parameters
codeThe custom data key.
valueThe custom data value.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ setDevPropertyWithCode:value:success:failure: [4/4]

- (void) setDevPropertyWithCode: (NSString *)  code
value: (id)  value
success: (ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Sets the device custom data to record and store custom data information.

Parameters
codeThe custom data key.
valueThe custom data value.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ setOfflineReminderStatus:success:failure: [1/4]

- (void) setOfflineReminderStatus: (BOOL)  status
success: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Sets the device offline notification.

Parameters
statusSends a notification when the device goes offline.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ setOfflineReminderStatus:success:failure: [2/4]

- (void) setOfflineReminderStatus: (BOOL)  status
success: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Sets the device offline notification.

Parameters
statusSends a notification when the device goes offline.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ setOfflineReminderStatus:success:failure: [3/4]

- (void) setOfflineReminderStatus: (BOOL)  status
success: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Sets the device offline notification.

Parameters
statusSends a notification when the device goes offline.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ setOfflineReminderStatus:success:failure: [4/4]

- (void) setOfflineReminderStatus: (BOOL)  status
success: (nullable ThingSuccessBOOL success
failure: (nullable ThingFailureError failure 

Sets the device offline notification.

Parameters
statusSends a notification when the device goes offline.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(OfflineReminder).

◆ startFirmwareUpgrade: [1/4]

- (void) startFirmwareUpgrade: (NSArray< ThingSmartFirmwareUpgradeModel * > *)  firmwares

Start device firmware upgrade. ( for general device and some special device. ) Notice:

  1. You can use the ThingSmartDevice's delegate ( - device:otaUpdateStatusChanged: ) to receive the status and progress.
  2. Please use -checkFirmwareUpgrade:failure: or -checkFirmwareUpgradeWithExtraInfo:success:failure before call this.
    Parameters
    firmwaresfirmwares from -checkFirmwareUpgrade:failure: or -checkFirmwareUpgradeWithExtraInfo:success:failure

Provided by category ThingSmartDevice(OTA).

◆ startFirmwareUpgrade: [2/4]

- (void) startFirmwareUpgrade: (NSArray< ThingSmartFirmwareUpgradeModel * > *)  firmwares

Start device firmware upgrade. ( for general device and some special device. ) Notice:

  1. You can use the ThingSmartDevice's delegate ( - device:otaUpdateStatusChanged: ) to receive the status and progress.
  2. Please use -checkFirmwareUpgrade:failure: or -checkFirmwareUpgradeWithExtraInfo:success:failure before call this.
    Parameters
    firmwaresfirmwares from -checkFirmwareUpgrade:failure: or -checkFirmwareUpgradeWithExtraInfo:success:failure

Provided by category ThingSmartDevice(OTA).

◆ startFirmwareUpgrade: [3/4]

- (void) startFirmwareUpgrade: (NSArray< ThingSmartFirmwareUpgradeModel * > *)  firmwares

Start device firmware upgrade. ( for general device and some special device. ) Notice:

  1. You can use the ThingSmartDevice's delegate ( - device:otaUpdateStatusChanged: ) to receive the status and progress.
  2. Please use -checkFirmwareUpgrade:failure: or -checkFirmwareUpgradeWithExtraInfo:success:failure before call this.
    Parameters
    firmwaresfirmwares from -checkFirmwareUpgrade:failure: or -checkFirmwareUpgradeWithExtraInfo:success:failure

Provided by category ThingSmartDevice(OTA).

◆ startFirmwareUpgrade: [4/4]

- (void) startFirmwareUpgrade: (NSArray< ThingSmartFirmwareUpgradeModel * > *)  firmwares

Start device firmware upgrade. ( for general device and some special device. ) Notice:

  1. You can use the ThingSmartDevice's delegate ( - device:otaUpdateStatusChanged: ) to receive the status and progress.
  2. Please use -checkFirmwareUpgrade:failure: or -checkFirmwareUpgradeWithExtraInfo:success:failure before call this.
    Parameters
    firmwaresfirmwares from -checkFirmwareUpgrade:failure: or -checkFirmwareUpgradeWithExtraInfo:success:failure

Provided by category ThingSmartDevice(OTA).

◆ syncDeviceInfoWithDevId:homeId:success:failure: [1/4]

+ (void) syncDeviceInfoWithDevId: (NSString *)  devId
homeId: (long long)  homeId
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
devIdThe device ID.
homeIdThe home ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(Home).

◆ syncDeviceInfoWithDevId:homeId:success:failure: [2/4]

+ (void) syncDeviceInfoWithDevId: (NSString *)  devId
homeId: (long long)  homeId
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
devIdThe device ID.
homeIdThe home ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(Home).

◆ syncDeviceInfoWithDevId:homeId:success:failure: [3/4]

+ (void) syncDeviceInfoWithDevId: (NSString *)  devId
homeId: (long long)  homeId
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
devIdThe device ID.
homeIdThe home ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(Home).

◆ syncDeviceInfoWithDevId:homeId:success:failure: [4/4]

+ (void) syncDeviceInfoWithDevId: (NSString *)  devId
homeId: (long long)  homeId
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
devIdThe device ID.
homeIdThe home ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(Home).

◆ syncDeviceInfoWithDevId:success:failure: [1/4]

+ (void) syncDeviceInfoWithDevId: (NSString *)  devId
success: (nullable void(^)(ThingSmartDeviceModel *device))  success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
devIdThe device ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncDeviceInfoWithDevId:success:failure: [2/4]

+ (void) syncDeviceInfoWithDevId: (NSString *)  devId
success: (nullable void(^)(ThingSmartDeviceModel *device))  success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
devIdThe device ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncDeviceInfoWithDevId:success:failure: [3/4]

+ (void) syncDeviceInfoWithDevId: (NSString *)  devId
success: (nullable void(^)(ThingSmartDeviceModel *device))  success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
devIdThe device ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncDeviceInfoWithDevId:success:failure: [4/4]

+ (void) syncDeviceInfoWithDevId: (NSString *)  devId
success: (nullable void(^)(ThingSmartDeviceModel *device))  success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
devIdThe device ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncLocationToDeviceWithSucecess:failure: [1/4]

- (void) syncLocationToDeviceWithSucecess: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes the longitude and latitude of the mobile phone to the device.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncLocationToDeviceWithSucecess:failure: [2/4]

- (void) syncLocationToDeviceWithSucecess: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes the longitude and latitude of the mobile phone to the device.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncLocationToDeviceWithSucecess:failure: [3/4]

- (void) syncLocationToDeviceWithSucecess: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes the longitude and latitude of the mobile phone to the device.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncLocationToDeviceWithSucecess:failure: [4/4]

- (void) syncLocationToDeviceWithSucecess: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes the longitude and latitude of the mobile phone to the device.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncSubDeviceInfoWithGatewayId:devId:success:failure: [1/4]

+ (void) syncSubDeviceInfoWithGatewayId: (NSString *)  gatewayId
devId: (NSString *)  devId
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes sub-device information.

Parameters
gatewayIdThe gateway ID.
devIdThe device ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncSubDeviceInfoWithGatewayId:devId:success:failure: [2/4]

+ (void) syncSubDeviceInfoWithGatewayId: (NSString *)  gatewayId
devId: (NSString *)  devId
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes sub-device information.

Parameters
gatewayIdThe gateway ID.
devIdThe device ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncSubDeviceInfoWithGatewayId:devId:success:failure: [3/4]

+ (void) syncSubDeviceInfoWithGatewayId: (NSString *)  gatewayId
devId: (NSString *)  devId
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes sub-device information.

Parameters
gatewayIdThe gateway ID.
devIdThe device ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncSubDeviceInfoWithGatewayId:devId:success:failure: [4/4]

+ (void) syncSubDeviceInfoWithGatewayId: (NSString *)  gatewayId
devId: (NSString *)  devId
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes sub-device information.

Parameters
gatewayIdThe gateway ID.
devIdThe device ID.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncSubDeviceLocalKeyWithGatewayId:nodeIds:success:failure: [1/4]

+ (void) syncSubDeviceLocalKeyWithGatewayId: (NSString *)  gatewayId
nodeIds: (NSArray< NSString * > *)  nodeId
success: (nullable ThingSuccessList success
failure: (nullable ThingFailureError failure 

Synchronizes the localKey of the device.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncSubDeviceLocalKeyWithGatewayId:nodeIds:success:failure: [2/4]

+ (void) syncSubDeviceLocalKeyWithGatewayId: (NSString *)  gatewayId
nodeIds: (NSArray< NSString * > *)  nodeId
success: (nullable ThingSuccessList success
failure: (nullable ThingFailureError failure 

Synchronizes the localKey of the device.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncSubDeviceLocalKeyWithGatewayId:nodeIds:success:failure: [3/4]

+ (void) syncSubDeviceLocalKeyWithGatewayId: (NSString *)  gatewayId
nodeIds: (NSArray< NSString * > *)  nodeId
success: (nullable ThingSuccessList success
failure: (nullable ThingFailureError failure 

Synchronizes the localKey of the device.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncSubDeviceLocalKeyWithGatewayId:nodeIds:success:failure: [4/4]

+ (void) syncSubDeviceLocalKeyWithGatewayId: (NSString *)  gatewayId
nodeIds: (NSArray< NSString * > *)  nodeId
success: (nullable ThingSuccessList success
failure: (nullable ThingFailureError failure 

Synchronizes the localKey of the device.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncWithCloud:failure: [1/4]

- (void) syncWithCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncWithCloud:failure: [2/4]

- (void) syncWithCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncWithCloud:failure: [3/4]

- (void) syncWithCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ syncWithCloud:failure: [4/4]

- (void) syncWithCloud: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Synchronizes device information.

Parameters
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ tsod_publishDPWithCode:DPValue:success:failure: [1/2]

- (void) tsod_publishDPWithCode: (NSString *)  code
DPValue: (id)  DPValue
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

send DP with code

Parameters
codeDP code
DPValuethe DP original value (NSString, NSNumber, NSDictionary)
successCalled when the task finishes successfully.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(ThingSmartOutdoor).

◆ tsod_publishDPWithCode:DPValue:success:failure: [2/2]

- (void) tsod_publishDPWithCode: (NSString *)  code
DPValue: (id)  DPValue
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

send DP with code

Parameters
codeDP code
DPValuethe DP original value (NSString, NSNumber, NSDictionary)
successCalled when the task finishes successfully.
failureCalled when the task is interrupted by an error.

Provided by category ThingSmartDevice(ThingSmartOutdoor).

◆ updateBootOTAWithSingleBootStatus: [1/4]

- (void) updateBootOTAWithSingleBootStatus: (BOOL)  bootOTABeing

Provided by category ThingSmartDevice(OTA).

◆ updateBootOTAWithSingleBootStatus: [2/4]

- (void) updateBootOTAWithSingleBootStatus: (BOOL)  bootOTABeing

Provided by category ThingSmartDevice(OTA).

◆ updateBootOTAWithSingleBootStatus: [3/4]

- (void) updateBootOTAWithSingleBootStatus: (BOOL)  bootOTABeing

Provided by category ThingSmartDevice(OTA).

◆ updateBootOTAWithSingleBootStatus: [4/4]

- (void) updateBootOTAWithSingleBootStatus: (BOOL)  bootOTABeing

Provided by category ThingSmartDevice(OTA).

◆ updateDeviceVersion:type:success:failure: [1/4]

- (void) updateDeviceVersion: (NSString *)  version
type: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Reports the device firmware version.

Parameters
versionThe device version.
typeThe device type.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateDeviceVersion:type:success:failure: [2/4]

- (void) updateDeviceVersion: (NSString *)  version
type: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Reports the device firmware version.

Parameters
versionThe device version.
typeThe device type.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateDeviceVersion:type:success:failure: [3/4]

- (void) updateDeviceVersion: (NSString *)  version
type: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Reports the device firmware version.

Parameters
versionThe device version.
typeThe device type.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateDeviceVersion:type:success:failure: [4/4]

- (void) updateDeviceVersion: (NSString *)  version
type: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Reports the device firmware version.

Parameters
versionThe device version.
typeThe device type.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateIcon:success:failure: [1/4]

- (void) updateIcon: (UIImage *)  icon
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device icon.

Parameters
iconThe device icon.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateIcon:success:failure: [2/4]

- (void) updateIcon: (UIImage *)  icon
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device icon.

Parameters
iconThe device icon.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateIcon:success:failure: [3/4]

- (void) updateIcon: (UIImage *)  icon
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device icon.

Parameters
iconThe device icon.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateIcon:success:failure: [4/4]

- (void) updateIcon: (UIImage *)  icon
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device icon.

Parameters
iconThe device icon.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateIconWithCloudKey:success:failure: [1/4]

- (void) updateIconWithCloudKey: (NSString *)  cloudKey
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice - updateIconWithURL:success:failure] 

Edits the device icon.

Parameters
cloudKeyThe cloud key.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.
Deprecated:
This method is deprecated. Use ThingSmartDevice::updateIconWithURL:success:failure instead.

◆ updateIconWithCloudKey:success:failure: [2/4]

- (void) updateIconWithCloudKey: (NSString *)  cloudKey
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice - updateIconWithURL:success:failure] 

Edits the device icon.

Parameters
cloudKeyThe cloud key.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.
Deprecated:
This method is deprecated. Use ThingSmartDevice::updateIconWithURL:success:failure instead.

◆ updateIconWithCloudKey:success:failure: [3/4]

- (void) updateIconWithCloudKey: (NSString *)  cloudKey
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice - updateIconWithURL:success:failure] 

Edits the device icon.

Parameters
cloudKeyThe cloud key.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.
Deprecated:
This method is deprecated. Use ThingSmartDevice::updateIconWithURL:success:failure instead.

◆ updateIconWithCloudKey:success:failure: [4/4]

- (void) updateIconWithCloudKey: (NSString *)  cloudKey
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice - updateIconWithURL:success:failure] 

Edits the device icon.

Parameters
cloudKeyThe cloud key.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.
Deprecated:
This method is deprecated. Use ThingSmartDevice::updateIconWithURL:success:failure instead.

◆ updateIconWithURL:success:failure: [1/4]

- (void) updateIconWithURL: (NSString *)  url
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device icon.

Parameters
urlThe icon url.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateIconWithURL:success:failure: [2/4]

- (void) updateIconWithURL: (NSString *)  url
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device icon.

Parameters
urlThe icon url.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateIconWithURL:success:failure: [3/4]

- (void) updateIconWithURL: (NSString *)  url
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device icon.

Parameters
urlThe icon url.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateIconWithURL:success:failure: [4/4]

- (void) updateIconWithURL: (NSString *)  url
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device icon.

Parameters
urlThe icon url.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateLocalKeySuccess:failure: [1/4]

- (void) updateLocalKeySuccess: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Update device local key.

Provided by category ThingSmartDevice(LocalKey).

◆ updateLocalKeySuccess:failure: [2/4]

- (void) updateLocalKeySuccess: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Update device local key.

Provided by category ThingSmartDevice(LocalKey).

◆ updateLocalKeySuccess:failure: [3/4]

- (void) updateLocalKeySuccess: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Update device local key.

Provided by category ThingSmartDevice(LocalKey).

◆ updateLocalKeySuccess:failure: [4/4]

- (void) updateLocalKeySuccess: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Update device local key.

Provided by category ThingSmartDevice(LocalKey).

◆ updateName:success:failure: [1/4]

- (void) updateName: (NSString *)  name
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device name.

Parameters
nameThe device name.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateName:success:failure: [2/4]

- (void) updateName: (NSString *)  name
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device name.

Parameters
nameThe device name.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateName:success:failure: [3/4]

- (void) updateName: (NSString *)  name
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device name.

Parameters
nameThe device name.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ updateName:success:failure: [4/4]

- (void) updateName: (NSString *)  name
success: (nullable ThingSuccessHandler success
failure: (nullable ThingFailureError failure 

Edits the device name.

Parameters
nameThe device name.
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ upgradeFirmware:success:failure: [1/4]

- (void) upgradeFirmware: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice startFirmwareUpgrade:] 

Updates the firmware and receives a success or failure callback from ThingSmartDeviceDelegate.

Parameters
typeThe device type of "ThingSmartFirmwareUpgradeModel".
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ upgradeFirmware:success:failure: [2/4]

- (void) upgradeFirmware: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice startFirmwareUpgrade:] 

Updates the firmware and receives a success or failure callback from ThingSmartDeviceDelegate.

Parameters
typeThe device type of "ThingSmartFirmwareUpgradeModel".
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ upgradeFirmware:success:failure: [3/4]

- (void) upgradeFirmware: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice startFirmwareUpgrade:] 

Updates the firmware and receives a success or failure callback from ThingSmartDeviceDelegate.

Parameters
typeThe device type of "ThingSmartFirmwareUpgradeModel".
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

◆ upgradeFirmware:success:failure: [4/4]

- (void) upgradeFirmware: (NSInteger)  type
success: (nullable ThingSuccessHandler success
failure: ("This method is)  deprecated
(Use - instead")  __deprecated_msg[ThingSmartDevice startFirmwareUpgrade:] 

Updates the firmware and receives a success or failure callback from ThingSmartDeviceDelegate.

Parameters
typeThe device type of "ThingSmartFirmwareUpgradeModel".
successCalled when the task is finished.
failureCalled when the task is interrupted by an error.

Property Documentation

◆ delegate

- (id< ThingSmartDeviceDelegate >) delegate
readwritenonatomicweak

Definition at line 202 of file ThingSmartDevice.h.

◆ deviceModel

- (ThingSmartDeviceModel *) deviceModel
readnonatomicstrong

Returns the model of basic device information.

Definition at line 200 of file ThingSmartDevice.h.

◆ devId

- (NSString *) devId
readnonatomicstrong

Returns the device id.

Definition at line 198 of file ThingSmartDevice.h.


The documentation for this class was generated from the following files: