Functions/GenXdev.Console.Spotify/Remove-SpotifyTracksFromPlaylist.ps1
|
<##############################################################################
Part of PowerShell module : GenXdev.Console.Spotify Original cmdlet filename : Remove-SpotifyTracksFromPlaylist.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 a Spotify playlist. .DESCRIPTION Removes one or more tracks from either a named Spotify playlist or a playlist specified by its ID. Supports pipeline input for track URIs. .PARAMETER PlaylistName The name(s) of the Spotify playlist(s) to remove tracks from. .PARAMETER PlaylistId The Spotify playlist ID(s) to remove tracks from. .PARAMETER Uri The Spotify track URIs that should be removed from the playlist. .EXAMPLE Remove-SpotifyTracksFromPlaylist -PlaylistName "My Playlist" ` -Uri "spotify:track:1234567890" .EXAMPLE "spotify:track:1234567890" | removefromplaylist "My Playlist" ############################################################################## #> function Remove-SpotifyTracksFromPlaylist { [CmdletBinding(DefaultParameterSetName = 'ByName', SupportsShouldProcess)] [Alias('removefromplaylist')] param( ######################################################################## [parameter( ParameterSetName = 'ByName', Mandatory = $true, Position = 0, HelpMessage = 'The Spotify playlist to delete tracks from' )] [string[]] $PlaylistName, ######################################################################## [parameter( ParameterSetName = 'ById', Mandatory = $true, Position = 0, HelpMessage = 'The Spotify playlist to delete tracks from' )] [string[]] $PlaylistId, ######################################################################## [parameter( Mandatory = $false, Position = 1, ValueFromPipeline, ValueFromPipelineByPropertyName, HelpMessage = 'The Spotify tracks that should be removed from the playlist' )] [string[]] $Uri = @() ######################################################################## ) begin { # get authentication token for spotify api $apiToken = GenXdev.Console\Get-SpotifyApiToken Microsoft.PowerShell.Utility\Write-Verbose 'Retrieved Spotify API token' # if playlist names were provided, convert them to playlist ids if ($PlaylistName.Length -gt 0) { Microsoft.PowerShell.Utility\Write-Verbose 'Converting playlist names to IDs' $PlaylistId = @(GenXdev.Console\Get-SpotifyPlaylistIdsByName -PlaylistName $PlaylistName) Microsoft.PowerShell.Utility\Write-Verbose "Found $($PlaylistId.Count) matching playlists" } } process { # process each playlist id and remove the specified tracks foreach ($id in $PlaylistId) { Microsoft.PowerShell.Utility\Write-Verbose "Preparing to remove tracks from playlist with ID: $id" # use shouldprocess to get confirmation before removing tracks if ($PSCmdlet.ShouldProcess("Playlist ID: $id", 'Remove tracks')) { Microsoft.PowerShell.Utility\Write-Verbose "Removing tracks from playlist with ID: $id" [GenXdev.Helpers.Spotify]::RemoveFromPlaylist($apiToken, $id, $Uri) } } } end { } } |