From 1089020f12e985ef21f1e1f32ddd4a2c129f9411 Mon Sep 17 00:00:00 2001 From: Boris Zbarsky Date: Tue, 13 Jun 2023 10:00:20 -0400 Subject: [PATCH] Improve documentation for MTROTAProviderDelegate. (#27206) Makes it clear how to handle BDX uris and file designators --- src/darwin/Framework/CHIP/MTROTAProviderDelegate.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/darwin/Framework/CHIP/MTROTAProviderDelegate.h b/src/darwin/Framework/CHIP/MTROTAProviderDelegate.h index 469741e798db6d..d9566b47d61362 100644 --- a/src/darwin/Framework/CHIP/MTROTAProviderDelegate.h +++ b/src/darwin/Framework/CHIP/MTROTAProviderDelegate.h @@ -45,6 +45,13 @@ NS_ASSUME_NONNULL_BEGIN * If completion is passed a non-nil error, that will be converted into * an error response to the client. Otherwise it must have a non-nil data, * which will be returned to the client. + * + * When providing an OTA image, the imageURI in the + * MTROTASoftwareUpdateProviderClusterQueryImageResponseParams must be set to + * the file designator of the image. The completion will create the right BDX + * URI from that file designator, as needed. The file designator returned here + * via imageURI will be the same as the file designator passed to + * handleBDXTransferSessionBeginForNodeID:controller:fileDesignator:offset:completion:. */ - (void)handleQueryImageForNodeID:(NSNumber *)nodeID controller:(MTRDeviceController *)controller