Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for MTROTAProviderDelegate. #27206

Merged
merged 1 commit into from
Jun 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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