Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.syncthing.SyncthingClient Class Reference

Public Member Functions

def __init__ (self, hass, client, server_id)
 
def database (self)
 
def server_id (self)
 
def subscribe (self)
 
def system (self)
 
def unsubscribe (self)
 
def url (self)
 

Private Member Functions

def _listen (self)
 
def _server_available (self)
 

Private Attributes

 _client
 
 _hass
 
 _listen_task
 
 _server_id
 

Detailed Description

A Syncthing client.

Definition at line 80 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.syncthing.SyncthingClient.__init__ (   self,
  hass,
  client,
  server_id 
)
Initialize the client.

Definition at line 83 of file __init__.py.

Member Function Documentation

◆ _listen()

def homeassistant.components.syncthing.SyncthingClient._listen (   self)
private
Listen to Syncthing events.

Definition at line 120 of file __init__.py.

◆ _server_available()

def homeassistant.components.syncthing.SyncthingClient._server_available (   self)
private

Definition at line 171 of file __init__.py.

◆ database()

def homeassistant.components.syncthing.SyncthingClient.database (   self)
Get database namespace client.

Definition at line 101 of file __init__.py.

◆ server_id()

def homeassistant.components.syncthing.SyncthingClient.server_id (   self)
Get server id.

Definition at line 91 of file __init__.py.

◆ subscribe()

def homeassistant.components.syncthing.SyncthingClient.subscribe (   self)
Start event listener coroutine.

Definition at line 110 of file __init__.py.

◆ system()

def homeassistant.components.syncthing.SyncthingClient.system (   self)
Get system namespace client.

Definition at line 106 of file __init__.py.

◆ unsubscribe()

def homeassistant.components.syncthing.SyncthingClient.unsubscribe (   self)
Stop event listener coroutine.

Definition at line 114 of file __init__.py.

◆ url()

def homeassistant.components.syncthing.SyncthingClient.url (   self)
Get server URL.

Definition at line 96 of file __init__.py.

Member Data Documentation

◆ _client

homeassistant.components.syncthing.SyncthingClient._client
private

Definition at line 86 of file __init__.py.

◆ _hass

homeassistant.components.syncthing.SyncthingClient._hass
private

Definition at line 85 of file __init__.py.

◆ _listen_task

homeassistant.components.syncthing.SyncthingClient._listen_task
private

Definition at line 88 of file __init__.py.

◆ _server_id

homeassistant.components.syncthing.SyncthingClient._server_id
private

Definition at line 87 of file __init__.py.


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