protocol InteractionProxy : SendableAbstraction for the Interaction Client.
-
Whether to use strict validation when sending commands or writing attributes.
Declaration
Swift
var strictOperationValidation: Bool { get } -
Executes a command, not expecting a result.
Declaration
Swift
func sendCommand(commandID: ScopedCommandID, request: (any CommandRequest)?, useTimedInteraction: Bool, clientRequestID: String?) async throwsParameters
commandIDThe GHP-specific command id within the cluster.
requestThe parameters of the command.
useTimedInteractionWhether the command should be invoked using a timed interaction.
clientRequestIDAn optional ID provided by the client to track the command.
-
Executes a command, expecting an result.
Declaration
Swift
func sendCommand<Response>(commandID: ScopedCommandID, request: (any CommandRequest)?, useTimedInteraction: Bool, clientRequestID: String?) async throws -> Response where Response : CommandResponseParameters
commandIDThe GHP-specific command id within the cluster.
requestThe parameters of the command.
useTimedInteractionWhether the command should be invoked using a timed interaction.
clientRequestIDAn optional ID provided by the client to track the command.
-
Updates a trait’s mutable attributes.
Declaration
Swift
func update(trait: any TraitEncodable, useTimedInteraction: Bool) async throwsParameters
traitThe trait to update.
useTimedInteractionWhether the update should use a timed interaction.
-
Forces the given trait to be updated.
See also
ForceReadableTrait.forceReadDeclaration
Swift
func forceRead(traitID: ClusterID) async throws -
Builds a command that can be passed to a
CommandBatcher.Declaration
Swift
func buildBatchableCommand<Response>(commandID: ScopedCommandID, request: (any CommandRequest)?, useTimedInteraction: Bool) -> BatchableCommand<Response>Parameters
commandIDThe GHP-specific command id within the cluster.
requestThe parameters of the command.
useTimedInteractionWhether the command should be invoked using a timed interaction.
-
sendCommand(commandID:request:useTimedInteraction:)
Undocumented
Declaration
Swift
func sendCommand(commandID: ScopedCommandID, request: (any CommandRequest)?, useTimedInteraction: Bool) async throws -
sendCommand(commandID:request:useTimedInteraction:)
Undocumented
Declaration
Swift
func sendCommand<Response>(commandID: ScopedCommandID, request: (any CommandRequest)?, useTimedInteraction: Bool) async throws -> Response where Response : CommandResponse