Added support for service responses when calling or creating services.#495
Merged
craigbarratt merged 1 commit intocustom-components:masterfrom Jul 29, 2023
Conversation
Member
|
Thanks for the PR! I'll make it backward compatible (fix the test failures, then upgrade the tests to 2023.7) and add tests and documentation. |
craigbarratt
added a commit
that referenced
this pull request
Jul 29, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added support for returning service responses for both service execution and service creating.
Calling Services:
The user can now call services and get responses back. This works for both ways of calling services, via service.call() and also when using the service name as a function. Users can now use the argument "return_response = True" when they are interested in getting a response like this:
retval = service.call("mydomain", "myservice", return_response = True, ...)or
retval = mydomain.myservice(return_response = True, ...)When the called service has been created with "SupportsResponse.ONLY", then "return_response = True" is automatically assumed when not explicitly given by the user.
Creating service:
The user can now use the keyword argument "supports_response" to specify whether the service returns a response when creating a service using the @service decorator:
The argument "supports_response" accepts the same values as the underlying home assistant API: "none" when no response is returned, "optional" when optionally a response can be returned or "only" when a response must be returned. Default value of "supports_response" is "none".