Updating documentation for this property (#32561)
* Initial commit
* Restyled by whitespace
* Restyled by clang-format
* Update src/darwin/Framework/CHIP/MTRDevice.mm
Co-authored-by: Anush Nadathur <anush@apple.com>
* Update src/darwin/Framework/CHIP/MTRDevice.h
Co-authored-by: Karsten Sperling <113487422+ksperling-apple@users.noreply.github.com>
* Adding header
* Restyled by clang-format
* Updating docs
---------
Co-authored-by: Restyled.io <commits@restyled.io>
Co-authored-by: Anush Nadathur <anush@apple.com>
Co-authored-by: Karsten Sperling <113487422+ksperling-apple@users.noreply.github.com>
diff --git a/src/darwin/Framework/CHIP/MTRDevice.h b/src/darwin/Framework/CHIP/MTRDevice.h
index d2404c2..3bb39e9 100644
--- a/src/darwin/Framework/CHIP/MTRDevice.h
+++ b/src/darwin/Framework/CHIP/MTRDevice.h
@@ -65,12 +65,16 @@
@property (nonatomic, readonly) MTRDeviceState state;
/**
- * Is the state cache primed for this device?
+ * Is the device cache primed for this device?
*
- * This verifies that both the MTRDeviceController has a storage delegate, and a subscription has been set up and the resulting state has been cached. If this is true this means most state is ready to cache and will not require a round trip to the accessory.
+ * This will be true after the deviceCachePrimed: delegate callback has been called, false if not.
+ *
+ * Please note if you have a storage delegate implemented, the cache is then stored persistently, so
+ * the would then only be called once, ever - and this property would basically always be true
+ * if a subscription has ever been established.
*
*/
-@property (readonly) BOOL deviceCachePrimed;
+@property (readonly) BOOL deviceCachePrimed MTR_NEWLY_AVAILABLE;
/**
* The estimated device system start time.
