Kyoo/Kyoo.Common/Models/Resources/Provider.cs

using System.Collections.Generic;
using Kyoo.Common.Models.Attributes;
using Kyoo.Controllers;
using Kyoo.Models.Attributes;

namespace Kyoo.Models
{
	/// <summary>
	/// This class contains metadata about <see cref="IMetadataProvider"/>.
	/// You can have providers even if you don't have the corresponding <see cref="IMetadataProvider"/>.
	/// </summary>
	public class Provider : IResource
	{
		/// <inheritdoc />
		public int ID { get; set; }
		
		/// <inheritdoc />
		public string Slug { get; set; }
		
		/// <summary>
		/// The name of this provider.
		/// </summary>
		public string Name { get; set; }
		
		/// <summary>
		/// The path of this provider's logo.
		/// By default, the http path for this logo is returned from the public API.
		/// This can be disabled using the internal query flag.
		/// </summary>
		[SerializeAs("{HOST}/api/providers/{Slug}/logo")] public string Logo { get; set; }
		
		/// <summary>
		/// The extension of the logo. This is used for http responses.
		/// </summary>
		[SerializeIgnore] public string LogoExtension { get; set; }
		
		/// <summary>
		/// The list of libraries that uses this provider.
		/// </summary>
		[LoadableRelation] public ICollection<Library> Libraries { get; set; }
		
#if ENABLE_INTERNAL_LINKS
		/// <summary>
		/// The internal link between this provider and libraries in the <see cref="Libraries"/> list.
		/// </summary>
		[Link] public ICollection<Link<Library, Provider>> LibraryLinks { get; set; }
#endif
		
		/// <summary>
		/// Create a new, default, <see cref="Provider"/>
		/// </summary>
		public Provider() { }

		/// <summary>
		/// Create a new <see cref="Provider"/> and specify it's <see cref="Name"/>.
		/// The <see cref="Slug"/> is automatically calculated from it's name.  
		/// </summary>
		/// <param name="name">The name of this provider.</param>
		/// <param name="logo">The logo of this provider.</param>
		public Provider(string name, string logo)
		{
			Slug = Utility.ToSlug(name);
			Name = name;
			Logo = logo;
		}
	}
}