Skip to content

Commit a6f3b37

Browse files
woody-applerestyled-commitsanush-appleksperling-apple
authored
Updating documentation for this property (project-chip#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>
1 parent ddbbdcb commit a6f3b37

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/darwin/Framework/CHIP/MTRDevice.h

+7-3
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,16 @@ MTR_AVAILABLE(ios(16.1), macos(13.0), watchos(9.1), tvos(16.1))
6565
@property (nonatomic, readonly) MTRDeviceState state;
6666

6767
/**
68-
* Is the state cache primed for this device?
68+
* Is the device cache primed for this device?
6969
*
70-
* 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.
70+
* This will be true after the deviceCachePrimed: delegate callback has been called, false if not.
71+
*
72+
* Please note if you have a storage delegate implemented, the cache is then stored persistently, so
73+
* the would then only be called once, ever - and this property would basically always be true
74+
* if a subscription has ever been established.
7175
*
7276
*/
73-
@property (readonly) BOOL deviceCachePrimed;
77+
@property (readonly) BOOL deviceCachePrimed MTR_NEWLY_AVAILABLE;
7478

7579
/**
7680
* The estimated device system start time.

0 commit comments

Comments
 (0)