Package apple.matter.protocol

Interface MTRDeviceControllerServerProtocol

public interface MTRDeviceControllerServerProtocol

Protocol that remote object must support over XPC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MTRDeviceControllerServerProtocol.Block_getAnyDeviceControllerWithCompletion
static interface	MTRDeviceControllerServerProtocol.Block_getDeviceControllerWithFabricIdCompletion
static interface	MTRDeviceControllerServerProtocol.Block_invokeCommandWithControllerNodeIdEndpointIdClusterIdCommandIdFieldsTimedInvokeTimeoutCompletion
static interface	MTRDeviceControllerServerProtocol.Block_readAttributeCacheWithControllerNodeIdEndpointIdClusterIdAttributeIdCompletion
static interface	MTRDeviceControllerServerProtocol.Block_readAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdParamsCompletion
static interface	MTRDeviceControllerServerProtocol.Block_stopReportsWithControllerNodeIdCompletion
static interface	MTRDeviceControllerServerProtocol.Block_subscribeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdMinIntervalMaxIntervalParamsEstablishedHandler
static interface	MTRDeviceControllerServerProtocol.Block_subscribeWithControllerNodeIdMinIntervalMaxIntervalParamsShouldCacheCompletion
static interface	MTRDeviceControllerServerProtocol.Block_writeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdValueTimedWriteTimeoutCompletion

Method Summary

Modifier and Type	Method	Description
void	getAnyDeviceControllerWithCompletion(@NotNull MTRDeviceControllerServerProtocol.Block_getAnyDeviceControllerWithCompletion completion)	Gets any available device controller ID
default void	getDeviceControllerWithFabricIdCompletion(long fabricId, @NotNull MTRDeviceControllerServerProtocol.Block_getDeviceControllerWithFabricIdCompletion completion)	Deprecated.
void	invokeCommandWithControllerNodeIdEndpointIdClusterIdCommandIdFieldsTimedInvokeTimeoutCompletion(@Nullable java.lang.Object controller, long nodeId, @NotNull NSNumber endpointId, @NotNull NSNumber clusterId, @NotNull NSNumber commandId, @NotNull java.lang.Object fields, @Nullable NSNumber timeoutMs, @NotNull MTRDeviceControllerServerProtocol.Block_invokeCommandWithControllerNodeIdEndpointIdClusterIdCommandIdFieldsTimedInvokeTimeoutCompletion completion)	Requests invoking command
void	readAttributeCacheWithControllerNodeIdEndpointIdClusterIdAttributeIdCompletion(@Nullable java.lang.Object controller, long nodeId, @Nullable NSNumber endpointId, @Nullable NSNumber clusterId, @Nullable NSNumber attributeId, @NotNull MTRDeviceControllerServerProtocol.Block_readAttributeCacheWithControllerNodeIdEndpointIdClusterIdAttributeIdCompletion completion)	Requests reading attribute cache
void	readAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdParamsCompletion(@Nullable java.lang.Object controller, long nodeId, @Nullable NSNumber endpointId, @Nullable NSNumber clusterId, @Nullable NSNumber attributeId, @Nullable NSDictionary<java.lang.String,?> params, @NotNull MTRDeviceControllerServerProtocol.Block_readAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdParamsCompletion completion)	Requests reading attribute
void	stopReportsWithControllerNodeIdCompletion(@Nullable java.lang.Object controller, long nodeId, @NotNull MTRDeviceControllerServerProtocol.Block_stopReportsWithControllerNodeIdCompletion completion)	Requests to stop reporting
void	subscribeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdMinIntervalMaxIntervalParamsEstablishedHandler(@Nullable java.lang.Object controller, long nodeId, @Nullable NSNumber endpointId, @Nullable NSNumber clusterId, @Nullable NSNumber attributeId, @NotNull NSNumber minInterval, @NotNull NSNumber maxInterval, @Nullable NSDictionary<java.lang.String,?> params, @NotNull MTRDeviceControllerServerProtocol.Block_subscribeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdMinIntervalMaxIntervalParamsEstablishedHandler establishedHandler)	Requests subscribing attribute.
void	subscribeWithControllerNodeIdMinIntervalMaxIntervalParamsShouldCacheCompletion(@Nullable java.lang.Object controller, long nodeId, @NotNull NSNumber minInterval, @NotNull NSNumber maxInterval, @Nullable NSDictionary<java.lang.String,?> params, boolean shouldCache, @NotNull MTRDeviceControllerServerProtocol.Block_subscribeWithControllerNodeIdMinIntervalMaxIntervalParamsShouldCacheCompletion completion)	Requests subscription of all attributes.
void	writeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdValueTimedWriteTimeoutCompletion(@Nullable java.lang.Object controller, long nodeId, @NotNull NSNumber endpointId, @NotNull NSNumber clusterId, @NotNull NSNumber attributeId, @NotNull java.lang.Object value, @Nullable NSNumber timeoutMs, @NotNull MTRDeviceControllerServerProtocol.Block_writeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdValueTimedWriteTimeoutCompletion completion)	Requests writing attribute

Method Detail

getAnyDeviceControllerWithCompletion

void getAnyDeviceControllerWithCompletion(@NotNull
                                          @NotNull MTRDeviceControllerServerProtocol.Block_getAnyDeviceControllerWithCompletion completion)

Gets any available device controller ID

getDeviceControllerWithFabricIdCompletion

@Deprecated
default void getDeviceControllerWithFabricIdCompletion(long fabricId,
                                                       @NotNull
                                                       @NotNull MTRDeviceControllerServerProtocol.Block_getDeviceControllerWithFabricIdCompletion completion)

Deprecated.

Gets device controller ID corresponding to a specific fabric ID API-Since: 16.1 Deprecated-Since: 16.4 Deprecated-Message: This never called.

invokeCommandWithControllerNodeIdEndpointIdClusterIdCommandIdFieldsTimedInvokeTimeoutCompletion

void invokeCommandWithControllerNodeIdEndpointIdClusterIdCommandIdFieldsTimedInvokeTimeoutCompletion(@Nullable
                                                                                                     @Nullable java.lang.Object controller,
                                                                                                     long nodeId,
                                                                                                     @NotNull
                                                                                                     @NotNull NSNumber endpointId,
                                                                                                     @NotNull
                                                                                                     @NotNull NSNumber clusterId,
                                                                                                     @NotNull
                                                                                                     @NotNull NSNumber commandId,
                                                                                                     @NotNull
                                                                                                     @NotNull java.lang.Object fields,
                                                                                                     @Nullable
                                                                                                     @Nullable NSNumber timeoutMs,
                                                                                                     @NotNull
                                                                                                     @NotNull MTRDeviceControllerServerProtocol.Block_invokeCommandWithControllerNodeIdEndpointIdClusterIdCommandIdFieldsTimedInvokeTimeoutCompletion completion)

Requests invoking command

readAttributeCacheWithControllerNodeIdEndpointIdClusterIdAttributeIdCompletion

void readAttributeCacheWithControllerNodeIdEndpointIdClusterIdAttributeIdCompletion(@Nullable
                                                                                    @Nullable java.lang.Object controller,
                                                                                    long nodeId,
                                                                                    @Nullable
                                                                                    @Nullable NSNumber endpointId,
                                                                                    @Nullable
                                                                                    @Nullable NSNumber clusterId,
                                                                                    @Nullable
                                                                                    @Nullable NSNumber attributeId,
                                                                                    @NotNull
                                                                                    @NotNull MTRDeviceControllerServerProtocol.Block_readAttributeCacheWithControllerNodeIdEndpointIdClusterIdAttributeIdCompletion completion)

Requests reading attribute cache

readAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdParamsCompletion

void readAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdParamsCompletion(@Nullable
                                                                                     @Nullable java.lang.Object controller,
                                                                                     long nodeId,
                                                                                     @Nullable
                                                                                     @Nullable NSNumber endpointId,
                                                                                     @Nullable
                                                                                     @Nullable NSNumber clusterId,
                                                                                     @Nullable
                                                                                     @Nullable NSNumber attributeId,
                                                                                     @Nullable
                                                                                     @Nullable NSDictionary<java.lang.String,?> params,
                                                                                     @NotNull
                                                                                     @NotNull MTRDeviceControllerServerProtocol.Block_readAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdParamsCompletion completion)

Requests reading attribute

stopReportsWithControllerNodeIdCompletion

void stopReportsWithControllerNodeIdCompletion(@Nullable
                                               @Nullable java.lang.Object controller,
                                               long nodeId,
                                               @NotNull
                                               @NotNull MTRDeviceControllerServerProtocol.Block_stopReportsWithControllerNodeIdCompletion completion)

Requests to stop reporting

subscribeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdMinIntervalMaxIntervalParamsEstablishedHandler

void subscribeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdMinIntervalMaxIntervalParamsEstablishedHandler(@Nullable
                                                                                                                        @Nullable java.lang.Object controller,
                                                                                                                        long nodeId,
                                                                                                                        @Nullable
                                                                                                                        @Nullable NSNumber endpointId,
                                                                                                                        @Nullable
                                                                                                                        @Nullable NSNumber clusterId,
                                                                                                                        @Nullable
                                                                                                                        @Nullable NSNumber attributeId,
                                                                                                                        @NotNull
                                                                                                                        @NotNull NSNumber minInterval,
                                                                                                                        @NotNull
                                                                                                                        @NotNull NSNumber maxInterval,
                                                                                                                        @Nullable
                                                                                                                        @Nullable NSDictionary<java.lang.String,?> params,
                                                                                                                        @NotNull
                                                                                                                        @NotNull MTRDeviceControllerServerProtocol.Block_subscribeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdMinIntervalMaxIntervalParamsEstablishedHandler establishedHandler)

Requests subscribing attribute. The minInterval/maxInterval arguments override whatever intervals might be present in params.

subscribeWithControllerNodeIdMinIntervalMaxIntervalParamsShouldCacheCompletion

void subscribeWithControllerNodeIdMinIntervalMaxIntervalParamsShouldCacheCompletion(@Nullable
                                                                                    @Nullable java.lang.Object controller,
                                                                                    long nodeId,
                                                                                    @NotNull
                                                                                    @NotNull NSNumber minInterval,
                                                                                    @NotNull
                                                                                    @NotNull NSNumber maxInterval,
                                                                                    @Nullable
                                                                                    @Nullable NSDictionary<java.lang.String,?> params,
                                                                                    boolean shouldCache,
                                                                                    @NotNull
                                                                                    @NotNull MTRDeviceControllerServerProtocol.Block_subscribeWithControllerNodeIdMinIntervalMaxIntervalParamsShouldCacheCompletion completion)

Requests subscription of all attributes. The minInterval/maxInterval arguments override whatever intervals might be present in params.

writeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdValueTimedWriteTimeoutCompletion

void writeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdValueTimedWriteTimeoutCompletion(@Nullable
                                                                                                      @Nullable java.lang.Object controller,
                                                                                                      long nodeId,
                                                                                                      @NotNull
                                                                                                      @NotNull NSNumber endpointId,
                                                                                                      @NotNull
                                                                                                      @NotNull NSNumber clusterId,
                                                                                                      @NotNull
                                                                                                      @NotNull NSNumber attributeId,
                                                                                                      @NotNull
                                                                                                      @NotNull java.lang.Object value,
                                                                                                      @Nullable
                                                                                                      @Nullable NSNumber timeoutMs,
                                                                                                      @NotNull
                                                                                                      @NotNull MTRDeviceControllerServerProtocol.Block_writeAttributeWithControllerNodeIdEndpointIdClusterIdAttributeIdValueTimedWriteTimeoutCompletion completion)

Requests writing attribute