spotifywebapiPython 1.0.51__py3-none-any.whl → 1.0.53__py3-none-any.whl

spotifywebapipython/zeroconfapi/zeroconfconnect.py

@@ -12,8 +12,11 @@ from .spotifyzeroconfapierror import SpotifyZeroconfApiError
 from .zeroconfresponse import ZeroconfResponse
 from .zeroconfgetinfo import ZeroconfGetInfo
 from ..saappmessages import SAAppMessages
-from ..sautils import export
+from ..sautils import export, validateDelay
 from ..spotifyapierror import SpotifyApiError
+from ..const import (
+    TRACE_MSG_DELAY_DEVICE,
+)
 
 # get smartinspect logger reference; create a new session for this module name.
 from smartinspectpython.siauto import SIAuto, SILevel, SISession, SIMethodParmListContext, SISourceId
@@ -261,10 +264,12 @@ class ZeroconfConnect:
         return responseData
 
 
-    def Connect(self,
-                username:str, 
-                password:str, 
-                ) -> ZeroconfResponse:
+    def Connect(
+            self,
+            username:str, 
+            password:str, 
+            delay:float=0.50
+            ) -> ZeroconfResponse:
         """
         Calls the `addUser` Spotify Zeroconf API endpoint to issue a call to SpConnectionLoginBlob.  If successful,
         the associated device id is added to the Spotify Connect active device list for the specified user account.
@@ -277,6 +282,11 @@ class ZeroconfConnect:
                 on the manufacturer device.               
             password (str):
                 Spotify Connect user password to login with.  
+            delay (float):
+                Time delay (in seconds) to wait AFTER issuing the command to the device.  
+                This delay will give the spotify zeroconf api time to process the change before 
+                another command is issued.  
+                Default is 0.50; value range is 0 - 10.
 
         Returns:
             A `ZeroconfResponse` object that indicates success or failure (see notes below).
@@ -321,6 +331,7 @@ class ZeroconfConnect:
             apiMethodParms.AppendKeyValue("Version", self._Version)
             apiMethodParms.AppendKeyValue("Uri", self._Uri)
             apiMethodParms.AppendKeyValue("username", username)
+            apiMethodParms.AppendKeyValue("delay", delay)
             _logsi.LogMethodParmList(SILevel.Verbose, "Connecting device to Spotify Connect using specified Username and Password", apiMethodParms)
 
             # validations.
@@ -328,6 +339,7 @@ class ZeroconfConnect:
                 raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'username'), logsi=_logsi)
             if (password is None) or (not isinstance(password,str)):
                 raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'password'), logsi=_logsi)
+            delay = validateDelay(delay, 0.50, 10)
 
             # get the current device id from the device via Spotify ZeroConf API `getInfo` endpoint.
             info:ZeroconfGetInfo = self.GetInformation()
@@ -361,6 +373,13 @@ class ZeroconfConnect:
 
             # trace.
             _logsi.LogObject(SILevel.Verbose, '%s result - type="%s"' % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
+            
+            # give spotify zeroconf api time to process the change.
+            if delay > 0:
+                _logsi.LogVerbose(TRACE_MSG_DELAY_DEVICE % delay)
+                time.sleep(delay)
+                        
+            # return result to caller.
             return result
 
         except SpotifyZeroconfApiError: raise  # pass handled exceptions on thru
@@ -380,10 +399,20 @@ class ZeroconfConnect:
             _logsi.LeaveMethod(SILevel.Debug, apiMethodName)
 
 
-    def Disconnect(self) -> ZeroconfResponse:
+    def Disconnect(
+            self,
+            delay:float=0.50
+            ) -> ZeroconfResponse:
         """
         Calls the `resetUsers` Spotify Zeroconf API endpoint to issue a call to SpConnectionLogout.
         
+        Args:
+            delay (float):
+                Time delay (in seconds) to wait AFTER issuing the command to the device.  
+                This delay will give the spotify zeroconf api time to process the change before 
+                another command is issued.  
+                Default is 0.50; value range is 0 - 10.
+                
         Returns:
             A `ZeroconfResponse` object that indicates success or failure (see notes below).
 
@@ -415,8 +444,12 @@ class ZeroconfConnect:
             apiMethodParms.AppendKeyValue("CPath", self._CPath)
             apiMethodParms.AppendKeyValue("Version", self._Version)
             apiMethodParms.AppendKeyValue("Uri", self._Uri)
+            apiMethodParms.AppendKeyValue("delay", delay)
             _logsi.LogMethodParmList(SILevel.Verbose, "Disconnecting device from Spotify Connect", apiMethodParms)
             
+            # validations.
+            delay = validateDelay(delay, 0.50, 10)
+
             # execute spotify zeroconf api request.
             response = requests.post(
                 self._Uri,
@@ -436,12 +469,15 @@ class ZeroconfConnect:
             # process results.
             result = ZeroconfResponse(root=responseData)
 
-            # just in case user tries to issue a connect immediately after this, give the device
-            # a little time to reset the connection so the subsequent connect does not fail.
-            time.sleep(0.5)
-
             # trace.
             _logsi.LogObject(SILevel.Verbose, '%s result - type="%s"' % (apiMethodName, type(result).__name__), result, excludeNonPublic=True)
+
+            # give spotify zeroconf api time to process the change.
+            if delay > 0:
+                _logsi.LogVerbose(TRACE_MSG_DELAY_DEVICE % delay)
+                time.sleep(delay)
+                        
+            # return result to caller.
             return result
 
         except SpotifyZeroconfApiError: raise  # pass handled exceptions on thru

spotifywebapipython/zeroconfapi/zeroconfgetinfo.py

@@ -109,6 +109,14 @@ class ZeroconfGetInfo(ZeroconfResponse):
         This value will be an empty string if there is no user logged into the device.
         """
         return self._ActiveUser
+    
+    @ActiveUser.setter
+    def ActiveUser(self, value:str):
+        """ 
+        Sets the ActiveUser property value.
+        """
+        if isinstance(value, str):
+            self._ActiveUser = value
 
 
     @property
@@ -158,6 +166,14 @@ class ZeroconfGetInfo(ZeroconfResponse):
         Unique device ID used for ZeroConf logins (e.g. "30fbc80e35598f3c242f2120413c943dfd9715fe").
         """
         return self._DeviceId
+    
+    @DeviceId.setter
+    def DeviceId(self, value:str):
+        """ 
+        Sets the DeviceId property value.
+        """
+        if isinstance(value, str):
+            self._DeviceId = value
 
 
     @property
@@ -182,6 +198,14 @@ class ZeroconfGetInfo(ZeroconfResponse):
         - kSpDeviceTypeChromebook	Chromebook.        
         """
         return self._DeviceType
+    
+    @DeviceType.setter
+    def DeviceType(self, value:str):
+        """ 
+        Sets the DeviceType property value.
+        """
+        if isinstance(value, str):
+            self._DeviceType = value
 
 
     @property
@@ -253,6 +277,14 @@ class ZeroconfGetInfo(ZeroconfResponse):
         Please refer to the `Aliases` property for more information.
         """
         return self._RemoteName
+    
+    @RemoteName.setter
+    def RemoteName(self, value:str):
+        """ 
+        Sets the RemoteName property value.
+        """
+        if isinstance(value, str):
+            self._RemoteName = value
 
 
     @property

spotifywebapipython/zeroconfapi/zeroconfresponse.py

@@ -57,6 +57,14 @@ class ZeroconfResponse:
         The last error code returned by a Spotify API call or the SpCallbackError() callback (e.g. 0, -119, etc).
         """
         return self._SpotifyError
+    
+    @SpotifyError.setter
+    def SpotifyError(self, value:int):
+        """ 
+        Sets the SpotifyError property value.
+        """
+        if isinstance(value, int):
+            self._SpotifyError = value
 
 
     @property
@@ -65,6 +73,14 @@ class ZeroconfResponse:
         A code indicating the result of the operation (e.g. 101, 402, etc).
         """
         return self._Status
+    
+    @Status.setter
+    def Status(self, value:int):
+        """ 
+        Sets the Status property value.
+        """
+        if isinstance(value, int):
+            self._Status = value
 
 
     @property
@@ -73,6 +89,14 @@ class ZeroconfResponse:
         The string describing the status code (e.g. "OK", "ERROR-SPOTIFY-ERROR", etc).
         """
         return self._StatusString
+    
+    @StatusString.setter
+    def StatusString(self, value:str):
+        """ 
+        Sets the StatusString property value.
+        """
+        if isinstance(value, str):
+            self._StatusString = value
 
 
     def ToDictionary(self) -> dict: