Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.signal_messenger.notify Namespace Reference

Classes

class  SignalNotificationService
 

Functions

SignalNotificationService get_service (HomeAssistant hass, ConfigType config, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_FILENAMES = "attachments"
 
string ATTR_TEXTMODE = "text_mode"
 
string ATTR_URLS = "urls"
 
string ATTR_VERIFY_SSL = "verify_ssl"
 
int CONF_MAX_ALLOWED_DOWNLOAD_SIZE_BYTES = 52428800
 
string CONF_RECP_NR = "recipients"
 
string CONF_SENDER_NR = "number"
 
string CONF_SIGNAL_CLI_REST_API = "url"
 
 DATA_FILENAMES_SCHEMA
 
 DATA_SCHEMA
 
 DATA_URLS_SCHEMA
 
 PLATFORM_SCHEMA
 
list TEXTMODE_OPTIONS = ["normal", "styled"]
 

Detailed Description

Signal Messenger for notify component.

Function Documentation

◆ get_service()

SignalNotificationService homeassistant.components.signal_messenger.notify.get_service ( HomeAssistant  hass,
ConfigType  config,
DiscoveryInfoType | None   discovery_info = None 
)
Get the SignalMessenger notification service.

Definition at line 69 of file notify.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.signal_messenger.notify._LOGGER = logging.getLogger(__name__)
private

Definition at line 21 of file notify.py.

◆ ATTR_FILENAMES

string homeassistant.components.signal_messenger.notify.ATTR_FILENAMES = "attachments"

Definition at line 27 of file notify.py.

◆ ATTR_TEXTMODE

string homeassistant.components.signal_messenger.notify.ATTR_TEXTMODE = "text_mode"

Definition at line 30 of file notify.py.

◆ ATTR_URLS

string homeassistant.components.signal_messenger.notify.ATTR_URLS = "urls"

Definition at line 28 of file notify.py.

◆ ATTR_VERIFY_SSL

string homeassistant.components.signal_messenger.notify.ATTR_VERIFY_SSL = "verify_ssl"

Definition at line 29 of file notify.py.

◆ CONF_MAX_ALLOWED_DOWNLOAD_SIZE_BYTES

int homeassistant.components.signal_messenger.notify.CONF_MAX_ALLOWED_DOWNLOAD_SIZE_BYTES = 52428800

Definition at line 26 of file notify.py.

◆ CONF_RECP_NR

string homeassistant.components.signal_messenger.notify.CONF_RECP_NR = "recipients"

Definition at line 24 of file notify.py.

◆ CONF_SENDER_NR

string homeassistant.components.signal_messenger.notify.CONF_SENDER_NR = "number"

Definition at line 23 of file notify.py.

◆ CONF_SIGNAL_CLI_REST_API

string homeassistant.components.signal_messenger.notify.CONF_SIGNAL_CLI_REST_API = "url"

Definition at line 25 of file notify.py.

◆ DATA_FILENAMES_SCHEMA

homeassistant.components.signal_messenger.notify.DATA_FILENAMES_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_FILENAMES): [cv.string],
4  vol.Optional(ATTR_TEXTMODE, default="normal"): vol.In(TEXTMODE_OPTIONS),
5  }
6 )

Definition at line 34 of file notify.py.

◆ DATA_SCHEMA

homeassistant.components.signal_messenger.notify.DATA_SCHEMA
Initial value:
1 = vol.Any(
2  None,
3  vol.Schema(
4  {
5  vol.Optional(ATTR_TEXTMODE, default="normal"): vol.In(TEXTMODE_OPTIONS),
6  }
7  ),
8  DATA_FILENAMES_SCHEMA,
9  DATA_URLS_SCHEMA,
10 )

Definition at line 49 of file notify.py.

◆ DATA_URLS_SCHEMA

homeassistant.components.signal_messenger.notify.DATA_URLS_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_URLS): [cv.url],
4  vol.Optional(ATTR_VERIFY_SSL, default=True): cv.boolean,
5  vol.Optional(ATTR_TEXTMODE, default="normal"): vol.In(TEXTMODE_OPTIONS),
6  }
7 )

Definition at line 41 of file notify.py.

◆ PLATFORM_SCHEMA

homeassistant.components.signal_messenger.notify.PLATFORM_SCHEMA
Initial value:
1 = NOTIFY_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_SENDER_NR): cv.string,
4  vol.Required(CONF_SIGNAL_CLI_REST_API): cv.string,
5  vol.Required(CONF_RECP_NR): vol.All(cv.ensure_list, [cv.string]),
6  }
7 )

Definition at line 60 of file notify.py.

◆ TEXTMODE_OPTIONS

list homeassistant.components.signal_messenger.notify.TEXTMODE_OPTIONS = ["normal", "styled"]

Definition at line 32 of file notify.py.