getDoorbellService

Requires:
@ray-js/lock-sdk≥1.0.0

Method signature
getDoorbellService()

Description

Get doorbell notification service info

Parameters

None

Return Value

Type: Promise<LinkageRule>
Doorbell linkage rule summary (truthy when rules exist; detail fields returned by the cloud)
LinkageRule
PropertyTypeDescription
backgroundstringService card background image URL
codestringService code; e.g., doorbell ringing is `doorbell_ring`
descriptionstringService description text
displayColorstringService primary display color (hex color value)
iconstringService icon URL
ordernumberService sort order; smaller values appear first
titlestringService title text
ruleIdstringCreated automation rule ID; not returned if not created
Automation rule details; not returned if no rule created

Examples

import { getDoorbellService } from '@ray-js/lock-sdk';
const service = await getDoorbellService();