Cet événement est compatible avec les notifications modifiables. Les notifications d'application existantes créées à partir de cet événement peuvent être mises à jour à l'aide du contenu d'un événement ultérieur avec le même eventThreadId.
Nest Doorbell (batterie)Nest Doorbell (filaire)ID attribué aux événements qui se produisent au cours d'une même session d'événements associés. Peut être utilisé pour regrouper des événements.
Utilisez-le pour associer cet événement à l'événement ClipPreview associé du trait CameraClipPreview.
Objet qui indique les ressources susceptibles d'avoir des mises à jour similaires à cet événement. La ressource de l'événement lui-même (à partir de l'objet resourceUpdate) sera toujours présente dans cet objet.
object
Pour en savoir plus sur les différents types d'événements et leur fonctionnement, consultez Événements.
Erreurs
Les codes d'erreur suivants peuvent être renvoyés en lien avec ce trait :
Message d'erreur
RPC
Dépannage
L'image de la caméra n'est plus disponible au téléchargement.
DEADLINE_EXCEEDED
Les images d'événements expirent 30 secondes après la publication de l'événement. Assurez-vous de télécharger l'image avant son expiration.
L'ID d'événement n'appartient pas à la caméra.
FAILED_PRECONDITION
Utilisez le eventID correct renvoyé par l'événement de l'appareil photo.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/01 (UTC).
[null,null,["Dernière mise à jour le 2025/09/01 (UTC)."],[[["\u003cp\u003eThe \u003ccode\u003esdm.devices.traits.DoorbellChime\u003c/code\u003e trait applies to devices with a doorbell chime and press events.\u003c/p\u003e\n"],["\u003cp\u003eThis trait does not have any associated fields or commands.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eChime\u003c/code\u003e event is triggered when the doorbell is pressed, providing an \u003ccode\u003eeventSessionId\u003c/code\u003e and \u003ccode\u003eeventId\u003c/code\u003e for further actions like retrieving a clip preview or camera image.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eChime\u003c/code\u003e events are updateable, allowing for modification of existing app notifications using subsequent events with the same \u003ccode\u003eeventThreadId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003ePotential errors include \u003ccode\u003eDEADLINE_EXCEEDED\u003c/code\u003e for expired event images and \u003ccode\u003eFAILED_PRECONDITION\u003c/code\u003e for using incorrect event IDs.\u003c/p\u003e\n"]]],["The DoorbellChime trait signals a doorbell press event. It has no fields or commands. The core event, \"Chime,\" indicates the doorbell has been pressed, and it's updateable, allowing existing notifications to be updated using the same `eventThreadId`. The event payload includes identifiers like `eventId`, `eventSessionId`, and timestamps. It also contains information about the event thread's status (`eventThreadState`) and an obfuscated user ID. Event-related errors include `DEADLINE_EXCEEDED` and `FAILED_PRECONDITION`.\n"],null,["\u003cbr /\u003e\n\nDoorbellChime Schema\n\n[Nest Doorbell (legacy)](/nest/device-access/api/doorbell) [Nest Doorbell (battery)](/nest/device-access/api/doorbell-battery) [Nest Doorbell (wired)](/nest/device-access/api/doorbell-wired)\n\n`sdm.devices.traits.DoorbellChime`\n\nThis trait belongs to any device that supports a doorbell chime and related press events.\n\n\u003cbr /\u003e\n\nFields\n\n\nThere are no fields available for this trait.\n\n\u003cbr /\u003e\n\nCommands\n\nThere are no commands available for this trait.\n\nEvents\n\n\u003cbr /\u003e\n\nChime [Updateable](/nest/device-access/api/events#updateable_notifications)\n\nThe doorbell has been pressed.\n\nThis event supports updateable notifications. Existing app notifications created from this event can be updated using the content of an subsequent event with the same `eventThreadId`.\n\nChime event \n\nPayload \n\n {\n \"eventId\" : \"04e227fe-f340-41d1-ad55-4d64f80399c7\",\n \"timestamp\" : \"2019-01-01T00:00:01Z\",\n \"resourceUpdate\" : {\n \"name\" : \"enterprises/project-id/devices/device-id\",\n \"events\" : {\n \"sdm.devices.events.DoorbellChime.Chime\" : {\n \"eventSessionId\" : \"CjY5Y3VKaTZwR3o4Y19YbTVfMF...\",\n \"eventId\" : \"NzV-7iDph3m14dWX4qxfqiTfUw...\"\n }\n }\n }\n \"userId\" : \"AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi\",\n \"eventThreadId\" : \"d67cd3f7-86a7-425e-8bb3-462f92ec9f59\",\n \"eventThreadState\" : \"STARTED\",\n \"resourceGroup\" : [\n \"enterprises/project-id/devices/device-id\"\n ]\n }\n\nChime event fields\n\n| Field | Description | Data Type |\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|\n| `eventSessionId` | [Nest Doorbell (battery)](/nest/device-access/api/doorbell-battery) [Nest Doorbell (wired)](/nest/device-access/api/doorbell-wired) An ID given to events occurring as part of a single session of related events. May be used for consolidating events. Use it to associate this event with the related [ClipPreview](/nest/device-access/traits/device/camera-clip-preview#clippreview) event of the CameraClipPreview trait. | `string` Example: \"CjY5Y3VKaTZwR3o4Y19YbTVfMF...\" |\n| `eventId` | [Nest Doorbell (legacy)](/nest/device-access/api/doorbell) An ID associated with the event. Use it with the [GenerateImage command](/nest/device-access/traits/device/camera-event-image#generateimage) to download the camera image related to this event. | `string` Example: \"NzV-7iDph3m14dWX4qxfqiTfUw...\" |\n\nEvent payload fields\n\n| Field | Description | Data Type |\n|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|\n| `eventId` | The unique identifier for the event. | `string` Example: \"04e227fe-f340-41d1-ad55-4d64f80399c7\" |\n| `timestamp` | The time when the event occurred. | `string` Example: \"2019-01-01T00:00:01Z\" |\n| `resourceUpdate` | An object that details information about the resource update. | `object` |\n| `userId` | A unique, obfuscated identifier that represents the user. | `string` Example: \"AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi\" |\n| `eventThreadId` | [Updateable](/nest/device-access/api/events#updateable_notifications) The unique identifier for the event thread. | `string` Example: \"d67cd3f7-86a7-425e-8bb3-462f92ec9f59\" |\n| `eventThreadState` | [Updateable](/nest/device-access/api/events#updateable_notifications) The state of the event thread. | `string` Values: \"STARTED\", \"UPDATED\", \"ENDED\" |\n| `resourceGroup` | An object that indicates resources that might have similar updates to this event. The resource of the event itself (from the `resourceUpdate` object) will always be present in this object. | `object` |\n\nSee [Events](/nest/device-access/api/events) for more information on the different\ntypes of events and how they work.\n\n\u003cbr /\u003e\n\n\nErrors\n\nThe following error code(s) may be returned in relation to this trait:\n\n| Error Message | RPC | Troubleshooting |\n|---------------------------------------------------|-----------------------|-------------------------------------------------------------------------------------------------------------------|\n| Camera image is no longer available for download. | `DEADLINE_EXCEEDED` | Event images expire 30 seconds after the event is published. Make sure to download the image prior to expiration. |\n| Event id does not belong to the camera. | `FAILED_PRECONDITION` | Use the correct `eventID` returned by the camera event. |\n\nSee the [API Error Code Reference](/nest/device-access/reference/errors/api) for\nthe full list of API error codes.\n\n\u003cbr /\u003e"]]
