Added documentation for custom repos and exporter plugin
This commit is contained in:
@@ -56,6 +56,10 @@ public static class HopFrameConfiguratorExtensions {
|
||||
return configurator;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Registers the Exporter Plugin for data import/export functionality.
|
||||
/// </summary>
|
||||
/// <param name="configurator">The configurator for the HopFrame configuration.</param>
|
||||
public static HopFrameConfigurator AddExporters(this HopFrameConfigurator configurator) {
|
||||
configurator.AddPlugin<ExporterPlugin>();
|
||||
return configurator;
|
||||
|
||||
@@ -2,10 +2,22 @@
|
||||
|
||||
namespace HopFrame.Web.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Provides file handling capabilities for downloading and uploading files.
|
||||
/// </summary>
|
||||
public interface IFileService {
|
||||
|
||||
/// <summary>
|
||||
/// Initiates a file download with the specified name and data.
|
||||
/// </summary>
|
||||
/// <param name="name">The name of the file to be downloaded.</param>
|
||||
/// <param name="data">The byte array representing the file's content.</param>
|
||||
public Task DownloadFile(string name, byte[] data);
|
||||
|
||||
/// <summary>
|
||||
/// Allows the user to upload a file and returns the uploaded file for processing.
|
||||
/// </summary>
|
||||
/// <returns>A task that returns an IBrowserFile representing the uploaded file.</returns>
|
||||
public Task<IBrowserFile> UploadFile();
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user