Skip to content

Commit

Permalink
Improve documentation for MTROTAProviderDelegate.
Browse files Browse the repository at this point in the history
Makes it clear how to handle BDX uris and file designators
  • Loading branch information
bzbarsky-apple committed Jun 12, 2023
1 parent d676bae commit 1ace545
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/darwin/Framework/CHIP/MTROTAProviderDelegate.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1ace545

Please sign in to comment.