Functions/GenXdev.Console.Spotify/Remove-SpotifyTracksFromLiked.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.Console.Spotify Original cmdlet filename : Remove-SpotifyTracksFromLiked.ps1 Original author : René Vaessen / GenXdev Version : 1.300.2025 ################################################################################ Copyright (c) René Vaessen / GenXdev Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ################################################################################> ############################################################################### <# .SYNOPSIS Removes tracks from the user's Spotify Library (Liked Songs). .DESCRIPTION Removes one or more tracks from the user's Spotify Liked Songs collection. If no track ID is provided, removes the currently playing track. .PARAMETER TrackId One or more Spotify track IDs to remove from the Liked Songs collection. If omitted, the currently playing track will be removed. .EXAMPLE Remove-SpotifyTracksFromLiked -TrackId "1234567890abcdef" .EXAMPLE dislike "1234567890abcdef" #> function Remove-SpotifyTracksFromLiked { [CmdletBinding(SupportsShouldProcess = $true)] [Alias('dislike')] param( ######################################################################## [Alias('Id')] [parameter( Mandatory = $false, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName, HelpMessage = 'The Spotify track IDs to remove from Liked Songs' )] [string[]] $TrackId = @() ######################################################################## ) begin { # retrieve the spotify api access token for authentication $apiToken = GenXdev.Console\Get-SpotifyApiToken } process { # if no track ids were provided, handle currently playing track if ($TrackId.Length -eq 0) { # get information about the currently playing track $CurrentlyPlaying = GenXdev.Console\Get-SpotifyCurrentlyPlaying # verify there is a track currently playing if ($null -eq $CurrentlyPlaying -or $CurrentlyPlaying.CurrentlyPlayingType -ne 'track') { Microsoft.PowerShell.Utility\Write-Warning 'There are no tracks playing at this time' return } Microsoft.PowerShell.Utility\Write-Verbose 'Removing currently playing track from Liked Songs' # recursively call this function with the current track's id GenXdev.Console\Remove-SpotifyTracksFromLiked -TrackId ($CurrentlyPlaying.Item.Id) # return the track that was removed $CurrentlyPlaying.Item } else { Microsoft.PowerShell.Utility\Write-Verbose "Removing $($TrackId.Count) track(s) from Liked Songs" # use shouldprocess to confirm the operation if ($PSCmdlet.ShouldProcess( "Remove $($TrackId.Count) track(s) from Liked Songs", 'Are you sure you want to remove these tracks from your Liked Songs?', 'Removing tracks from Liked Songs')) { # remove the specified tracks from liked songs using the spotify api [GenXdev.Helpers.Spotify]::RemoveFromLiked($apiToken, $TrackId) } } } end { } } |