2019-01-24 16:43:03 +08:00
|
|
|
|
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
|
|
|
// See the LICENCE file in the repository root for full licence text.
|
2018-04-13 17:19:50 +08:00
|
|
|
|
|
2022-06-17 15:37:17 +08:00
|
|
|
|
#nullable disable
|
|
|
|
|
|
2020-10-02 15:17:10 +08:00
|
|
|
|
using System.Collections.Generic;
|
2019-05-28 17:59:21 +08:00
|
|
|
|
using System.Threading.Tasks;
|
|
|
|
|
|
2018-02-15 15:33:33 +08:00
|
|
|
|
namespace osu.Game.Database
|
2018-02-14 19:26:49 +08:00
|
|
|
|
{
|
2018-02-15 14:14:46 +08:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// A class which can accept files for importing.
|
|
|
|
|
/// </summary>
|
2018-02-15 13:19:16 +08:00
|
|
|
|
public interface ICanAcceptFiles
|
2018-02-14 19:26:49 +08:00
|
|
|
|
{
|
2018-02-15 14:14:46 +08:00
|
|
|
|
/// <summary>
|
2022-06-14 19:00:16 +08:00
|
|
|
|
/// Import one or more items from filesystem <paramref name="paths"/>.
|
2018-02-15 14:14:46 +08:00
|
|
|
|
/// </summary>
|
2022-06-14 19:00:16 +08:00
|
|
|
|
/// <remarks>
|
|
|
|
|
/// This will be treated as a low priority batch import if more than one path is specified.
|
|
|
|
|
/// This will post notifications tracking progress.
|
|
|
|
|
/// </remarks>
|
2018-02-15 14:14:46 +08:00
|
|
|
|
/// <param name="paths">The files which should be imported.</param>
|
2019-05-28 17:59:21 +08:00
|
|
|
|
Task Import(params string[] paths);
|
2018-04-13 17:19:50 +08:00
|
|
|
|
|
2020-12-07 17:00:45 +08:00
|
|
|
|
/// <summary>
|
2020-12-16 21:28:16 +08:00
|
|
|
|
/// Import the specified files from the given import tasks.
|
2020-12-07 17:00:45 +08:00
|
|
|
|
/// </summary>
|
2022-06-14 19:00:16 +08:00
|
|
|
|
/// <remarks>
|
|
|
|
|
/// This will be treated as a low priority batch import if more than one path is specified.
|
|
|
|
|
/// This will post notifications tracking progress.
|
|
|
|
|
/// </remarks>
|
2020-12-19 17:36:27 +08:00
|
|
|
|
/// <param name="tasks">The import tasks from which the files should be imported.</param>
|
2022-12-13 20:03:25 +08:00
|
|
|
|
/// <param name="parameters">Parameters to further configure the import process.</param>
|
|
|
|
|
Task Import(ImportTask[] tasks, ImportParameters parameters = default);
|
2020-12-07 17:00:45 +08:00
|
|
|
|
|
2018-02-15 14:14:46 +08:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// An array of accepted file extensions (in the standard format of ".abc").
|
|
|
|
|
/// </summary>
|
2020-10-02 15:17:10 +08:00
|
|
|
|
IEnumerable<string> HandledExtensions { get; }
|
2018-02-14 19:26:49 +08:00
|
|
|
|
}
|
|
|
|
|
}
|