getCustomAlarmList – Tuya MiniApp

SmartAlarmAbility.getCustomAlarmList(options?: GetCustomAlarmListParams)

Requires:

@ray-js/panel-sdk≥1.8.0

Description

Query the list of custom alert rules

Parameters

Parameter	Type	Required	Description
		No	Query parameters

Return Value

Type: Promise<CustomAlarmList>

Custom alarm rule list, including triggerRuleId, triggerRuleVO, bizDomain, bindId, etc.

Referenced Types

typeCustomAlarmList

export type CustomAlarmList = CustomAlarmRule[];

typeCustomAlarmRule

Property	Type	Description
`triggerRuleId`	string	ID of the rule executed by the alarm
		Details of the rule that triggers the alarm; see AlarmTriggerRuleVO
`bizDomain`	string	Business domain identifier, fixed as miniAppPanelSDKAlarm in the alarm SDK
`associativeEntityValue`	string	Used when associativeEntityId is not sufficient to distinguish cases—for example, when the same DP is used but alarm types must be differentiated. You can use DpValue; generally not required.
`sourceEntityId`	string	Device ID associated with the current alarm
`name`	string	Name or note
`icon`	string	Icon
`bindId`	number	Binding ID
`associativeEntityId`	string	DP ID associated with the current alarm
`enable`	boolean	Whether enabled

Examples

Example

// Get all custom alarms
const rules = await sdm.alarm.getCustomAlarmList();
console.log('Custom alarm count:', rules.length);

// Filter by DP
const dpRules = await sdm.alarm.getCustomAlarmList({ dpId: '1' });