Functions/GenXdev.Console.Spotify/Search-SpotifyAndEnqueue.cs
|
// ################################################################################
// Part of PowerShell module : GenXdev.Console.Spotify // Original cmdlet filename : Search-SpotifyAndEnqueue.cs // Original author : René Vaessen / GenXdev // Version : 1.302.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. // ################################################################################ using System; using System.Collections.Generic; using System.Management.Automation; using SpotifyAPI.Web; using GenXdev.Helpers; namespace GenXdev.Console.Spotify { /// <summary> /// <para type="synopsis"> /// Searches Spotify and adds the first matching item to the playback queue. /// </para> /// /// <para type="description"> /// Performs a search on Spotify using specified criteria and automatically adds the /// first matching result to the current playback queue. Supports searching for /// tracks, albums, artists, playlists, shows, and episodes. /// </para> /// /// <para type="description"> /// PARAMETERS /// </para> /// /// <para type="description"> /// -Queries <string[]><br/> /// One or more search phrases to find content on Spotify. Each query is processed /// sequentially and the first match for each is added to the queue.<br/> /// - <b>Aliases</b>: q, Name, Text, Query<br/> /// - <b>Position</b>: 0<br/> /// - <b>Mandatory</b>: true<br/> /// </para> /// /// <para type="description"> /// -SearchType <SpotifyAPI.Web.SearchRequest.Types><br/> /// Specifies the type(s) of content to search for. Valid options are: /// Track (default), Album, Artist, Playlist, Show, Episode, All<br/> /// - <b>Aliases</b>: t<br/> /// - <b>Position</b>: 1<br/> /// - <b>Default</b>: Track<br/> /// </para> /// /// <example> /// <para>Search for and enqueue a track</para> /// <para>This example searches for tracks matching "Rage against the machine" and adds the first result to the queue.</para> /// <code> /// Search-SpotifyAndEnqueue -Queries "Rage against the machine" -SearchType Track /// </code> /// </example> /// /// <example> /// <para>Search for and enqueue using alias</para> /// <para>This example uses the fmq alias to search for and enqueue a Dire Straits track.</para> /// <code> /// fmq "Dire Straits You and your friend" /// </code> /// </example> /// </summary> [Cmdlet("Search", "SpotifyAndEnqueue")] [Alias("smq", "fmq")] [OutputType(typeof(object))] public class SearchSpotifyAndEnqueueCommand : PSGenXdevCmdlet { /// <summary> /// One or more search phrases to find content on Spotify /// </summary> [Parameter( Mandatory = true, Position = 0, ValueFromPipeline = true, ValueFromPipelineByPropertyName = true, HelpMessage = "The query to perform")] [Alias("q", "Name", "Text", "Query")] public string[] Queries { get; set; } /// <summary> /// The type of content to search for /// </summary> [Parameter( Position = 1, Mandatory = false, HelpMessage = "The type of content to search for")] [Alias("t")] public SpotifyAPI.Web.SearchRequest.Types SearchType { get; set; } = SpotifyAPI.Web.SearchRequest.Types.Track; /// <summary> /// Begin processing - initialization logic /// </summary> protected override void BeginProcessing() { WriteVerbose($"Initialized search type mask: {SearchType}"); } /// <summary> /// Process record - main cmdlet logic /// </summary> protected override void ProcessRecord() { foreach (var query in Queries) { WriteVerbose($"Processing query: {query}"); try { // Get the Spotify API token by invoking the PowerShell function var tokenResults = InvokeCommand.InvokeScript("GenXdev.Console\\Get-SpotifyApiToken"); var token = tokenResults.Count > 0 ? (string)tokenResults[0].BaseObject : null; if (token != null) { // Call the SearchAndAdd method from the GenXdev.Helpers assembly var rawResults = GenXdev.Helpers.Spotify.SearchAndAdd(token, query, SearchType); if (rawResults != null) { var results = rawResults as IEnumerable<object> ?? new[] { rawResults }; foreach (var item in results) { if (item != null) { WriteObject(item); } } } } } catch { // Silently continue on errors to match -ErrorAction SilentlyContinue behavior } } } /// <summary> /// End processing - cleanup logic /// </summary> protected override void EndProcessing() { // Empty as in original PowerShell function } } } |