service.py File Reference

Go to the source code of this file.

Classes
class	homeassistant.helpers.service.ReloadServiceHelper
class	homeassistant.helpers.service.SelectedEntities
class	homeassistant.helpers.service.ServiceParams
class	homeassistant.helpers.service.ServiceTargetSelector

Namespaces
	homeassistant.helpers.service

Functions
None	homeassistant.helpers.service._async_admin_handler (HomeAssistant hass, HassJob[[ServiceCall], Awaitable[None]|None] service_job, ServiceCall call)
dict[str, ModuleType]	homeassistant.helpers.service._base_components ()
def	homeassistant.helpers.service._EntityT
list[Entity]	homeassistant.helpers.service._get_permissible_entity_candidates (ServiceCall call, dict[str, Entity] entities, Callable[[str, str], bool]|None entity_perms, bool target_all_entities, set[str]|None all_referenced)
ServiceResponse	homeassistant.helpers.service._handle_entity_call (HomeAssistant hass, Entity entity, str|HassJob func, dict|ServiceCall data, Context context)
TypeGuard[str|list[str]]	homeassistant.helpers.service._has_match (str|list[str]|None ids)
JSON_TYPE	homeassistant.helpers.service._load_services_file (HomeAssistant hass, Integration integration)
list[JSON_TYPE]	homeassistant.helpers.service._load_services_files (HomeAssistant hass, Iterable[Integration] integrations)
Any	homeassistant.helpers.service._validate_option_or_feature (str option_or_feature, str label)
None	homeassistant.helpers.service.async_call_from_config (HomeAssistant hass, ConfigType config, bool blocking=False, TemplateVarsType variables=None, bool validate_config=True, Context|None context=None)
set[str]	homeassistant.helpers.service.async_extract_config_entry_ids (HomeAssistant hass, ServiceCall service_call, bool expand_group=True)
set[str]	homeassistant.helpers.service.async_extract_entity_ids (HomeAssistant hass, ServiceCall service_call, bool expand_group=True)
SelectedEntities	homeassistant.helpers.service.async_extract_referenced_entity_ids (HomeAssistant hass, ServiceCall service_call, bool expand_group=True)
dict[str, dict[str, Any]]	homeassistant.helpers.service.async_get_all_descriptions (HomeAssistant hass)
dict[str, Any]|None	homeassistant.helpers.service.async_get_cached_service_description (HomeAssistant hass, str domain, str service)
ServiceParams	homeassistant.helpers.service.async_prepare_call_from_config (HomeAssistant hass, ConfigType config, TemplateVarsType variables=None, bool validate_config=False)
None	homeassistant.helpers.service.async_register_admin_service (HomeAssistant hass, str domain, str service, Callable[[ServiceCall], Awaitable[None]|None] service_func, VolSchemaType schema=vol.Schema({}, extra=vol.PREVENT_EXTRA))
None	homeassistant.helpers.service.async_register_entity_service (HomeAssistant hass, str domain, str name, *dict[str, Entity] entities, str|Callable[..., Any] func, HassJobType|None job_type, Iterable[int]|None required_features=None, VolDictType|VolSchemaType|None schema, SupportsResponse supports_response=SupportsResponse.NONE)
None	homeassistant.helpers.service.async_set_service_schema (HomeAssistant hass, str domain, str service, dict[str, Any] schema)
None	homeassistant.helpers.service.call_from_config (HomeAssistant hass, ConfigType config, bool blocking=False, TemplateVarsType variables=None, bool validate_config=True)
EntityServiceResponse|None	homeassistant.helpers.service.entity_service_call (HomeAssistant hass, dict[str, Entity] registered_entities, str|HassJob func, ServiceCall call, Iterable[int]|None required_features=None)
set[str]	homeassistant.helpers.service.extract_entity_ids (HomeAssistant hass, ServiceCall service_call, bool expand_group=True)
dict[Any, Any]	homeassistant.helpers.service.remove_entity_service_fields (ServiceCall call)
str	homeassistant.helpers.service.starts_with_dot (str key)
Any	homeassistant.helpers.service.validate_attribute_option (str attribute_option)
Any	homeassistant.helpers.service.validate_supported_feature (str supported_feature)
Callable[[Callable[[ServiceCall], Any]], Callable[[ServiceCall], Any]]	homeassistant.helpers.service.verify_domain_control (HomeAssistant hass, str domain)

Variables
	homeassistant.helpers.service._FIELD_SCHEMA
	homeassistant.helpers.service._LOGGER = logging.getLogger(__name__)
	homeassistant.helpers.service._SECTION_SCHEMA
	homeassistant.helpers.service._SERVICE_SCHEMA
	homeassistant.helpers.service._SERVICES_SCHEMA
string	homeassistant.helpers.service.CONF_SERVICE_ENTITY_ID = "entity_id"