homeassistant.components.clicksend.notify Namespace Reference

Classes
class	ClicksendNotificationService

Functions
bool	_authenticate (ConfigType config)
ClicksendNotificationService|None	get_service (HomeAssistant hass, ConfigType config, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	BASE_API_URL = "https://rest.clicksend.com/v3"
string	DEFAULT_SENDER = "hass"
dictionary	HEADERS = {"Content-Type": CONTENT_TYPE_JSON}
	PLATFORM_SCHEMA
int	TIMEOUT = 5

Detailed Description

Clicksend platform for notify component.

Function Documentation

_authenticate()

bool homeassistant.components.clicksend.notify._authenticate ( ConfigType  config )

private

Authenticate with ClickSend.

Definition at line 101 of file notify.py.

get_service()

ClicksendNotificationService | None homeassistant.components.clicksend.notify.get_service	(	HomeAssistant	hass,
		ConfigType	config,
		DiscoveryInfoType | None	discovery_info = None
	)

Get the ClickSend notification service.

Definition at line 47 of file notify.py.

Variable Documentation

_LOGGER

homeassistant.components.clicksend.notify._LOGGER = logging.getLogger(__name__)

private

Definition at line 28 of file notify.py.

BASE_API_URL

string homeassistant.components.clicksend.notify.BASE_API_URL = "https://rest.clicksend.com/v3"

Definition at line 30 of file notify.py.

DEFAULT_SENDER

string homeassistant.components.clicksend.notify.DEFAULT_SENDER = "hass"

Definition at line 31 of file notify.py.

HEADERS

dictionary homeassistant.components.clicksend.notify.HEADERS = {"Content-Type": CONTENT_TYPE_JSON}

Definition at line 34 of file notify.py.

PLATFORM_SCHEMA

homeassistant.components.clicksend.notify.PLATFORM_SCHEMA

Initial value:

=  NOTIFY_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_USERNAME): cv.string,
        vol.Required(CONF_API_KEY): cv.string,
        vol.Required(CONF_RECIPIENT, default=[]): vol.All(cv.ensure_list, [cv.string]),
        vol.Optional(CONF_SENDER, default=DEFAULT_SENDER): cv.string,
    }
)

Definition at line 37 of file notify.py.

TIMEOUT

int homeassistant.components.clicksend.notify.TIMEOUT = 5

Definition at line 32 of file notify.py.