ThingSmartSceneModel provides more data attributes for developers to implement business logic of the scene. More...

#import <ThingSmartSceneModel.h>

Inheritance diagram for ThingSmartSceneModel:

Instance Methods
(BOOL)	- isManual

(BOOL)	- isRecommend

(BOOL)	- isCollection

(NSSet *)	- offlineDevices

(NSSet *)	- deletedDevices

(BOOL)	- containExceptionDevice

(NSInteger)	- effectiveActionCount

(BOOL)	- containsUnpurchasedDevice

(BOOL)	- isManual

(BOOL)	- isRecommend

(BOOL)	- isCollection

(NSSet *)	- offlineDevices

(NSSet *)	- deletedDevices

(BOOL)	- containExceptionDevice

(NSInteger)	- effectiveActionCount

(BOOL)	- containsUnpurchasedDevice

(BOOL)	- isManual

(BOOL)	- isRecommend

(BOOL)	- isCollection

(NSSet *)	- offlineDevices

(NSSet *)	- deletedDevices

(BOOL)	- containExceptionDevice

(NSInteger)	- effectiveActionCount

(BOOL)	- containsUnpurchasedDevice

(BOOL)	- isManual

(BOOL)	- isRecommend

(BOOL)	- isCollection

(NSSet *)	- offlineDevices

(NSSet *)	- deletedDevices

(BOOL)	- containExceptionDevice

(NSInteger)	- effectiveActionCount

(BOOL)	- containsUnpurchasedDevice

Properties
NSString *	sceneId
	The scene id, it's unique. But only custom scene has this property. More...

NSString *	code
	The scene code, only default scene has this property. More...

NSString *	name
	The scene name, it describes what the scene is used to. More...

BOOL	enabled
	Whether the scene enabled, this status is used to automation scene and default enabled in tap-to-run scene. More...

BOOL	stickyOnTop
	Whether show scene in first page, the status only can be switched when editing scene. More...

NSArray< ThingSmartScenePreConditionModel * > *	preConditions
	The pre condition object model list is used to set the valid time period for automation scene. More information about ThingSmartScenePreConditionModel, you can see ThingSmartScenePreConditionModel class. More...

NSArray< ThingSmartSceneConditionModel * > *	conditions
	The condition model list,. More...

NSArray< ThingSmartSceneActionModel * > *	actions
	The action model list,. More...

NSArray< ThingSmartSceneConditionModel * > *	statusConditions
	The status condition model list. More...

NSArray *	devList
	The device list,. More...

NSString *	coverIcon
	The scene background icon URL. More...

NSString *	displayColor
	The scene background color hex string. More...

NSString *	background
	The scene background URL, when created a new scene, use the URL provided by Thing. More...

ThingSmartConditionMatchType	matchType
	The condition match type, For detail you can see ThingSmartConditionMatchType enumeration value introduction. More...

ThingSmartConditionSubMatchType	subMatchType
	The status condition match type, For detail you can see ThingSmartConditionMatchType enumeration value introduction. More...

BOOL	boundForPanel
	Whether this scene is bound to a panel. This attribute only supports standard zigbee devices. More...

BOOL	boundForWiFiPanel
	Whether this scene is bound by a panel with new firmware. The new panel indicates that the scene supports zigbee devices and wifi devices. More...

BOOL	localLinkage
	Whether the automation scene supports to execute in LAN, If YES indicates the automation scene can be executed when zigbee gateway is offline. More...

BOOL	newLocalScene
	Whether the tap-to-run scene supports to execute in LAN, If YES indicates you can directly notify the zigbee gateway to execute the scene through TCP or MQTT messages. More...

ThingSmartScenePanelType	panelType
	The bound panel type, For detail you can see ThingSmartScenePanelType enumeration value introduction. More...

ThingSmartSceneRecommendType	recommendType
	The recommend scene type, For detail you can see ThingSmartSceneRecommendType enumeration value introduction. More...

ThingSmartSceneCollectionType	collectionType
	The collection scene type, For detail you can see ThingSmartSceneCollectionType enumeration value introduction. More...

NSString *	recomDescription
	The recommend scene description. More...

CGFloat	recomCoefficient
	The recommended coefficient value of recommended scene, the range value is 0-100. More...

long long	disableTime
	The timestamp when the automation scene will be automatically closed, The zero means it has not been set. More...

ThingSmartSceneWorkingStatus	outOfWork
	Describe scenario execution status，See enum `ThingSmartSceneWorkingStatus`. More...

BOOL	notShowInTabList
	When is true, this scene not disappear in scene tab view. More...

ThingLocalLinkageType	linkageType
	The linkage type. More...

NSArray *	roomIds
	The room id list, eg:"123,234". More...

NSArray< NSString * > *	categorys
	The category id list, eg:"xadacc,cag1af3". More...

NSString *	gwId
	The master gateway id. More...

BOOL	cached
	Whether the scene has already obtained details. More...

NSString *	arrowIconUrl
	The arrow icon URL. More...

NSString *	hotCount
	The hot value of recommended scene. More...

ThingSmartSceneRuleGenre	ruleGenre
	The type of scene. More...

NSString *subTitle	__deprecated
	The scene subtitle. More...

NSString *editIcon	__deprecated
	The scene edit icon URL. More...

NSString *displayIcon	__deprecated
	The scene display icon URL. More...

TSceneRecomBizType	bizType
	The recommend source biz type. More...

NSString *	recommendSource
	The recommend source description. More...

NSString *	jumpUrl
	The target jump URL. More...

NSString *	jumpType
	The type of target page. More...

NSString *	iconUrl
	The icon url. More...

NSString *	iconTitle
	The icon title. More...

Detailed Description

ThingSmartSceneModel provides more data attributes for developers to implement business logic of the scene.

Definition at line 79 of file ThingSmartSceneModel.h.

Method Documentation

◆ containExceptionDevice [1/4]

- (BOOL) containExceptionDevice

Determine whether the scene contains exception devices, offline and removed devices are exception devices.

◆ containExceptionDevice [2/4]

- (BOOL) containExceptionDevice

Determine whether the scene contains exception devices, offline and removed devices are exception devices.

◆ containExceptionDevice [3/4]

- (BOOL) containExceptionDevice

Determine whether the scene contains exception devices, offline and removed devices are exception devices.

◆ containExceptionDevice [4/4]

- (BOOL) containExceptionDevice

Determine whether the scene contains exception devices, offline and removed devices are exception devices.

◆ containsUnpurchasedDevice [1/4]

- (BOOL) containsUnpurchasedDevice

Determine whether the scene contains devices to be purchased.

◆ containsUnpurchasedDevice [2/4]

- (BOOL) containsUnpurchasedDevice

Determine whether the scene contains devices to be purchased.

◆ containsUnpurchasedDevice [3/4]

- (BOOL) containsUnpurchasedDevice

Determine whether the scene contains devices to be purchased.

◆ containsUnpurchasedDevice [4/4]

- (BOOL) containsUnpurchasedDevice

Determine whether the scene contains devices to be purchased.

◆ deletedDevices [1/4]

- (NSSet *) deletedDevices

Return set of devices did removed in the scene.

◆ deletedDevices [2/4]

- (NSSet *) deletedDevices

Return set of devices did removed in the scene.

◆ deletedDevices [3/4]

- (NSSet *) deletedDevices

Return set of devices did removed in the scene.

◆ deletedDevices [4/4]

- (NSSet *) deletedDevices

Return set of devices did removed in the scene.

◆ effectiveActionCount [1/4]

- (NSInteger) effectiveActionCount

Return the number of valid actions in the scene.

◆ effectiveActionCount [2/4]

- (NSInteger) effectiveActionCount

Return the number of valid actions in the scene.

◆ effectiveActionCount [3/4]

- (NSInteger) effectiveActionCount

Return the number of valid actions in the scene.

◆ effectiveActionCount [4/4]

- (NSInteger) effectiveActionCount

Return the number of valid actions in the scene.

◆ isCollection [1/4]

- (BOOL) isCollection

Determine whether is collection scene.

◆ isCollection [2/4]

- (BOOL) isCollection

Determine whether is collection scene.

◆ isCollection [3/4]

- (BOOL) isCollection

Determine whether is collection scene.

◆ isCollection [4/4]

- (BOOL) isCollection

Determine whether is collection scene.

◆ isManual [1/4]

- (BOOL) isManual

Determine whether is manual scene.

◆ isManual [2/4]

- (BOOL) isManual

Determine whether is manual scene.

◆ isManual [3/4]

- (BOOL) isManual

Determine whether is manual scene.

◆ isManual [4/4]

- (BOOL) isManual

Determine whether is manual scene.

◆ isRecommend [1/4]

- (BOOL) isRecommend

Determine whether is recommend scene.

◆ isRecommend [2/4]

- (BOOL) isRecommend

Determine whether is recommend scene.

◆ isRecommend [3/4]

- (BOOL) isRecommend

Determine whether is recommend scene.

◆ isRecommend [4/4]

- (BOOL) isRecommend

Determine whether is recommend scene.

◆ offlineDevices [1/4]

- (NSSet *) offlineDevices

Return set for offline devices in the scene.

◆ offlineDevices [2/4]

- (NSSet *) offlineDevices

Return set for offline devices in the scene.

◆ offlineDevices [3/4]

- (NSSet *) offlineDevices

Return set for offline devices in the scene.

◆ offlineDevices [4/4]

- (NSSet *) offlineDevices

Return set for offline devices in the scene.

Property Documentation

◆ __deprecated [1/3]

- (NSString *displayIcon) __deprecated

readwritenonatomicstrong

The scene subtitle.

The scene display icon URL.

The scene edit icon URL.

Definition at line 191 of file ThingSmartSceneModel.h.

◆ __deprecated [2/3]

- (NSString* editIcon) __deprecated

readwritenonatomicstrong

The scene edit icon URL.

Definition at line 194 of file ThingSmartSceneModel.h.

◆ __deprecated [3/3]

- (NSString* displayIcon) __deprecated

readwritenonatomicstrong

The scene display icon URL.

Definition at line 197 of file ThingSmartSceneModel.h.

◆ actions

- (NSArray< ThingSmartSceneActionModel * > *) actions

readwritenonatomicstrong

The action model list,.

Definition at line 103 of file ThingSmartSceneModel.h.

◆ arrowIconUrl

- (NSString *) arrowIconUrl

readwritenonatomiccopy

The arrow icon URL.

Definition at line 180 of file ThingSmartSceneModel.h.

◆ background

- (NSString *) background

readwritenonatomicstrong

The scene background URL, when created a new scene, use the URL provided by Thing.

Definition at line 118 of file ThingSmartSceneModel.h.

◆ bizType

- (TSceneRecomBizType) bizType

readnonatomicassign

The recommend source biz type.

Provided by category ThingSmartSceneModel(ThingSceneRecom).

Definition at line 247 of file ThingSmartSceneModel.h.

◆ boundForPanel

- (BOOL) boundForPanel

readwritenonatomicassign

Whether this scene is bound to a panel. This attribute only supports standard zigbee devices.

Definition at line 127 of file ThingSmartSceneModel.h.

◆ boundForWiFiPanel

- (BOOL) boundForWiFiPanel

readwritenonatomicassign

Whether this scene is bound by a panel with new firmware. The new panel indicates that the scene supports zigbee devices and wifi devices.

Definition at line 130 of file ThingSmartSceneModel.h.

◆ cached

- (BOOL) cached

readwritenonatomicassign

Whether the scene has already obtained details.

Definition at line 177 of file ThingSmartSceneModel.h.

◆ categorys

- (NSArray< NSString * > *) categorys

readwritenonatomiccopy

The category id list, eg:"xadacc,cag1af3".

Definition at line 169 of file ThingSmartSceneModel.h.

◆ code

- (NSString *) code

readwritenonatomicstrong

The scene code, only default scene has this property.

Definition at line 85 of file ThingSmartSceneModel.h.

◆ collectionType

- (ThingSmartSceneCollectionType) collectionType

readwritenonatomicassign

The collection scene type, For detail you can see ThingSmartSceneCollectionType enumeration value introduction.

Definition at line 145 of file ThingSmartSceneModel.h.

◆ conditions

- (NSArray< ThingSmartSceneConditionModel * > *) conditions

readwritenonatomicstrong

The condition model list,.

Definition at line 100 of file ThingSmartSceneModel.h.

◆ coverIcon

- (NSString *) coverIcon

readwritenonatomiccopy

The scene background icon URL.

Definition at line 112 of file ThingSmartSceneModel.h.

◆ devList

- (NSArray *) devList

readwritenonatomicstrong

The device list,.

Definition at line 109 of file ThingSmartSceneModel.h.

◆ disableTime

- (long long) disableTime

readwritenonatomicassign

The timestamp when the automation scene will be automatically closed, The zero means it has not been set.

Definition at line 154 of file ThingSmartSceneModel.h.

◆ displayColor

- (NSString *) displayColor

readwritenonatomiccopy

The scene background color hex string.

Provided by category ThingSmartSceneModel(ThingSceneRecom).

Definition at line 115 of file ThingSmartSceneModel.h.

◆ enabled

- (BOOL) enabled

readwritenonatomicassign

Whether the scene enabled, this status is used to automation scene and default enabled in tap-to-run scene.

Definition at line 91 of file ThingSmartSceneModel.h.

◆ gwId

- (NSString *) gwId

readwritenonatomiccopy

The master gateway id.

Definition at line 172 of file ThingSmartSceneModel.h.

◆ hotCount

- (NSString *) hotCount

readwritenonatomiccopy

The hot value of recommended scene.

Definition at line 183 of file ThingSmartSceneModel.h.

◆ iconTitle

- (NSString *) iconTitle

readwritenonatomiccopy

The icon title.

Provided by category ThingSmartSceneModel(ThingSceneRecom).

Definition at line 259 of file ThingSmartSceneModel.h.

◆ iconUrl

- (NSString *) iconUrl

readwritenonatomiccopy

The icon url.

Provided by category ThingSmartSceneModel(ThingSceneRecom).

Definition at line 255 of file ThingSmartSceneModel.h.

◆ jumpType

- (NSString *) jumpType

readwritenonatomiccopy

The type of target page.

Provided by category ThingSmartSceneModel(ThingSceneRecom).

Definition at line 253 of file ThingSmartSceneModel.h.

◆ jumpUrl

- (NSString *) jumpUrl

readwritenonatomiccopy

The target jump URL.

Provided by category ThingSmartSceneModel(ThingSceneRecom).

Definition at line 251 of file ThingSmartSceneModel.h.

◆ linkageType

- (ThingLocalLinkageType) linkageType

readwritenonatomicassign

The linkage type.

Definition at line 163 of file ThingSmartSceneModel.h.

◆ localLinkage

- (BOOL) localLinkage

readwritenonatomicassign

Whether the automation scene supports to execute in LAN, If YES indicates the automation scene can be executed when zigbee gateway is offline.

Definition at line 133 of file ThingSmartSceneModel.h.

◆ matchType

- (ThingSmartConditionMatchType) matchType

readwritenonatomicassign

The condition match type, For detail you can see ThingSmartConditionMatchType enumeration value introduction.

Definition at line 121 of file ThingSmartSceneModel.h.

◆ name

- (NSString *) name

readwritenonatomicstrong

The scene name, it describes what the scene is used to.

Definition at line 88 of file ThingSmartSceneModel.h.

◆ newLocalScene

- (BOOL) newLocalScene

readwritenonatomicassign

Whether the tap-to-run scene supports to execute in LAN, If YES indicates you can directly notify the zigbee gateway to execute the scene through TCP or MQTT messages.

Definition at line 136 of file ThingSmartSceneModel.h.

◆ notShowInTabList

- (BOOL) notShowInTabList

readwritenonatomicassign

When is true, this scene not disappear in scene tab view.

Definition at line 160 of file ThingSmartSceneModel.h.

◆ outOfWork

- (ThingSmartSceneWorkingStatus) outOfWork

readwritenonatomicassign

Describe scenario execution status，See enum ThingSmartSceneWorkingStatus.

Definition at line 157 of file ThingSmartSceneModel.h.

◆ panelType

- (ThingSmartScenePanelType) panelType

readwritenonatomicassign

The bound panel type, For detail you can see ThingSmartScenePanelType enumeration value introduction.

Definition at line 139 of file ThingSmartSceneModel.h.

◆ preConditions

- (NSArray< ThingSmartScenePreConditionModel * > *) preConditions

readwritenonatomicstrong

The pre condition object model list is used to set the valid time period for automation scene. More information about ThingSmartScenePreConditionModel, you can see ThingSmartScenePreConditionModel class.

Definition at line 97 of file ThingSmartSceneModel.h.

◆ recomCoefficient

- (CGFloat) recomCoefficient

readwritenonatomicassign

The recommended coefficient value of recommended scene, the range value is 0-100.

Definition at line 151 of file ThingSmartSceneModel.h.

◆ recomDescription

- (NSString *) recomDescription

readwritenonatomiccopy

The recommend scene description.

Definition at line 148 of file ThingSmartSceneModel.h.

◆ recommendSource

- (NSString *) recommendSource

readwritenonatomiccopy

The recommend source description.

Provided by category ThingSmartSceneModel(ThingSceneRecom).

Definition at line 249 of file ThingSmartSceneModel.h.

◆ recommendType

- (ThingSmartSceneRecommendType) recommendType

readwritenonatomicassign

The recommend scene type, For detail you can see ThingSmartSceneRecommendType enumeration value introduction.

Definition at line 142 of file ThingSmartSceneModel.h.

◆ roomIds

- (NSArray *) roomIds

readwritenonatomiccopy

The room id list, eg:"123,234".

Definition at line 166 of file ThingSmartSceneModel.h.

◆ ruleGenre

- (ThingSmartSceneRuleGenre) ruleGenre

readwritenonatomicassign

The type of scene.

Definition at line 186 of file ThingSmartSceneModel.h.

◆ sceneId

- (NSString *) sceneId

readwritenonatomicstrong

The scene id, it's unique. But only custom scene has this property.

Definition at line 82 of file ThingSmartSceneModel.h.

◆ statusConditions

- (NSArray< ThingSmartSceneConditionModel * > *) statusConditions

readwritenonatomicstrong

The status condition model list.

Definition at line 106 of file ThingSmartSceneModel.h.

◆ stickyOnTop

- (BOOL) stickyOnTop

readwritenonatomicassign

Whether show scene in first page, the status only can be switched when editing scene.

Definition at line 94 of file ThingSmartSceneModel.h.

◆ subMatchType

- (ThingSmartConditionSubMatchType) subMatchType

readwritenonatomicassign

The status condition match type, For detail you can see ThingSmartConditionMatchType enumeration value introduction.

Definition at line 124 of file ThingSmartSceneModel.h.

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

/Users/humtong/Downloads/Pods_副本/ThingSmartSceneCoreKit/Build/ThingSmartSceneCoreKit.xcframework/ios-arm64_x86_64-simulator/ThingSmartSceneCoreKit.framework/Headers/ThingSmartSceneModel.h
/Users/humtong/Downloads/Pods_副本/ThingSmartSceneCoreKit/Build/ThingSmartSceneCoreKit.xcframework/watchos-arm64_i386_x86_64-simulator/ThingSmartSceneCoreKit.framework/Headers/ThingSmartSceneModel.h
/Users/humtong/Downloads/Pods_副本/ThingSmartSceneCoreKit/Build/ThingSmartSceneCoreKit.xcframework/ios-arm64/ThingSmartSceneCoreKit.framework/Headers/ThingSmartSceneModel.h
/Users/humtong/Downloads/Pods_副本/ThingSmartSceneCoreKit/Build/ThingSmartSceneCoreKit.xcframework/watchos-arm64_arm64_32_armv7k/ThingSmartSceneCoreKit.framework/Headers/ThingSmartSceneModel.h

Instance Methods

Properties

Detailed Description

Method Documentation

◆ containExceptionDevice [1/4]

◆ containExceptionDevice [2/4]

◆ containExceptionDevice [3/4]

◆ containExceptionDevice [4/4]

◆ containsUnpurchasedDevice [1/4]

◆ containsUnpurchasedDevice [2/4]

◆ containsUnpurchasedDevice [3/4]

◆ containsUnpurchasedDevice [4/4]

◆ deletedDevices [1/4]

◆ deletedDevices [2/4]

◆ deletedDevices [3/4]

◆ deletedDevices [4/4]

◆ effectiveActionCount [1/4]

◆ effectiveActionCount [2/4]

◆ effectiveActionCount [3/4]

◆ effectiveActionCount [4/4]

◆ isCollection [1/4]

◆ isCollection [2/4]

◆ isCollection [3/4]

◆ isCollection [4/4]

◆ isManual [1/4]

◆ isManual [2/4]

◆ isManual [3/4]

◆ isManual [4/4]

◆ isRecommend [1/4]

◆ isRecommend [2/4]

◆ isRecommend [3/4]

◆ isRecommend [4/4]

◆ offlineDevices [1/4]

◆ offlineDevices [2/4]

◆ offlineDevices [3/4]

◆ offlineDevices [4/4]

Property Documentation

◆ __deprecated [1/3]

◆ __deprecated [2/3]

◆ __deprecated [3/3]

◆ actions

◆ arrowIconUrl

◆ background

◆ bizType

◆ boundForPanel

◆ boundForWiFiPanel

◆ cached

◆ categorys

◆ code

◆ collectionType

◆ conditions

◆ coverIcon

◆ devList

◆ disableTime

◆ displayColor

◆ enabled

◆ gwId

◆ hotCount

◆ iconTitle

◆ iconUrl

◆ jumpType

◆ jumpUrl

◆ linkageType

◆ localLinkage

◆ matchType

◆ name

◆ newLocalScene

◆ notShowInTabList

◆ outOfWork

◆ panelType

◆ preConditions

◆ recomCoefficient

◆ recomDescription

◆ recommendSource

◆ recommendType

◆ roomIds

◆ ruleGenre

◆ sceneId

◆ statusConditions

◆ stickyOnTop