Spotify.NET/SpotifyAPI.Web/Models/Request/PlaylistGetRequest.cs

61 lines
2.1 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

using System;
using System.Collections.Generic;
namespace SpotifyAPI.Web
{
public class PlaylistGetRequest : RequestParams
{
public PlaylistGetRequest(AdditionalTypes types = AdditionalTypes.All)
{
Ensure.ArgumentNotNull(types, nameof(types));
AdditionalTypesParam = types;
Fields = new List<string>();
}
/// <summary>
/// Filters for the query: a comma-separated list of the fields to return.
/// If omitted, all fields are returned. For example, to get just the playlists description and URI: fields=description,uri.
/// A dot separator can be used to specify non-reoccurring fields,
/// while parentheses can be used to specify reoccurring fields within objects.
/// For example, to get just the added date and user ID of the adder:
/// fields=tracks.items(added_at,added_by.id). Use multiple parentheses to drill down into nested objects, for example:
/// fields=tracks.items(track(name,href,album(name,href))).
/// Fields can be excluded by prefixing them with an exclamation mark, for example:
/// fields=tracks.items(track(name,href,album(!name,href)))
/// </summary>
/// <value></value>
[QueryParam("fields")]
public IList<string> Fields { get; }
/// <summary>
/// An ISO 3166-1 alpha-2 country code or the string from_token.
/// Provide this parameter if you want to apply Track Relinking.
/// For episodes, if a valid user access token is specified in the request header,
/// the country associated with the user account will take priority over this parameter.
/// Note: If neither market or user country are provided, the episode is considered unavailable for the client.
/// </summary>
/// <value></value>
[QueryParam("market")]
public string? Market { get; }
/// <summary>
/// This is set to `"track", "episode"` by default.
/// </summary>
/// <value></value>
[QueryParam("additional_types")]
public AdditionalTypes AdditionalTypesParam { get; }
[Flags]
public enum AdditionalTypes
{
[String("track")]
Track = 1,
[String("episode")]
Episode = 2,
All = Track | Episode
}
}
}