EpubReader/Source/VersOne.Epub/Options/ContentDownloaderOptions.cs

using System.Diagnostics.CodeAnalysis;
using VersOne.Epub.Environment;

namespace VersOne.Epub.Options
{
    /// <summary>
    /// Various options to configure the behavior of the EPUB content downloader which is used for downloading remote content files.
    /// </summary>
    public class ContentDownloaderOptions
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="ContentDownloaderOptions" /> class.
        /// </summary>
        /// <param name="preset">An optional preset to initialize the <see cref="ContentDownloaderOptions" /> class with a predefined set of options.</param>
        [SuppressMessage("Style", "IDE0060:Remove unused parameter", Justification = "Temporarily ignore unused 'preset' parameter.")]
        public ContentDownloaderOptions(EpubReaderOptionsPreset? preset = null)
        {
            DownloadContent = false;
            DownloaderUserAgent = null;
            CustomContentDownloader = null;
        }

        /// <summary>
        /// Gets or sets a value indicating whether the content downloader should download remote resources specified in the EPUB manifest.
        /// If it's set to <c>false</c>, then <see cref="EpubRemoteTextContentFile.Content" /> and <see cref="EpubRemoteByteContentFile.Content" /> will always be <c>null</c>
        /// and <see cref="EpubRemoteContentFileRef" /> will throw a "Downloading remote content is prohibited by the ContentDownloaderOptions.DownloadContent option" exception.
        /// Default value is <c>false</c>.
        /// </summary>
        public bool DownloadContent { get; set; }

        /// <summary>
        /// Gets or sets the user agent presented by the content downloader. This value is used by the built-in downloader to set the <c>User-Agent</c> header of the HTTP request.
        /// If this value is set to <c>null</c>, then the following user agent value will be used: "EpubReader/version" where "version" is the current version of the EpubReader library.
        /// Default value is <c>null</c>.
        /// </summary>
        public string? DownloaderUserAgent { get; set; }

        /// <summary>
        /// Gets or sets a reference to the custom content downloader.
        /// If it's set to <c>null</c>, the built-in content downloader will be used to download remote content files.
        /// Default value is <c>null</c>.
        /// </summary>
        public IContentDownloader? CustomContentDownloader { get; set; }
    }
}