spotifywebapiPython 1.0.43__py3-none-any.whl → 1.0.45__py3-none-any.whl

spotifywebapipython/models/zeroconfdiscoveryresult.py

@@ -0,0 +1,451 @@
+# external package imports.
+from zeroconf import ServiceInfo
+
+# our package imports.
+from ..sautils import export
+from .zeroconfproperty import ZeroconfProperty
+
+@export
+class ZeroconfDiscoveryResult:
+    """
+    Zeroconf Discovery Result object.
+    
+    Information about the Zeroconf entry for a SpotifyConnect device as found by Zeroconf (mDNS).
+    """
+
+    def __init__(self) -> None:
+        """
+        Initializes a new instance of the class.
+        
+        Args:
+            root (dict):
+                Spotify Web API JSON response in dictionary format, used to load object
+                attributes; otherwise, None to not load attributes.
+        """
+        self._DeviceName:str = None
+        self._Domain:str = '.'
+        self._HostIpv4Address:str = None
+        self._HostIpPort:int = None
+        self._HostTTL:int = None
+        self._Key:str = None
+        self._Name:str = None
+        self._OtherTTL:int = None
+        self._Priority:int = None
+        self._Properties:list = []
+        self._Server:str = None
+        self._ServerKey:str = None
+        self._ServiceInfo:ServiceInfo = None
+        self._ServiceType:str = None
+        self._Weight:int = None
+
+        # Spotify Connect specific properties:
+        self._SpotifyConnectCPath:str = None
+        self._SpotifyConnectVersion:str = None
+        self._SpotifyConnectIsInDeviceList:bool = False
+
+
+    def __repr__(self) -> str:
+        return self.ToString()
+
+
+    def __str__(self) -> str:
+        return self.ToString()
+
+
+    @property
+    def DeviceName(self) -> str:
+        """ 
+        Device name (e.g. "Bose-ST10-1").
+        """
+        return self._DeviceName
+    
+    @DeviceName.setter
+    def DeviceName(self, value:str):
+        """ 
+        Sets the DeviceName property value.
+        """
+        if isinstance(value, str):
+            self._DeviceName = value
+
+
+    @property
+    def Domain(self) -> str:
+        """ 
+        Domain on which the service is located, which should match the one passed in during the query (e.g. "local.").
+        """
+        return self._Domain
+    
+    @Domain.setter
+    def Domain(self, value:str):
+        """ 
+        Sets the Domain property value.
+        """
+        if isinstance(value, str):
+            self._Domain = value
+
+
+    @property
+    def HostIpv4Address(self) -> str:
+        """ 
+        IPV4 address (as a string) at which the host can be reached (e.g. "192.168.1.81").
+        """
+        return self._HostIpv4Address
+    
+    @HostIpv4Address.setter
+    def HostIpv4Address(self, value:str):
+        """ 
+        Sets the HostIpv4Address property value.
+        """
+        if isinstance(value, str):
+            self._HostIpv4Address = value
+
+
+    @property
+    def HostIpPort(self) -> int:
+        """ 
+        Port number (as an integer) for the service on the host (e.g. 8080).
+        """
+        return self._HostIpPort
+    
+    @HostIpPort.setter
+    def HostIpPort(self, value:int):
+        """ 
+        Sets the HostIpPort property value.
+        """
+        if isinstance(value, int):
+            self._HostIpPort = value
+
+
+    @property
+    def HostTTL(self) -> int:
+        """ 
+        Host Time-To-Live value (as an integer) for the service on the host (e.g. 1200).
+        """
+        return self._HostTTL
+    
+    @HostTTL.setter
+    def HostTTL(self, value:int):
+        """ 
+        Sets the HostTTL property value.
+        """
+        if isinstance(value, int):
+            self._HostTTL = value
+
+
+    @property
+    def Key(self) -> str:
+        """ 
+        Service key (e.g. "bose-st10-2._spotify-connect._tcp.local.").
+        """
+        return self._Key
+    
+    @Key.setter
+    def Key(self, value:str):
+        """ 
+        Sets the Key property value.
+        """
+        if isinstance(value, str):
+            self._Key = value
+
+
+    @property
+    def Name(self) -> str:
+        """ 
+        Service name (e.g. "Bose-ST10-2._spotify-connect._tcp.local.").
+        """
+        return self._Name
+    
+    @Name.setter
+    def Name(self, value:str):
+        """ 
+        Sets the Name property value.
+        """
+        if isinstance(value, str):
+            self._Name = value
+
+
+    @property
+    def Priority(self) -> int:
+        """ 
+        Priority value (as an integer) for the service on the host (e.g. 0).
+        """
+        return self._Priority
+    
+    @Priority.setter
+    def Priority(self, value:int):
+        """ 
+        Sets the Priority property value.
+        """
+        if isinstance(value, int):
+            self._Priority = value
+
+
+    @property
+    def OtherTTL(self) -> int:
+        """ 
+        Other Time-To-Live value (as an integer) for the service on the host (e.g. 5400).
+        """
+        return self._OtherTTL
+    
+    @OtherTTL.setter
+    def OtherTTL(self, value:int):
+        """ 
+        Sets the OtherTTL property value.
+        """
+        if isinstance(value, int):
+            self._OtherTTL = value
+
+
+    @property
+    def Properties(self) -> list[ZeroconfProperty]:
+        """ 
+        Discovered properties.
+        """
+        return self._Properties
+
+    
+    @property
+    def Server(self) -> str:
+        """ 
+        Server name (e.g. "Bose-SM2-341513fbeeae.local.").
+        """
+        return self._Server
+    
+    @Server.setter
+    def Server(self, value:str):
+        """ 
+        Sets the Server property value.
+        """
+        if isinstance(value, str):
+            self._Server = value
+
+
+    @property
+    def ServerKey(self) -> str:
+        """ 
+        Server key (e.g. "bose-sm2-341513fbeeae.local.").
+        """
+        return self._ServerKey
+    
+    @ServerKey.setter
+    def ServerKey(self, value:str):
+        """ 
+        Sets the ServerKey property value.
+        """
+        if isinstance(value, str):
+            self._ServerKey = value
+
+
+    @property
+    def ServiceInfo(self) -> ServiceInfo:
+        """ 
+        Zeroconf Service info object.
+        """
+        return self._ServiceInfo
+    
+    @ServiceInfo.setter
+    def ServiceInfo(self, value:ServiceInfo):
+        """ 
+        Sets the ServiceInfo property value.
+        """
+        if isinstance(value, ServiceInfo):
+            self._ServiceInfo = value
+
+
+    @property
+    def ServiceType(self) -> str:
+        """ 
+        Service type, which should match the one passed in during the query name (e.g. "_spotify-connect._tcp.").
+        """
+        return self._ServiceType
+    
+    @ServiceType.setter
+    def ServiceType(self, value:str):
+        """ 
+        Sets the ServiceType property value.
+        """
+        if isinstance(value, str):
+            self._ServiceType = value
+
+
+    @property
+    def Weight(self) -> int:
+        """ 
+        Weight value (as an integer) for the service on the host (e.g. 0).
+        """
+        return self._Weight
+    
+    @Weight.setter
+    def Weight(self, value:int):
+        """ 
+        Sets the Weight property value.
+        """
+        if isinstance(value, int):
+            self._Weight = value
+
+    # *****************************************************************************
+    # The following are Spotify Connect specific properties.
+    # *****************************************************************************
+
+    @property
+    def SpotifyConnectCPath(self) -> str:
+        """ 
+        Spotify Connect CPath property value (e.g. "/zc").
+        """
+        return self._SpotifyConnectCPath
+    
+    @SpotifyConnectCPath.setter
+    def SpotifyConnectCPath(self, value:str):
+        """ 
+        Sets the SpotifyConnectCPath property value.
+        """
+        if isinstance(value, str):
+            self._SpotifyConnectCPath = value
+
+
+    @property
+    def SpotifyConnectIsInDeviceList(self) -> bool:
+        """ 
+        Spotify Connect SpotifyConnectIsInDeviceList property value (e.g. "/zc").
+        """
+        return self._SpotifyConnectIsInDeviceList
+    
+    @SpotifyConnectIsInDeviceList.setter
+    def SpotifyConnectIsInDeviceList(self, value:bool):
+        """ 
+        Sets the SpotifyConnectIsInDeviceList property value.
+        """
+        if isinstance(value, bool):
+            self._SpotifyConnectIsInDeviceList = value
+
+
+    @property
+    def SpotifyConnectVersion(self) -> str:
+        """ 
+        Spotify Connect Version property value (e.g. "1.0").
+
+        """
+        return self._SpotifyConnectVersion
+    
+    @SpotifyConnectVersion.setter
+    def SpotifyConnectVersion(self, value:str):
+        """ 
+        Sets the SpotifyConnectVersion property value.
+        """
+        if isinstance(value, str):
+            self._SpotifyConnectVersion = value
+
+
+    @property
+    def ZeroconfApiEndpointAddUser(self) -> str:
+        """ 
+        Zeroconf API endpoint to add a user to a Spotify Connect device (e.g. "http://192.168.1.81:8200/zc?action=addUser&version=2.10.0").
+        """
+        return self.GetEndpointUrl('addUser')
+    
+
+    @property
+    def ZeroconfApiEndpointGetInformation(self) -> str:
+        """ 
+        Zeroconf API endpoint to retrieve device information for a Spotify Connect device (e.g. "http://192.168.1.81:8200/zc?action=getInfo&version=2.10.0").
+        """
+        return self.GetEndpointUrl('getInfo')
+    
+
+    @property
+    def ZeroconfApiEndpointResetUsers(self) -> str:
+        """ 
+        Zeroconf API endpoint to reset users (e.g. Logoff) currently active on a Spotify Connect device (e.g. "http://192.168.1.81:8200/zc?action=resetUsers&version=2.10.0").
+        """
+        return self.GetEndpointUrl('resetUsers')
+    
+
+    def GetEndpointUrl(self, action:str) -> str:
+        """
+        Gets a Spotify Zeroconf API endpoint url for the specified action key.
+        
+        Args:
+            action (str):
+                Spotify Zeroconf endpoint action to formulate (e.g. 'getInfo', 'addUser', 'resetUsers', etc).
+
+        Returns:
+            A string containing the endpoint url for the specified action key.
+        """
+        return "http://{ip}:{port}{cpath}?action={action}&version={version}".format(
+            ip=self.HostIpv4Address, 
+            port=self.HostIpPort, 
+            cpath=self.SpotifyConnectCPath, 
+            action=action, 
+            version=self.SpotifyConnectVersion
+            )
+
+
+    def ToDictionary(self) -> dict:
+        """
+        Returns a dictionary representation of the class.
+        """
+        result:dict = \
+        {
+            'DeviceName': self._DeviceName,
+            'Domain': self._Domain,
+            'HostIpv4Address': self._HostIpv4Address,
+            'HostIpPort': self._HostIpPort,
+            'HostTTL': self._HostTTL,
+            'Key': self._Key,
+            'Name': self._Name,
+            'Priority': self._Priority,
+            'OtherTTL': self._OtherTTL,
+            'Server': self._Server,
+            'ServerKey': self._ServerKey,
+            'ServiceType': self._ServiceType,
+            'Weight': self._Weight,
+            'Properties': [ item.ToDictionary() for item in self._Properties ],
+            'SpotifyConnectCPath': self._SpotifyConnectCPath,
+            'SpotifyConnectIsInDeviceList': self._SpotifyConnectIsInDeviceList,
+            'SpotifyConnectVersion': self._SpotifyConnectVersion,
+            'ZeroconfApiEndpointAddUser': self.ZeroconfApiEndpointAddUser,
+            'ZeroconfApiEndpointGetInformation': self.ZeroconfApiEndpointGetInformation,
+            'ZeroconfApiEndpointResetUsers': self.ZeroconfApiEndpointResetUsers,
+        }
+        return result
+        
+
+    def ToString(self, includeTitle:bool=True) -> str:
+        """
+        Returns a displayable string representation of the class.
+        
+        Args:
+            includeTitle (str):
+                True to include the class name title prefix.
+        """
+        msg:str = ''
+        if includeTitle: 
+            msg = 'ZeroconfDiscoveryResult:'
+           
+        # get zeroconf api endpoint properties, as they are dynamically generated.
+        zeroconfApiEndpointAddUser:str = self.ZeroconfApiEndpointAddUser
+        zeroconfApiEndpointGetInformation:str = self.ZeroconfApiEndpointGetInformation
+        zeroconfApiEndpointResetUsers:str = self.ZeroconfApiEndpointResetUsers
+        
+        # build result.
+        if self._DeviceName is not None: msg = '%s\n DeviceName="%s"' % (msg, str(self._DeviceName))
+        if self._Domain is not None: msg = '%s\n Domain="%s"' % (msg, str(self._Domain))
+        if self._HostIpv4Address is not None: msg = '%s\n HostIpv4Address="%s"' % (msg, str(self._HostIpv4Address))
+        if self._HostIpPort is not None: msg = '%s\n HostIpPort="%s"' % (msg, str(self._HostIpPort))
+        if self._HostTTL is not None: msg = '%s\n HostTTL="%s"' % (msg, str(self._HostTTL))
+        if self._Key is not None: msg = '%s\n Key="%s"' % (msg, str(self._Key))
+        if self._Name is not None: msg = '%s\n Name="%s"' % (msg, str(self._Name))
+        if self._Priority is not None: msg = '%s\n Priority="%s"' % (msg, str(self._Priority))
+        if self._OtherTTL is not None: msg = '%s\n OtherTTL="%s"' % (msg, str(self._OtherTTL))
+        if self._Server is not None: msg = '%s\n Server="%s"' % (msg, str(self._Server))
+        if self._ServerKey is not None: msg = '%s\n ServerKey="%s"' % (msg, str(self._ServerKey))
+        if self._ServiceType is not None: msg = '%s\n ServiceType="%s"' % (msg, str(self._ServiceType))
+        if self._Weight is not None: msg = '%s\n Weight="%s"' % (msg, str(self._Weight))
+        if self._Properties is not None: msg = '%s\n Properties Count=%s' % (msg, str(len(self._Properties)))
+        if self._SpotifyConnectCPath is not None: msg = '%s\n SpotifyConnectCPath="%s"' % (msg, str(self._SpotifyConnectCPath))
+        if self._SpotifyConnectIsInDeviceList is not None: msg = '%s\n SpotifyConnectIsInDeviceList="%s"' % (msg, str(self._SpotifyConnectIsInDeviceList))
+        if self._SpotifyConnectVersion is not None: msg = '%s\n SpotifyConnectVersion="%s"' % (msg, str(self._SpotifyConnectVersion))
+        if zeroconfApiEndpointAddUser is not None: msg = '%s\n ZeroconfApiEndpointAddUser="%s"' % (msg, zeroconfApiEndpointAddUser)
+        if zeroconfApiEndpointGetInformation is not None: msg = '%s\n ZeroconfApiEndpointGetInformation="%s"' % (msg, zeroconfApiEndpointGetInformation)
+        if zeroconfApiEndpointResetUsers is not None: msg = '%s\n ZeroconfApiEndpointResetUsers="%s"' % (msg, zeroconfApiEndpointResetUsers)
+        return msg