Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.foursquare Namespace Reference

Classes

class  FoursquarePushReceiver
 

Functions

bool setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CHECKIN_SERVICE_SCHEMA
 
string CONF_PUSH_SECRET = "push_secret"
 
 CONFIG_SCHEMA
 
string DOMAIN = "foursquare"
 
string EVENT_CHECKIN = "foursquare.checkin"
 
string EVENT_PUSH = "foursquare.push"
 
string SERVICE_CHECKIN = "checkin"
 

Detailed Description

Support for the Foursquare (Swarm) API.

Function Documentation

◆ setup()

bool homeassistant.components.foursquare.setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the Foursquare component.

Definition at line 54 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.foursquare._LOGGER = logging.getLogger(__name__)
private

Definition at line 16 of file __init__.py.

◆ CHECKIN_SERVICE_SCHEMA

homeassistant.components.foursquare.CHECKIN_SERVICE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional("alt"): cv.string,
4  vol.Optional("altAcc"): cv.string,
5  vol.Optional("broadcast"): cv.string,
6  vol.Optional("eventId"): cv.string,
7  vol.Optional("ll"): cv.string,
8  vol.Optional("llAcc"): cv.string,
9  vol.Optional("mentions"): cv.string,
10  vol.Optional("shout"): cv.string,
11  vol.Required("venueId"): cv.string,
12  }
13 )

Definition at line 27 of file __init__.py.

◆ CONF_PUSH_SECRET

string homeassistant.components.foursquare.CONF_PUSH_SECRET = "push_secret"

Definition at line 18 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.foursquare.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Required(CONF_ACCESS_TOKEN): cv.string,
6  vol.Required(CONF_PUSH_SECRET): cv.string,
7  }
8  )
9  },
10  extra=vol.ALLOW_EXTRA,
11 )

Definition at line 41 of file __init__.py.

◆ DOMAIN

string homeassistant.components.foursquare.DOMAIN = "foursquare"

Definition at line 20 of file __init__.py.

◆ EVENT_CHECKIN

string homeassistant.components.foursquare.EVENT_CHECKIN = "foursquare.checkin"

Definition at line 22 of file __init__.py.

◆ EVENT_PUSH

string homeassistant.components.foursquare.EVENT_PUSH = "foursquare.push"

Definition at line 23 of file __init__.py.

◆ SERVICE_CHECKIN

string homeassistant.components.foursquare.SERVICE_CHECKIN = "checkin"

Definition at line 25 of file __init__.py.