spotifywebapiPython 1.0.84__py3-none-any.whl → 1.0.86__py3-none-any.whl

spotifywebapipython/spotifyclient.py

@@ -32,6 +32,7 @@ from .const import (
     SPOTIFY_DESKTOP_APP_CLIENT_ID,
     SPOTIFY_DEFAULT_MARKET,
     SPOTIFY_WEBAPI_URL_BASE,
+    SPOTIFYWEBAPIPYTHON_TOKEN_CACHE_FILE,
     TRACE_METHOD_RESULT,
     TRACE_METHOD_RESULT_TYPE,
     TRACE_METHOD_RESULT_TYPE_CACHED,
@@ -77,6 +78,7 @@ class SpotifyClient:
     def __init__(self, 
                  manager:PoolManager=None,
                  tokenStorageDir:str=None,
+                 tokenStorageFile:str=None,
                  tokenUpdater:Callable=None,
                  zeroconfClient:Zeroconf=None,
                  spotifyConnectUsername:str=None,
@@ -91,9 +93,12 @@ class SpotifyClient:
             manager (urllib3.PoolManager):
                 The manager for HTTP requests to the device.
             tokenStorageDir (str):
-                The directory path that will contain the `tokens.json` file.  
+                The directory path that will contain the authorization Token Cache file.  
                 A null value will default to the platform specific storage location:  
                 Example for Windows OS = `C:\ProgramData\SpotifyWebApiPython`
+            tokenStorageFile (str):
+                The filename and extension of the authorization Token Cache file.  
+                Default is `SpotifyWebApiPython_tokens.json`.
             tokenUpdater (Callable):
                 A method to call when a token needs to be refreshed by an external provider.  
                 The defined method is called with no parameters, and should return a token dictionary.  
@@ -143,6 +148,11 @@ class SpotifyClient:
             if (spotifyConnectPassword is None) or (not isinstance(spotifyConnectPassword,str)):
                 raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % ("__init__", 'spotifyConnectPassword'), logsi=_logsi)
 
+        # verify token storage filename was specified.
+        if tokenStorageFile is None:
+            tokenStorageFile = SPOTIFYWEBAPIPYTHON_TOKEN_CACHE_FILE
+
+        # initialize storage.
         self._AuthToken:SpotifyAuthToken = None
         self._AuthClient:AuthClient = None
         self._ConfigurationCache:dict = {}
@@ -152,6 +162,7 @@ class SpotifyClient:
         self._SpotifyConnectLoginId:str = spotifyConnectLoginId
         self._SpotifyConnectDiscoveryTimeout:float = float(spotifyConnectDiscoveryTimeout)
         self._TokenStorageDir:str = tokenStorageDir
+        self._TokenStorageFile:str = tokenStorageFile
         self._TokenUpdater:Callable = tokenUpdater
         self._UserProfile:UserProfile = None
         self._ZeroconfClient = zeroconfClient
@@ -294,6 +305,14 @@ class SpotifyClient:
         return self._TokenStorageDir
     
 
+    @property
+    def TokenStorageFile(self) -> str:
+        """ 
+        The filename and extension of the authorization token cache file.  
+        """
+        return self._TokenStorageFile
+    
+
     @property
     def UserProfile(self) -> UserProfile:
         """ 
@@ -619,16 +638,69 @@ class SpotifyClient:
         return result
     
 
-    def _GetPlayerNowPlayingUri(self) -> str:
+    def _GetPlayerNowPlayingAudiobookUri(self) -> str:
         """
-        Returns the uri value of the currently playing media if something is
+        Returns the audiobook uri value of the currently playing media if something is
         playing; otherwise, null is returned.
         """
         result:str = None
         
         # get nowplaying status.
         _logsi.LogVerbose("Querying NowPlaying status of Spotify player")
-        nowPlaying:PlayerPlayState = self.GetPlayerNowPlaying()
+        nowPlaying:PlayerPlayState = self.GetPlayerNowPlaying(additionalTypes='episode')
+        
+        # is an chapter playing?  if so, return the parent show uri value.
+        if nowPlaying is not None:
+            _logsi.LogVerbose("NowPlaying data: %s" % str(nowPlaying))
+            if nowPlaying.CurrentlyPlayingType in ['episode']:
+                playingItem:Chapter = nowPlaying.Item
+                if (playingItem is not None):
+                    chapter:Chapter = self.GetChapter(playingItem.Id)
+                    result = chapter.Audiobook.Uri
+            else:
+                raise SpotifyApiError("Currently playing item is not a Audiobook Chapter", logsi=_logsi)
+                
+        return result
+    
+
+    def _GetPlayerNowPlayingShowUri(self) -> str:
+        """
+        Returns the show uri value of the currently playing media if something is
+        playing; otherwise, null is returned.
+        """
+        result:str = None
+        
+        # get nowplaying status.
+        _logsi.LogVerbose("Querying NowPlaying status of Spotify player")
+        nowPlaying:PlayerPlayState = self.GetPlayerNowPlaying(additionalTypes='episode')
+        
+        # is an episode playing?  if so, return the parent show uri value.
+        if nowPlaying is not None:
+            _logsi.LogVerbose("NowPlaying data: %s" % str(nowPlaying))
+            if nowPlaying.CurrentlyPlayingType in ['episode']:
+                playingItem:Episode = nowPlaying.Item
+                if (playingItem is not None):
+                    episode:Episode = self.GetEpisode(playingItem.Id)
+                    result = episode.Show.Uri
+            else:
+                raise SpotifyApiError("Currently playing item is not a Show Episode", logsi=_logsi)
+                
+        return result
+    
+
+    def _GetPlayerNowPlayingUri(
+            self,
+            additionalTypes:str=None,
+            ) -> str:
+        """
+        Returns the uri value of the currently playing media type if something is
+        playing; otherwise, null is returned.
+        """
+        result:str = None
+        
+        # get nowplaying status.
+        _logsi.LogVerbose("Querying NowPlaying status of Spotify player")
+        nowPlaying:PlayerPlayState = self.GetPlayerNowPlaying(additionalTypes=additionalTypes)
         
         # is anything playing?  if so, return the uri value.
         if nowPlaying is not None:
@@ -2496,6 +2568,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -2660,6 +2733,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -2913,6 +2987,7 @@ class SpotifyClient:
             limit (int):  
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):  
                 The index of the first item to return; use with limit to get the next set of items.  
                 Default: 0 (the first item).  
@@ -3143,6 +3218,7 @@ class SpotifyClient:
             limit (int):  
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):  
                 The index of the first item to return; use with limit to get the next set of items.  
                 Default: 0 (the first item).  
@@ -3702,6 +3778,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             limitTotal (int):
                 The maximum number of items to return for the request.  
                 If specified, this argument overrides the limit and offset argument values
@@ -4036,6 +4113,7 @@ class SpotifyClient:
             limit (int):  
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):  
                 The index of the first item to return; use with limit to get the next set of items.  
                 Default: 0 (the first item).  
@@ -4193,6 +4271,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -4556,6 +4635,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -4831,6 +4911,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -5283,6 +5364,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -5529,6 +5611,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -6128,7 +6211,8 @@ class SpotifyClient:
                                                                 discoverResult.HostIpPort, 
                                                                 discoverResult.SpotifyConnectCPath,
                                                                 useSSL=False,
-                                                                tokenStorageDir=self.TokenStorageDir)
+                                                                tokenStorageDir=self.TokenStorageDir,
+                                                                tokenStorageFile=self.TokenStorageFile)
                     
                         # if a different user context has control of the device then we need to disconnect 
                         # the current user context before connecting a different user.
@@ -6649,6 +6733,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             after (int):
                 Returns all items after (but not including) this cursor position, which is 
                 a Unix timestamp in milliseconds.  
@@ -7037,6 +7122,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 50, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -7221,6 +7307,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -7375,6 +7462,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -7618,6 +7706,7 @@ class SpotifyClient:
             limit (int):  
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):  
                 The index of the first item to return; use with limit to get the next set of items.  
                 Default: 0 (the first item).  
@@ -7775,6 +7864,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -8182,7 +8272,8 @@ class SpotifyClient:
                                                             discoverResult.HostIpPort, 
                                                             discoverResult.SpotifyConnectCPath,
                                                             useSSL=False,
-                                                            tokenStorageDir=self.TokenStorageDir)
+                                                            tokenStorageDir=self.TokenStorageDir,
+                                                            tokenStorageFile=self.TokenStorageFile)
 
                     # if we did not refresh the device list, then query the device for real-time status; just in
                     # case the device was disconnected after the last cache refresh.  note that we only do this
@@ -8200,9 +8291,10 @@ class SpotifyClient:
                         # check if the Spotify Desktop Application Client oauth2 token is defined.
                         hasToken:bool = AuthClient.HasTokenForKey(
                             clientId=SPOTIFY_DESKTOP_APP_CLIENT_ID,
-                            tokenStorageDir=self.TokenStorageDir,
                             tokenProviderId='SpotifyWebApiAuthCodePkce',
                             tokenProfileId=self._SpotifyConnectLoginId,
+                            tokenStorageDir=self.TokenStorageDir,
+                            tokenStorageFile=self.TokenStorageFile,
                         )
                         
                         if not hasToken:
@@ -8431,7 +8523,8 @@ class SpotifyClient:
                                                     discoverResult.HostIpPort, 
                                                     discoverResult.SpotifyConnectCPath,
                                                     useSSL=False,
-                                                    tokenStorageDir=self.TokenStorageDir)
+                                                    tokenStorageDir=self.TokenStorageDir,
+                                                    tokenStorageFile=self.TokenStorageFile)
                             info = zconn.GetInformation()
                     
                         except Exception as ex:
@@ -8446,7 +8539,8 @@ class SpotifyClient:
                                                         discoverResult.HostIpPort, 
                                                         discoverResult.SpotifyConnectCPath,
                                                         useSSL=False,
-                                                        tokenStorageDir=self.TokenStorageDir)
+                                                        tokenStorageDir=self.TokenStorageDir,
+                                                        tokenStorageFile=self.TokenStorageFile)
                                 info = zconn.GetInformation()
                                 
                                 # update HostIpAddress in discovery result so it knows to use the alias
@@ -8687,6 +8781,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -9613,6 +9708,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -9774,6 +9870,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -11554,9 +11651,10 @@ class SpotifyClient:
             _logsi.LeaveMethod(SILevel.Debug, apiMethodName)
 
 
-    def RemoveAudiobookFavorites(self, 
-                                 ids:str
-                                 ) -> None:
+    def RemoveAudiobookFavorites(
+            self, 
+            ids:str=None,
+            ) -> None:
         """
         Remove one or more audiobooks from the current user's 'Your Library'.
         
@@ -11567,6 +11665,7 @@ class SpotifyClient:
                 A comma-separated list of the Spotify IDs for the audiobooks.  
                 Maximum: 50 IDs.  
                 Example: `3PFyizE2tGCSRLusl2Qizf,7iHfbu1YPACw6oZPAFJtqe`
+                If null, the currently playing track album uri id value is used.
                 
         Raises:
             SpotifyWebApiError: 
@@ -11598,6 +11697,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("ids", ids)
             _logsi.LogMethodParmList(SILevel.Verbose, "Remove audiobook(s) from user favorites", apiMethodParms)
                 
+            # if ids not specified, then return currently playing id value.
+            if (ids is None) or (len(ids.strip()) == 0):
+                uri = self._GetPlayerNowPlayingAudiobookUri()
+                if uri is not None:
+                    ids = SpotifyClient.GetIdFromUri(uri)
+                else:
+                    raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'ids'), logsi=_logsi)
+
             # build a list of all item id's.
             # remove any leading / trailing spaces in case user put a space between the items.
             arrIds:list[str] = ids.split(',')
@@ -11633,9 +11740,10 @@ class SpotifyClient:
             _logsi.LeaveMethod(SILevel.Debug, apiMethodName)
 
 
-    def RemoveEpisodeFavorites(self, 
-                               ids:str
-                               ) -> None:
+    def RemoveEpisodeFavorites(
+            self, 
+            ids:str=None,
+            ) -> None:
         """
         Remove one or more episodes from the current user's 'Your Library'.
         
@@ -11646,6 +11754,7 @@ class SpotifyClient:
                 A comma-separated list of the Spotify IDs for the episodes.  
                 Maximum: 50 IDs.  
                 Example: `6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk`
+                If null, the currently playing context uri id value is used.
                 
         Raises:
             SpotifyWebApiError: 
@@ -11677,6 +11786,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("ids", ids)
             _logsi.LogMethodParmList(SILevel.Verbose, "Remove episode(s) from user favorites", apiMethodParms)
                 
+            # if ids not specified, then return currently playing id value.
+            if (ids is None) or (len(ids.strip()) == 0):
+                uri = self._GetPlayerNowPlayingUri('episode')
+                if uri is not None:
+                    ids = SpotifyClient.GetIdFromUri(uri)
+                else:
+                    raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'ids'), logsi=_logsi)
+
             # build a list of all item id's.
             # remove any leading / trailing spaces in case user put a space between the items.
             arrIds:list[str] = ids.split(',')
@@ -11891,9 +12008,10 @@ class SpotifyClient:
             _logsi.LeaveMethod(SILevel.Debug, apiMethodName)
 
 
-    def RemoveShowFavorites(self, 
-                            ids:str
-                            ) -> None:
+    def RemoveShowFavorites(
+            self, 
+            ids:str=None,
+            ) -> None:
         """
         Remove one or more shows from the current user's 'Your Library'.
         
@@ -11904,6 +12022,7 @@ class SpotifyClient:
                 A comma-separated list of the Spotify IDs for the shows.  
                 Maximum: 50 IDs.  
                 Example: `6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk`
+                If null, the currently playing context uri id value is used.
                 
         Raises:
             SpotifyWebApiError: 
@@ -11935,6 +12054,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("ids", ids)
             _logsi.LogMethodParmList(SILevel.Verbose, "Remove show(s) from user favorites", apiMethodParms)
                 
+            # if ids not specified, then return currently playing id value.
+            if (ids is None) or (len(ids.strip()) == 0):
+                uri = self._GetPlayerNowPlayingShowUri()
+                if uri is not None:
+                    ids = SpotifyClient.GetIdFromUri(uri)
+                else:
+                    raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'ids'), logsi=_logsi)
+
             # build a list of all item id's.
             # remove any leading / trailing spaces in case user put a space between the items.
             arrIds:list[str] = ids.split(',')
@@ -12348,9 +12475,10 @@ class SpotifyClient:
             _logsi.LeaveMethod(SILevel.Debug, apiMethodName)
 
 
-    def SaveAudiobookFavorites(self, 
-                               ids:str
-                               ) -> None:
+    def SaveAudiobookFavorites(
+            self, 
+            ids:str=None,
+            ) -> None:
         """
         Save one or more audiobooks to the current user's 'Your Library'.
         
@@ -12392,6 +12520,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("ids", ids)
             _logsi.LogMethodParmList(SILevel.Verbose, "Save audiobook(s) to user favorites", apiMethodParms)
                 
+            # if ids not specified, then return currently playing id value.
+            if (ids is None) or (len(ids.strip()) == 0):
+                uri = self._GetPlayerNowPlayingAudiobookUri()
+                if uri is not None:
+                    ids = SpotifyClient.GetIdFromUri(uri)
+                else:
+                    raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'ids'), logsi=_logsi)
+
             # build a list of all item id's.
             # remove any leading / trailing spaces in case user put a space between the items.
             arrIds:list[str] = ids.split(',')
@@ -12427,9 +12563,10 @@ class SpotifyClient:
             _logsi.LeaveMethod(SILevel.Debug, apiMethodName)
 
 
-    def SaveEpisodeFavorites(self, 
-                             ids:str
-                             ) -> None:
+    def SaveEpisodeFavorites(
+            self, 
+            ids:str=None,
+            ) -> None:
         """
         Save one or more episodes to the current user's 'Your Library'.
         
@@ -12440,6 +12577,7 @@ class SpotifyClient:
                 A comma-separated list of the Spotify IDs for the episodes.  
                 Maximum: 50 IDs.  
                 Example: `6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk`
+                If null, the currently playing context uri id value is used.
                 
         Raises:
             SpotifyWebApiError: 
@@ -12471,6 +12609,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("ids", ids)
             _logsi.LogMethodParmList(SILevel.Verbose, "Save episode(s) to user favorites", apiMethodParms)
                 
+            # if ids not specified, then return currently playing id value.
+            if (ids is None) or (len(ids.strip()) == 0):
+                uri = self._GetPlayerNowPlayingUri('episode')
+                if uri is not None:
+                    ids = SpotifyClient.GetIdFromUri(uri)
+                else:
+                    raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'ids'), logsi=_logsi)
+
             # build a list of all item id's.
             # remove any leading / trailing spaces in case user put a space between the items.
             arrIds:list[str] = ids.split(',')
@@ -12506,9 +12652,10 @@ class SpotifyClient:
             _logsi.LeaveMethod(SILevel.Debug, apiMethodName)
 
 
-    def SaveShowFavorites(self, 
-                          ids:str
-                          ) -> None:
+    def SaveShowFavorites(
+            self, 
+            ids:str=None,
+            ) -> None:
         """
         Save one or more shows to the current user's 'Your Library'.
         
@@ -12519,6 +12666,7 @@ class SpotifyClient:
                 A comma-separated list of the Spotify IDs for the shows.  
                 Maximum: 50 IDs.  
                 Example: `6kAsbP8pxwaU2kPibKTuHE,4rOoJ6Egrf8K2IrywzwOMk`
+                If null, the currently playing context uri id value is used.
                 
         Raises:
             SpotifyWebApiError: 
@@ -12550,6 +12698,14 @@ class SpotifyClient:
             apiMethodParms.AppendKeyValue("ids", ids)
             _logsi.LogMethodParmList(SILevel.Verbose, "Save show(s) to user favorites", apiMethodParms)
                 
+            # if ids not specified, then return currently playing id value.
+            if (ids is None) or (len(ids.strip()) == 0):
+                uri = self._GetPlayerNowPlayingShowUri()
+                if uri is not None:
+                    ids = SpotifyClient.GetIdFromUri(uri)
+                else:
+                    raise SpotifyApiError(SAAppMessages.ARGUMENT_REQUIRED_ERROR % (apiMethodName, 'ids'), logsi=_logsi)
+
             # build a list of all item id's.
             # remove any leading / trailing spaces in case user put a space between the items.
             arrIds:list[str] = ids.split(',')
@@ -12709,6 +12865,7 @@ class SpotifyClient:
     #         limit (int):
     #             The maximum number of items to return in a page of items.  
     #             Default: 20, Range: 1 to 50.  
+    #             See the `limitTotal` argument for automatic paging option.  
     #         offset (int):
     #             The page index offset of the first item to return.  
     #             Use with limit to get the next set of items.  
@@ -12878,6 +13035,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -13068,6 +13226,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -13258,6 +13417,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -13450,6 +13610,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -13640,6 +13801,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -13830,6 +13992,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -14020,6 +14183,7 @@ class SpotifyClient:
             limit (int):
                 The maximum number of items to return in a page of items when manual paging is used.  
                 Default: 20, Range: 1 to 50.  
+                See the `limitTotal` argument for automatic paging option.  
             offset (int):
                 The page index offset of the first item to return.  
                 Use with limit to get the next set of items.  
@@ -14298,6 +14462,7 @@ class SpotifyClient:
                 clientSecret=clientSecret,
                 oauth2Client=WebApplicationClient(client_id=clientId),  # required for grant_type = authorization_code
                 tokenStorageDir=self._TokenStorageDir,
+                tokenStorageFile=self._TokenStorageFile,
                 tokenProviderId='SpotifyWebApiAuthCode',
                 tokenProfileId=tokenProfileId,
                 tokenUpdater=self._TokenUpdater
@@ -14480,6 +14645,7 @@ class SpotifyClient:
                 clientSecret=None,  # client_secret not used for authorization code with pkce type
                 oauth2Client=WebApplicationClient(client_id=clientId),  # required for grant_type = authorization_code
                 tokenStorageDir=self._TokenStorageDir,
+                tokenStorageFile=self._TokenStorageFile,
                 tokenProviderId='SpotifyWebApiAuthCodePkce',
                 tokenProfileId=tokenProfileId,
                 tokenUpdater=self._TokenUpdater
@@ -14597,6 +14763,7 @@ class SpotifyClient:
                 clientSecret=clientSecret,
                 oauth2Client=BackendApplicationClient(client_id=clientId),  # required for grant_type = client_credentials
                 tokenStorageDir=self._TokenStorageDir,
+                tokenStorageFile=self._TokenStorageFile,
                 tokenProviderId='SpotifyWebApiClientCredentials',
                 tokenProfileId=tokenProfileId,
                 tokenUpdater=self._TokenUpdater
@@ -14695,6 +14862,7 @@ class SpotifyClient:
                 scope=token.get('scope'),
                 clientId=clientId,
                 tokenStorageDir=self._TokenStorageDir,
+                tokenStorageFile=self._TokenStorageFile,
                 tokenProviderId='SpotifyWebApiOAuth2Token',
                 tokenProfileId=tokenProfileId,
                 tokenUpdater=self._TokenUpdater
@@ -14754,6 +14922,7 @@ class SpotifyClient:
         msg:str = 'SpotifyClient:'
         msg = "%s\n ConfigurationCache key count=%d" % (msg, len(self._ConfigurationCache))
         msg = "%s\n TokenStorageDir='%s'" % (msg, self._TokenStorageDir)
+        msg = "%s\n TokenStorageFile='%s'" % (msg, self._TokenStorageFile)
         if self._UserProfile is not None:
             msg = "%s\n User DisplayName='%s' (%s)" % (msg, self._UserProfile.DisplayName, self._UserProfile.Id)
         return msg