Tuya iOS Smart Life App SDK 5.15.0
ThingSmartSceneActionModel Class Reference

Data model for Scene Base Action. More...

#import <ThingSmartSceneActionModel.h>

Inheritance diagram for ThingSmartSceneActionModel:

Instance Methods

(BOOL) - isRecommend
 
(BOOL) - isDevice
 
(BOOL) - isGroup
 
(BOOL) - isNormalDevice
 
(BOOL) - isIRDevice
 
(BOOL) - isMessage
 
(BOOL) - isRuleHandle
 
(BOOL) - isBatchControl
 
(BOOL) - isSecurity
 
(BOOL) - isEnergy
 
(BOOL) - isDelay
 
(BOOL) - isValid
 
(BOOL) - isRecommend
 
(BOOL) - isDevice
 
(BOOL) - isGroup
 
(BOOL) - isNormalDevice
 
(BOOL) - isIRDevice
 
(BOOL) - isMessage
 
(BOOL) - isRuleHandle
 
(BOOL) - isBatchControl
 
(BOOL) - isSecurity
 
(BOOL) - isEnergy
 
(BOOL) - isDelay
 
(BOOL) - isValid
 
(BOOL) - isRecommend
 
(BOOL) - isDevice
 
(BOOL) - isGroup
 
(BOOL) - isNormalDevice
 
(BOOL) - isIRDevice
 
(BOOL) - isMessage
 
(BOOL) - isRuleHandle
 
(BOOL) - isBatchControl
 
(BOOL) - isSecurity
 
(BOOL) - isEnergy
 
(BOOL) - isDelay
 
(BOOL) - isValid
 
(BOOL) - isRecommend
 
(BOOL) - isDevice
 
(BOOL) - isGroup
 
(BOOL) - isNormalDevice
 
(BOOL) - isIRDevice
 
(BOOL) - isMessage
 
(BOOL) - isRuleHandle
 
(BOOL) - isBatchControl
 
(BOOL) - isSecurity
 
(BOOL) - isEnergy
 
(BOOL) - isDelay
 
(BOOL) - isValid
 
(BOOL) - checkWhetherDeviceIsNormal
 
(BOOL) - checkWhetherDeviceIsNormal
 
(BOOL) - checkWhetherDeviceIsNormal
 
(BOOL) - checkWhetherDeviceIsNormal
 

Properties

NSString * actionId
 The action id. More...
 
NSString * entityId
 The entity id. If action is a device, entityId is devId, and groupId for group action, "delay" for a delay action, sceneId of operated scene for scene action. More...
 
NSString * entityName
 The entity name, like "lamp", "lamp group". More...
 
NSString * scenarioId
 The scene id, can be used to save the scene's Id which this action belonged to. More...
 
NSString * actionDisplay
 Describe what this action will do, like "Switch : Open". More...
 
NSDictionary * actionDisplayNew
 
NSString * actionExecutor
 
NSDictionary * executorProperty
 Execute property, like {"1":true, ...}, "1" is dpId, a data point's Id, value is the value you want this datapoint to set. Delay action should be like "executorProperty":{"seconds":"5","minutes":"0"}. More...
 
NSDictionary * extraProperty
 Local property of scene , save gId and gwId. More...
 
BOOL devDelMark
 If this action is a device type action and this device has been removed from the current account, this flag is YES. More...
 
NSString * deleteDevIcon
 If this action is a device type action, and this device has been removed from the current account, then provide this icon url to display the device icon. More...
 
ThingSceneActionStatus status
 Execute action status, you can use this property to store the execute status when executing. More...
 
NSDictionary * relationGroup
 Batch control device information. More...
 
NSString * uiid
 The panel id, this value will be assigned by cloud server when this action should be oprate by a React Native panel. More...
 
NSDictionary * uiInfo
 The panel info, this value will be assigned by cloud server when this action should be oprate by a React Native panel. More...
 
long i18nTime
 The panel info, this value will be assigned by cloud server when this action should be oprate by a React Native panel. More...
 
NSString * pid
 The panel relate device's pid, this value will be assigned by cloud server when this action should be oprate by a React Native panel. More...
 
NSString * productId
 The recommend product id. More...
 
NSString * productPic
 The recommend product icon. More...
 
NSString * defaultIconUrl
 The recommend product local default icon. More...
 

Detailed Description

Data model for Scene Base Action.

Definition at line 50 of file ThingSmartSceneActionModel.h.

Method Documentation

◆ checkWhetherDeviceIsNormal [1/4]

- (BOOL) checkWhetherDeviceIsNormal

◆ checkWhetherDeviceIsNormal [2/4]

- (BOOL) checkWhetherDeviceIsNormal

◆ checkWhetherDeviceIsNormal [3/4]

- (BOOL) checkWhetherDeviceIsNormal

◆ checkWhetherDeviceIsNormal [4/4]

- (BOOL) checkWhetherDeviceIsNormal

◆ isBatchControl [1/4]

- (BOOL) isBatchControl

Determine whether is batch control device type.

◆ isBatchControl [2/4]

- (BOOL) isBatchControl

Determine whether is batch control device type.

◆ isBatchControl [3/4]

- (BOOL) isBatchControl

Determine whether is batch control device type.

◆ isBatchControl [4/4]

- (BOOL) isBatchControl

Determine whether is batch control device type.

◆ isDelay [1/4]

- (BOOL) isDelay

Check whether is delay type.

◆ isDelay [2/4]

- (BOOL) isDelay

Check whether is delay type.

◆ isDelay [3/4]

- (BOOL) isDelay

Check whether is delay type.

◆ isDelay [4/4]

- (BOOL) isDelay

Check whether is delay type.

◆ isDevice [1/4]

- (BOOL) isDevice

Determine whether is device type. It includes normal device type and infrared device type.

◆ isDevice [2/4]

- (BOOL) isDevice

Determine whether is device type. It includes normal device type and infrared device type.

◆ isDevice [3/4]

- (BOOL) isDevice

Determine whether is device type. It includes normal device type and infrared device type.

◆ isDevice [4/4]

- (BOOL) isDevice

Determine whether is device type. It includes normal device type and infrared device type.

◆ isEnergy [1/4]

- (BOOL) isEnergy

Determine whether is energy type.

◆ isEnergy [2/4]

- (BOOL) isEnergy

Determine whether is energy type.

◆ isEnergy [3/4]

- (BOOL) isEnergy

Determine whether is energy type.

◆ isEnergy [4/4]

- (BOOL) isEnergy

Determine whether is energy type.

◆ isGroup [1/4]

- (BOOL) isGroup

Determine whether is group type.

◆ isGroup [2/4]

- (BOOL) isGroup

Determine whether is group type.

◆ isGroup [3/4]

- (BOOL) isGroup

Determine whether is group type.

◆ isGroup [4/4]

- (BOOL) isGroup

Determine whether is group type.

◆ isIRDevice [1/4]

- (BOOL) isIRDevice

Determine whether is infrared device type. It includes ACTION_EXECUTOR_IR_ISSUE, ACTION_EXECUTOR_IR_ISSUE_VII.

◆ isIRDevice [2/4]

- (BOOL) isIRDevice

Determine whether is infrared device type. It includes ACTION_EXECUTOR_IR_ISSUE, ACTION_EXECUTOR_IR_ISSUE_VII.

◆ isIRDevice [3/4]

- (BOOL) isIRDevice

Determine whether is infrared device type. It includes ACTION_EXECUTOR_IR_ISSUE, ACTION_EXECUTOR_IR_ISSUE_VII.

◆ isIRDevice [4/4]

- (BOOL) isIRDevice

Determine whether is infrared device type. It includes ACTION_EXECUTOR_IR_ISSUE, ACTION_EXECUTOR_IR_ISSUE_VII.

◆ isMessage [1/4]

- (BOOL) isMessage

Determine whether is message type. It includes ACTION_EXECUTOR_APP_PUSH, ACTION_EXECUTOR_APP_CALL, ACTION_EXECUTOR_SMS_SEND.

◆ isMessage [2/4]

- (BOOL) isMessage

Determine whether is message type. It includes ACTION_EXECUTOR_APP_PUSH, ACTION_EXECUTOR_APP_CALL, ACTION_EXECUTOR_SMS_SEND.

◆ isMessage [3/4]

- (BOOL) isMessage

Determine whether is message type. It includes ACTION_EXECUTOR_APP_PUSH, ACTION_EXECUTOR_APP_CALL, ACTION_EXECUTOR_SMS_SEND.

◆ isMessage [4/4]

- (BOOL) isMessage

Determine whether is message type. It includes ACTION_EXECUTOR_APP_PUSH, ACTION_EXECUTOR_APP_CALL, ACTION_EXECUTOR_SMS_SEND.

◆ isNormalDevice [1/4]

- (BOOL) isNormalDevice

Determine whether is normal device type. It includes ACTION_EXECUTOR_DP_ISSUE, ACTION_EXECUTOR_TOGGLE, ACTION_EXECUTOR_STEP.

◆ isNormalDevice [2/4]

- (BOOL) isNormalDevice

Determine whether is normal device type. It includes ACTION_EXECUTOR_DP_ISSUE, ACTION_EXECUTOR_TOGGLE, ACTION_EXECUTOR_STEP.

◆ isNormalDevice [3/4]

- (BOOL) isNormalDevice

Determine whether is normal device type. It includes ACTION_EXECUTOR_DP_ISSUE, ACTION_EXECUTOR_TOGGLE, ACTION_EXECUTOR_STEP.

◆ isNormalDevice [4/4]

- (BOOL) isNormalDevice

Determine whether is normal device type. It includes ACTION_EXECUTOR_DP_ISSUE, ACTION_EXECUTOR_TOGGLE, ACTION_EXECUTOR_STEP.

◆ isRecommend [1/4]

- (BOOL) isRecommend

Determine whether is recommend type.

◆ isRecommend [2/4]

- (BOOL) isRecommend

Determine whether is recommend type.

◆ isRecommend [3/4]

- (BOOL) isRecommend

Determine whether is recommend type.

◆ isRecommend [4/4]

- (BOOL) isRecommend

Determine whether is recommend type.

◆ isRuleHandle [1/4]

- (BOOL) isRuleHandle

Determine whether is rule handle type. It includes ACTION_EXECUTOR_RULE_ENABLE, ACTION_EXECUTOR_RULE_DISABLE, ACTION_EXECUTOR_RULE_TRIGGER, ACTION_EXECUTOR_LIGHT.

◆ isRuleHandle [2/4]

- (BOOL) isRuleHandle

Determine whether is rule handle type. It includes ACTION_EXECUTOR_RULE_ENABLE, ACTION_EXECUTOR_RULE_DISABLE, ACTION_EXECUTOR_RULE_TRIGGER, ACTION_EXECUTOR_LIGHT.

◆ isRuleHandle [3/4]

- (BOOL) isRuleHandle

Determine whether is rule handle type. It includes ACTION_EXECUTOR_RULE_ENABLE, ACTION_EXECUTOR_RULE_DISABLE, ACTION_EXECUTOR_RULE_TRIGGER, ACTION_EXECUTOR_LIGHT.

◆ isRuleHandle [4/4]

- (BOOL) isRuleHandle

Determine whether is rule handle type. It includes ACTION_EXECUTOR_RULE_ENABLE, ACTION_EXECUTOR_RULE_DISABLE, ACTION_EXECUTOR_RULE_TRIGGER, ACTION_EXECUTOR_LIGHT.

◆ isSecurity [1/4]

- (BOOL) isSecurity

Determine whether is security type.

◆ isSecurity [2/4]

- (BOOL) isSecurity

Determine whether is security type.

◆ isSecurity [3/4]

- (BOOL) isSecurity

Determine whether is security type.

◆ isSecurity [4/4]

- (BOOL) isSecurity

Determine whether is security type.

◆ isValid [1/4]

- (BOOL) isValid

Detemine whether the action is valid. When the action is non-device type, action is valid. When the action is device type, the action is valid if device is not removed and online.

◆ isValid [2/4]

- (BOOL) isValid

Detemine whether the action is valid. When the action is non-device type, action is valid. When the action is device type, the action is valid if device is not removed and online.

◆ isValid [3/4]

- (BOOL) isValid

Detemine whether the action is valid. When the action is non-device type, action is valid. When the action is device type, the action is valid if device is not removed and online.

◆ isValid [4/4]

- (BOOL) isValid

Detemine whether the action is valid. When the action is non-device type, action is valid. When the action is device type, the action is valid if device is not removed and online.

Property Documentation

◆ actionDisplay

- (NSString *) actionDisplay
readwritenonatomiccopy

Describe what this action will do, like "Switch : Open".

Definition at line 65 of file ThingSmartSceneActionModel.h.

◆ actionDisplayNew

- (NSDictionary *) actionDisplayNew
readwritenonatomicstrong

Describe what this action will do with origin format like the below example, you can use it to create the description. { 1: [ "Switch", "Open" ] }

Definition at line 74 of file ThingSmartSceneActionModel.h.

◆ actionExecutor

- (NSString *) actionExecutor
readwritenonatomiccopy

The action type, can be the followed types: "dpIssue" :execute a device action. "deviceGroupDpIssue": execute a group action. "irIssue": execute an infrared device, like an air conditioner which is controlled by a remote control. "irIssueVii": execute an infrared device, like an air conditioner which is controlled by a remote control.ExecutorProperty is real infrared ray remotes control code. "ruleTrigger": execute a scene. "ruleEnable": Enable an automation. "ruleDisable": Disable an automation. "delay": Delay for a while.

Definition at line 86 of file ThingSmartSceneActionModel.h.

◆ actionId

- (NSString *) actionId
readwritenonatomiccopy

The action id.

Definition at line 53 of file ThingSmartSceneActionModel.h.

◆ defaultIconUrl

- (NSString *) defaultIconUrl
readwritenonatomiccopy

The recommend product local default icon.

Definition at line 130 of file ThingSmartSceneActionModel.h.

◆ deleteDevIcon

- (NSString *) deleteDevIcon
readwritenonatomiccopy

If this action is a device type action, and this device has been removed from the current account, then provide this icon url to display the device icon.

Definition at line 98 of file ThingSmartSceneActionModel.h.

◆ devDelMark

- (BOOL) devDelMark
readwritenonatomicassign

If this action is a device type action and this device has been removed from the current account, this flag is YES.

Definition at line 95 of file ThingSmartSceneActionModel.h.

◆ entityId

- (NSString *) entityId
readwritenonatomiccopy

The entity id. If action is a device, entityId is devId, and groupId for group action, "delay" for a delay action, sceneId of operated scene for scene action.

Definition at line 56 of file ThingSmartSceneActionModel.h.

◆ entityName

- (NSString *) entityName
readwritenonatomiccopy

The entity name, like "lamp", "lamp group".

Definition at line 59 of file ThingSmartSceneActionModel.h.

◆ executorProperty

- (NSDictionary *) executorProperty
readwritenonatomicstrong

Execute property, like {"1":true, ...}, "1" is dpId, a data point's Id, value is the value you want this datapoint to set. Delay action should be like "executorProperty":{"seconds":"5","minutes":"0"}.

Definition at line 89 of file ThingSmartSceneActionModel.h.

◆ extraProperty

- (NSDictionary *) extraProperty
readwritenonatomicstrong

Local property of scene , save gId and gwId.

Definition at line 92 of file ThingSmartSceneActionModel.h.

◆ i18nTime

- (long) i18nTime
readwritenonatomicassign

The panel info, this value will be assigned by cloud server when this action should be oprate by a React Native panel.

Definition at line 115 of file ThingSmartSceneActionModel.h.

◆ pid

- (NSString *) pid
readwritenonatomiccopy

The panel relate device's pid, this value will be assigned by cloud server when this action should be oprate by a React Native panel.

Definition at line 118 of file ThingSmartSceneActionModel.h.

◆ productId

- (NSString *) productId
readwritenonatomiccopy

The recommend product id.

Definition at line 124 of file ThingSmartSceneActionModel.h.

◆ productPic

- (NSString *) productPic
readwritenonatomiccopy

The recommend product icon.

Definition at line 127 of file ThingSmartSceneActionModel.h.

◆ relationGroup

- (NSDictionary *) relationGroup
readwritenonatomicstrong

Batch control device information.

Definition at line 104 of file ThingSmartSceneActionModel.h.

◆ scenarioId

- (NSString *) scenarioId
readwritenonatomiccopy

The scene id, can be used to save the scene's Id which this action belonged to.

Definition at line 62 of file ThingSmartSceneActionModel.h.

◆ status

- (ThingSceneActionStatus) status
readwritenonatomicassign

Execute action status, you can use this property to store the execute status when executing.

Definition at line 101 of file ThingSmartSceneActionModel.h.

◆ uiid

- (NSString *) uiid
readwritenonatomiccopy

The panel id, this value will be assigned by cloud server when this action should be oprate by a React Native panel.

Definition at line 109 of file ThingSmartSceneActionModel.h.

◆ uiInfo

- (NSDictionary *) uiInfo
readwritenonatomicstrong

The panel info, this value will be assigned by cloud server when this action should be oprate by a React Native panel.

Definition at line 112 of file ThingSmartSceneActionModel.h.


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