| /** |
| * |
| * Copyright (c) 2022 Project CHIP Authors |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| #import <Foundation/Foundation.h> |
| #import <Matter/Matter.h> |
| |
| NS_ASSUME_NONNULL_BEGIN |
| |
| typedef void (^MTRQueryImageCompletionHandler)( |
| MTROTASoftwareUpdateProviderClusterQueryImageResponseParams * _Nullable data, NSError * _Nullable error); |
| |
| typedef void (^MTRApplyUpdateRequestCompletionHandler)( |
| MTROTASoftwareUpdateProviderClusterApplyUpdateResponseParams * _Nullable data, NSError * _Nullable error); |
| |
| typedef void (^MTRBDXQueryCompletionHandler)(NSData * _Nullable data, BOOL isEOF); |
| |
| MTR_NEWLY_DEPRECATED("Please use MTRQueryImageCompletionHandler") |
| typedef void (^MTRQueryImageCompletionHandlerDeprecated)( |
| MTROtaSoftwareUpdateProviderClusterQueryImageResponseParams * _Nullable data, NSError * _Nullable error); |
| |
| MTR_NEWLY_DEPRECATED("Plase Use MTRApplyUpdateRequestCompletionHandler") |
| typedef void (^MTRApplyUpdateRequestCompletionHandlerDeprecated)( |
| MTROtaSoftwareUpdateProviderClusterApplyUpdateResponseParams * _Nullable data, NSError * _Nullable error); |
| |
| /** |
| * The protocol definition for the MTROTAProviderDelegate |
| * |
| * All delegate methods will be called on the supplied Delegate Queue. |
| * |
| * While the selectors on this protocol are marked @optional, in practice an |
| * implementation must provide an implementation for one of each pair of |
| * selectors (e.g. one of the two handleQueryImageForNodeID selectors must be |
| * implemented). The selector ending in "completion:" will be used if present; |
| * otherwise the one ending in "completionHandler:" will be used. |
| */ |
| @protocol MTROTAProviderDelegate <NSObject> |
| @optional |
| /** |
| * Notify the delegate when the query image command is received from some node. |
| * The controller identifies the fabric the node is on, and the nodeID |
| * identifies the node within that fabric. |
| * |
| * 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. |
| */ |
| - (void)handleQueryImageForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| params:(MTROTASoftwareUpdateProviderClusterQueryImageParams *)params |
| completion:(MTRQueryImageCompletionHandler)completion MTR_NEWLY_AVAILABLE; |
| - (void)handleQueryImageForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| params:(MTROtaSoftwareUpdateProviderClusterQueryImageParams *)params |
| completionHandler:(MTRQueryImageCompletionHandlerDeprecated)completionHandler |
| MTR_NEWLY_DEPRECATED("Please use the selector ending in completion:"); |
| |
| /** |
| * Notify the delegate when the apply update request command is received from |
| * some node. The controller identifies the fabric the node is on, and the |
| * nodeID identifies the node within that fabric. |
| * |
| * 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. |
| */ |
| - (void)handleApplyUpdateRequestForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| params:(MTROTASoftwareUpdateProviderClusterApplyUpdateRequestParams *)params |
| completion:(MTRApplyUpdateRequestCompletionHandler)completion MTR_NEWLY_AVAILABLE; |
| - (void)handleApplyUpdateRequestForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| params:(MTROtaSoftwareUpdateProviderClusterApplyUpdateRequestParams *)params |
| completionHandler:(MTRApplyUpdateRequestCompletionHandlerDeprecated)completionHandler |
| MTR_NEWLY_DEPRECATED("Please use the selector ending in completion:"); |
| |
| /** |
| * Notify the delegate when the notify update applied command is received from |
| * some node. The controller identifies the fabric the node is on, and the |
| * nodeID identifies the node within that fabric. |
| * |
| * If completion is passed a non-nil error, that will be converted into |
| * an error response to the client. Otherwise a success response will be sent. |
| */ |
| - (void)handleNotifyUpdateAppliedForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| params:(MTROTASoftwareUpdateProviderClusterNotifyUpdateAppliedParams *)params |
| completion:(MTRStatusCompletion)completion MTR_NEWLY_AVAILABLE; |
| - (void)handleNotifyUpdateAppliedForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| params:(MTROtaSoftwareUpdateProviderClusterNotifyUpdateAppliedParams *)params |
| completionHandler:(StatusCompletion)completionHandler |
| MTR_NEWLY_DEPRECATED("Please use the selector ending in completion:"); |
| |
| /** |
| * Notify the delegate when a BDX Session starts for some node. The controller |
| * identifies the fabric the node is on, and the nodeID identifies the node |
| * within that fabric. |
| */ |
| - (void)handleBDXTransferSessionBeginForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| fileDesignator:(NSString *)fileDesignator |
| offset:(NSNumber *)offset |
| completion:(MTRStatusCompletion)completion MTR_NEWLY_AVAILABLE; |
| - (void)handleBDXTransferSessionBeginForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| fileDesignator:(NSString *)fileDesignator |
| offset:(NSNumber *)offset |
| completionHandler:(StatusCompletion)completionHandler |
| MTR_NEWLY_DEPRECATED("Please use the selector ending in completion:"); |
| |
| /** |
| * Notify the delegate when a BDX Session ends for some node. The controller |
| * identifies the fabric the node is on, and the nodeID identifies the node |
| * within that fabric. |
| */ |
| - (void)handleBDXTransferSessionEndForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| error:(NSError * _Nullable)error; |
| |
| /** |
| * Notify the delegate when a BDX Query message has been received for some node. |
| * The controller identifies the fabric the node is on, and the nodeID |
| * identifies the node within that fabric. |
| */ |
| - (void)handleBDXQueryForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| blockSize:(NSNumber *)blockSize |
| blockIndex:(NSNumber *)blockIndex |
| bytesToSkip:(NSNumber *)bytesToSkip |
| completion:(MTRBDXQueryCompletionHandler)completion MTR_NEWLY_AVAILABLE; |
| - (void)handleBDXQueryForNodeID:(NSNumber *)nodeID |
| controller:(MTRDeviceController *)controller |
| blockSize:(NSNumber *)blockSize |
| blockIndex:(NSNumber *)blockIndex |
| bytesToSkip:(NSNumber *)bytesToSkip |
| completionHandler:(MTRBDXQueryCompletionHandler)completionHandler |
| MTR_NEWLY_DEPRECATED("Please use the selector ending in completion:"); |
| |
| @end |
| |
| NS_ASSUME_NONNULL_END |
