Package apple.matter.protocol

Interface MTROTAProviderDelegate

public interface MTROTAProviderDelegate

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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MTROTAProviderDelegate.Block_handleApplyUpdateRequestForNodeIDControllerParamsCompletion
static interface	MTROTAProviderDelegate.Block_handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletion
static interface	MTROTAProviderDelegate.Block_handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletionHandler
static interface	MTROTAProviderDelegate.Block_handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletion
static interface	MTROTAProviderDelegate.Block_handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletionHandler
static interface	MTROTAProviderDelegate.Block_handleNotifyUpdateAppliedForNodeIDControllerParamsCompletion
static interface	MTROTAProviderDelegate.Block_handleQueryImageForNodeIDControllerParamsCompletion

Method Summary

Modifier and Type	Method	Description
default void	handleApplyUpdateRequestForNodeIDControllerParamsCompletion(@NotNull NSNumber nodeID, @NotNull MTRDeviceController controller, @NotNull MTROTASoftwareUpdateProviderClusterApplyUpdateRequestParams params, @NotNull MTROTAProviderDelegate.Block_handleApplyUpdateRequestForNodeIDControllerParamsCompletion completion)	Notify the delegate when the apply update request command is received from some node.
default void	handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletion(@NotNull NSNumber nodeID, @NotNull MTRDeviceController controller, @NotNull NSNumber blockSize, @NotNull NSNumber blockIndex, @NotNull NSNumber bytesToSkip, @NotNull MTROTAProviderDelegate.Block_handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletion completion)	Notify the delegate when a BDX Query message has been received for some node.
default void	handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletionHandler(@NotNull NSNumber nodeID, @NotNull MTRDeviceController controller, @NotNull NSNumber blockSize, @NotNull NSNumber blockIndex, @NotNull NSNumber bytesToSkip, @NotNull MTROTAProviderDelegate.Block_handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletionHandler completionHandler)	Deprecated.
default void	handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletion(@NotNull NSNumber nodeID, @NotNull MTRDeviceController controller, @NotNull java.lang.String fileDesignator, @NotNull NSNumber offset, @NotNull MTROTAProviderDelegate.Block_handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletion completion)	Notify the delegate when a BDX Session starts for some node.
default void	handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletionHandler(@NotNull NSNumber nodeID, @NotNull MTRDeviceController controller, @NotNull java.lang.String fileDesignator, @NotNull NSNumber offset, @NotNull MTROTAProviderDelegate.Block_handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletionHandler completionHandler)	Deprecated.
default void	handleBDXTransferSessionEndForNodeIDControllerError(@NotNull NSNumber nodeID, @NotNull MTRDeviceController controller, @Nullable NSError error)	Notify the delegate when a BDX Session ends for some node.
default void	handleNotifyUpdateAppliedForNodeIDControllerParamsCompletion(@NotNull NSNumber nodeID, @NotNull MTRDeviceController controller, @NotNull MTROTASoftwareUpdateProviderClusterNotifyUpdateAppliedParams params, @NotNull MTROTAProviderDelegate.Block_handleNotifyUpdateAppliedForNodeIDControllerParamsCompletion completion)	Notify the delegate when the notify update applied command is received from some node.
default void	handleQueryImageForNodeIDControllerParamsCompletion(@NotNull NSNumber nodeID, @NotNull MTRDeviceController controller, @NotNull MTROTASoftwareUpdateProviderClusterQueryImageParams params, @NotNull MTROTAProviderDelegate.Block_handleQueryImageForNodeIDControllerParamsCompletion completion)	Notify the delegate when the query image command is received from some node.

Method Detail

handleApplyUpdateRequestForNodeIDControllerParamsCompletion

default void handleApplyUpdateRequestForNodeIDControllerParamsCompletion(@NotNull
                                                                         @NotNull NSNumber nodeID,
                                                                         @NotNull
                                                                         @NotNull MTRDeviceController controller,
                                                                         @NotNull
                                                                         @NotNull MTROTASoftwareUpdateProviderClusterApplyUpdateRequestParams params,
                                                                         @NotNull
                                                                         @NotNull MTROTAProviderDelegate.Block_handleApplyUpdateRequestForNodeIDControllerParamsCompletion 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. API-Since: 16.4

handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletion

default void handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletion(@NotNull
                                                                                       @NotNull NSNumber nodeID,
                                                                                       @NotNull
                                                                                       @NotNull MTRDeviceController controller,
                                                                                       @NotNull
                                                                                       @NotNull NSNumber blockSize,
                                                                                       @NotNull
                                                                                       @NotNull NSNumber blockIndex,
                                                                                       @NotNull
                                                                                       @NotNull NSNumber bytesToSkip,
                                                                                       @NotNull
                                                                                       @NotNull MTROTAProviderDelegate.Block_handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletion completion)

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. API-Since: 16.4

handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletionHandler

@Deprecated
default void handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletionHandler(@NotNull
                                                                                              @NotNull NSNumber nodeID,
                                                                                              @NotNull
                                                                                              @NotNull MTRDeviceController controller,
                                                                                              @NotNull
                                                                                              @NotNull NSNumber blockSize,
                                                                                              @NotNull
                                                                                              @NotNull NSNumber blockIndex,
                                                                                              @NotNull
                                                                                              @NotNull NSNumber bytesToSkip,
                                                                                              @NotNull
                                                                                              @NotNull MTROTAProviderDelegate.Block_handleBDXQueryForNodeIDControllerBlockSizeBlockIndexBytesToSkipCompletionHandler completionHandler)

Deprecated.

API-Since: 16.1 Deprecated-Since: 16.4

handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletion

default void handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletion(@NotNull
                                                                                            @NotNull NSNumber nodeID,
                                                                                            @NotNull
                                                                                            @NotNull MTRDeviceController controller,
                                                                                            @NotNull
                                                                                            @NotNull java.lang.String fileDesignator,
                                                                                            @NotNull
                                                                                            @NotNull NSNumber offset,
                                                                                            @NotNull
                                                                                            @NotNull MTROTAProviderDelegate.Block_handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletion 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. API-Since: 16.4

handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletionHandler

@Deprecated
default void handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletionHandler(@NotNull
                                                                                                   @NotNull NSNumber nodeID,
                                                                                                   @NotNull
                                                                                                   @NotNull MTRDeviceController controller,
                                                                                                   @NotNull
                                                                                                   @NotNull java.lang.String fileDesignator,
                                                                                                   @NotNull
                                                                                                   @NotNull NSNumber offset,
                                                                                                   @NotNull
                                                                                                   @NotNull MTROTAProviderDelegate.Block_handleBDXTransferSessionBeginForNodeIDControllerFileDesignatorOffsetCompletionHandler completionHandler)

Deprecated.

API-Since: 16.1 Deprecated-Since: 16.4

handleBDXTransferSessionEndForNodeIDControllerError

default void handleBDXTransferSessionEndForNodeIDControllerError(@NotNull
                                                                 @NotNull NSNumber nodeID,
                                                                 @NotNull
                                                                 @NotNull MTRDeviceController controller,
                                                                 @Nullable
                                                                 @Nullable NSError error)

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.

handleNotifyUpdateAppliedForNodeIDControllerParamsCompletion

default void handleNotifyUpdateAppliedForNodeIDControllerParamsCompletion(@NotNull
                                                                          @NotNull NSNumber nodeID,
                                                                          @NotNull
                                                                          @NotNull MTRDeviceController controller,
                                                                          @NotNull
                                                                          @NotNull MTROTASoftwareUpdateProviderClusterNotifyUpdateAppliedParams params,
                                                                          @NotNull
                                                                          @NotNull MTROTAProviderDelegate.Block_handleNotifyUpdateAppliedForNodeIDControllerParamsCompletion 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. API-Since: 16.4

handleQueryImageForNodeIDControllerParamsCompletion

default void handleQueryImageForNodeIDControllerParamsCompletion(@NotNull
                                                                 @NotNull NSNumber nodeID,
                                                                 @NotNull
                                                                 @NotNull MTRDeviceController controller,
                                                                 @NotNull
                                                                 @NotNull MTROTASoftwareUpdateProviderClusterQueryImageParams params,
                                                                 @NotNull
                                                                 @NotNull MTROTAProviderDelegate.Block_handleQueryImageForNodeIDControllerParamsCompletion completion)

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. 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:. API-Since: 16.4