Mark unique_id() override as deprecated (#4538)

This commit is contained in:
Oxan van Leeuwen 2023-03-09 01:06:20 +01:00 committed by GitHub
parent da056866ff
commit afc1c83af4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 3 deletions

View File

@ -150,10 +150,9 @@ class Sensor : public EntityBase {
/// Return whether this sensor has gotten a full state (that passed through all filters) yet.
bool has_state() const;
/** A unique ID for this sensor, empty for no unique id. See unique ID requirements:
* https://developers.home-assistant.io/docs/en/entity_registry_index.html#unique-id-requirements
/** Override this method to set the unique ID of this sensor.
*
* @return The unique id as a string.
* @deprecated Do not use for new sensors, a suitable unique ID is automatically generated (2023.4).
*/
virtual std::string unique_id();

View File

@ -61,6 +61,10 @@ class TextSensor : public EntityBase {
// ========== INTERNAL METHODS ==========
// (In most use cases you won't need these)
/** Override this method to set the unique ID of this sensor.
*
* @deprecated Do not use for new sensors, a suitable unique ID is automatically generated (2023.4).
*/
virtual std::string unique_id();
bool has_state();