homeassistant.components.application_credentials.ApplicationCredentialsProtocol Class Reference

Inheritance diagram for homeassistant.components.application_credentials.ApplicationCredentialsProtocol:

Collaboration diagram for homeassistant.components.application_credentials.ApplicationCredentialsProtocol:

Public Member Functions
config_entry_oauth2_flow.AbstractOAuth2Implementation	async_get_auth_implementation (self, HomeAssistant hass, str auth_domain, ClientCredential credential)
AuthorizationServer	async_get_authorization_server (self, HomeAssistant hass)
dict[str, str]	async_get_description_placeholders (self, HomeAssistant hass)

Detailed Description

Define the format that application_credentials platforms may have.

Most platforms typically just implement async_get_authorization_server, and
the default oauth implementation will be used. Otherwise a platform may
implement async_get_auth_implementation to give their use a custom
AbstractOAuth2Implementation.

Definition at line 258 of file __init__.py.

Member Function Documentation

async_get_auth_implementation()

config_entry_oauth2_flow.AbstractOAuth2Implementation homeassistant.components.application_credentials.ApplicationCredentialsProtocol.async_get_auth_implementation	(		self,
		HomeAssistant	hass,
		str	auth_domain,
		ClientCredential	credential
	)

Return a custom auth implementation.

Definition at line 272 of file __init__.py.

async_get_authorization_server()

AuthorizationServer homeassistant.components.application_credentials.ApplicationCredentialsProtocol.async_get_authorization_server	(		self,
		HomeAssistant	hass
	)

Return authorization server, for the default auth implementation.

Definition at line 267 of file __init__.py.

async_get_description_placeholders()

dict[str, str] homeassistant.components.application_credentials.ApplicationCredentialsProtocol.async_get_description_placeholders	(		self,
		HomeAssistant	hass
	)

Return description placeholders for the credentials dialog.

Definition at line 277 of file __init__.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/application_credentials/__init__.py