Files
WebImageViewer/WebImageViewer/Class/Legacy/Common/IScraper.cs
T

43 lines
1.5 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 WebImageViewer.Class.Legacy.Models;
namespace WebImageViewer.Class.Legacy.Common;
/// <summary>
/// 各スクレイパーが実装すべき共通インターフェース
/// </summary>
public interface IScraper
{
/// <summary>
/// 対象サイトの名称(表示用)
/// </summary>
string SiteName { get; }
/// <summary>
/// サイト固有の一意な識別子(URLパラメータ用。例: "momonga", "aurahentai")
/// </summary>
string SiteKey { get; }
/// <summary>
/// URLパスやエイリアス名の一覧(例: ["momon-ga", "fanzine", "magazine"])
/// </summary>
IReadOnlyList<string> Aliases { get; }
/// <summary>
/// 指定されたURLやパス、IDをこのスクレイパーで処理可能かどうかを判定します。
/// </summary>
/// <param name="urlOrPath">対象のURLまたはパス</param>
/// <returns>処理可能な場合はtrue</returns>
bool CanHandle(string urlOrPath);
/// <summary>
/// 作品IDまたはURLからギャラリー情報および画像一覧を取得します。
/// </summary>
/// <param name="idOrUrl">作品IDまたはURL</param>
/// <param name="category">カテゴリ(fanzine, magazineなど。省略時は自動判定)</param>
/// <param name="cancellationToken">キャンセレーショントークン</param>
/// <returns>取得したGalleryItem(失敗時はnull)</returns>
Task<GalleryItem?> ScrapeAsync(string idOrUrl, string? category = null, CancellationToken cancellationToken = default);
}