Open-source eCommerce platform for C# and ASP.NET Core 10 with MongoDB. Build multi-store shops and multi-vendor marketplaces with B2B/B2C, REST API, plugins, Vue 3 and Docker.
C# aspnet-corecsharpdockerdotnetecommerceecommerce-platformmongodbmulti-storemulti-vendornosqlonline-shopshoppingcart
using Grand.Domain;
using Grand.Domain.Common;
using Grand.Domain.Media;
using System.Linq.Expressions;
namespace Grand.Business.Core.Interfaces.Storage;
/// <summary>
/// Picture service interface
/// </summary>
public interface IPictureService
{
/// <summary>
/// Gets the loaded picture binary depending on picture storage settings
/// </summary>
/// <param name="picture">Picture</param>
/// <returns>Picture binary</returns>
Task<byte[]> LoadPictureBinary(Picture picture);
/// <summary>
/// Gets the loaded picture binary depending on picture storage settings
/// </summary>
/// <param name="picture">Picture</param>
/// <param name="fromDb">Load from database; otherwise, from file system</param>
/// <returns>Picture binary</returns>
Task<byte[]> LoadPictureBinary(Picture picture, bool fromDb);
/// <summary>
/// Get picture SEO friendly name
/// </summary>
/// <param name="name">Name</param>
/// <returns>Result</returns>
string GetPictureSeName(string name);
/// <summary>
/// Gets the default picture URL
/// </summary>
/// <param name="targetSize">The target picture size (longest side)</param>
/// <param name="storeLocation">Store location URL; null to use determine the current store location automatically</param>
/// <returns>Picture URL</returns>
Task<string> GetDefaultPictureUrl(int targetSize = 0, string storeLocation = null);
/// <summary>
/// Get a picture URL
/// </summary>
/// <param name="pictureId">Picture identifier</param>
/// <param name="targetSize">The target picture size (longest side)</param>
/// <param name="showDefaultPicture">A value indicating whether the default picture is shown</param>
/// <param name="storeLocation">Store location URL; null to use determine the current store location automatically</param>
/// <returns>Picture URL</returns>
Task<string> GetPictureUrl(string pictureId,
int targetSize = 0,
bool showDefaultPicture = true,
string storeLocation = null);
/// <summary>
/// Get a picture URL
/// </summary>
/// <param name="picture">Picture instance</param>
/// <param name="targetSize">The target picture size (longest side)</param>
/// <param name="showDefaultPicture">A value indicating whether the default picture is shown</param>
/// <param name="storeLocation">Store location URL; null to use determine the current store location automatically</param>
/// <returns>Picture URL</returns>
Task<string> GetPictureUrl(Picture picture,
int targetSize = 0,
bool showDefaultPicture = true,
string storeLocation = null);
/// <summary>
/// Get a picture local path
/// </summary>
/// <param name="picture">Picture instance</param>
/// <param name="targetSize">The target picture size (longest side)</param>
/// <param name="showDefaultPicture">A value indicating whether the default picture is shown</param>
/// <returns></returns>
Task<string> GetThumbPhysicalPath(Picture picture, int targetSize = 0, bool showDefaultPicture = true);
/// <summary>
/// Gets a picture
/// </summary>
/// <param name="pictureId">Picture identifier</param>
/// <returns>Picture</returns>
Task<Picture> GetPictureById(string pictureId);
/// <summary>
/// Deletes a picture
/// </summary>
/// <param name="picture">Picture</param>
Task DeletePicture(Picture picture);
/// <summary>
/// Deletes a picture on file system
/// </summary>
/// <param name="picture">Picture</param>
Task DeletePictureOnFileSystem(Picture picture);
/// <summary>
/// Save picture on file system
/// </summary>
/// <param name="pictureId">Picture identifier</param>
/// <param name="pictureBinary">Picture binary</param>
/// <param name="mimeType">MIME type</param>
Task SavePictureInFile(string pictureId, byte[] pictureBinary, string mimeType);
/// <summary>
/// Clear Pictures stored in Assets/Images/Thumbs
/// </summary>
Task ClearThumbs();
/// <summary>
/// Gets a collection of pictures
/// </summary>
/// <param name="pageIndex">Current page</param>
/// <param name="pageSize">Items on each page</param>
/// <returns>Paged list of pictures</returns>
Task<IPagedList<Picture>> GetPictures(int pageIndex = 0, int pageSize = int.MaxValue);
/// <summary>
/// Inserts a picture
/// </summary>
/// <param name="pictureBinary">The picture binary</param>
/// <param name="mimeType">The picture MIME type</param>
/// <param name="seoFilename">The SEO filename</param>
/// <param name="altAttribute">"alt" attribute for "img" HTML element</param>
/// <param name="titleAttribute">"title" attribute for "img" HTML element</param>
/// <param name="isNew">A value indicating whether the picture is new</param>
/// <param name="reference">Reference type</param>
/// <param name="objectId">Object id for reference</param>
/// <param name="validateBinary">A value indicating whether to validated provided picture binary</param>
/// <returns>Picture</returns>
Task<Picture> InsertPicture(byte[] pictureBinary, string mimeType, string seoFilename,
string altAttribute = null, string titleAttribute = null,
bool isNew = true, Reference reference = Reference.None, string objectId = "", bool validateBinary = false);
/// <summary>
/// Updates the picture
/// </summary>
/// <param name="pictureId">The picture identifier</param>
/// <param name="pictureBinary">The picture binary</param>
/// <param name="mimeType">The picture MIME type</param>
/// <param name="seoFilename">The SEO filename</param>
/// <param name="altAttribute">"alt" attribute for "img" HTML element</param>
/// <param name="titleAttribute">"title" attribute for "img" HTML element</param>
/// <param name="style">style attribute for "img" HTML element</param>
/// <param name="extraField">Extra field</param>
/// <param name="isNew">A value indicating whether the picture is new</param>
/// <param name="validateBinary">A value indicating whether to validated provided picture binary</param>
/// <returns>Picture</returns>
Task<Picture> UpdatePicture(string pictureId, byte[] pictureBinary, string mimeType,
string seoFilename, string altAttribute = null, string titleAttribute = null,
string style = null, string extraField = null,
bool isNew = true, bool validateBinary = true);
/// <summary>
/// Updates the picture
/// </summary>
/// <param name="picture">Picture</param>
/// <returns>Picture</returns>
Task<Picture> UpdatePicture(Picture picture);
/// <summary>
/// Updates the picture field
/// </summary>
/// <param name="picture">Picture</param>
/// <param name="expression"></param>
/// <param name="value"></param>
Task UpdatePictureField<T>(Picture picture,
Expression<Func<Picture, T>> expression, T value);
/// <summary>
/// Updates a SEO filename of a picture
/// </summary>
/// <param name="picture">The picture</param>
/// <param name="seoFilename">The SEO filename</param>
/// <returns>Picture</returns>
Task<Picture> SetSeoFilename(Picture picture, string seoFilename);
/// <summary>
/// Validates input picture dimensions
/// </summary>
/// <param name="pictureBinary">Picture binary</param>
/// <param name="mimeType">MIME type</param>
/// <returns>Picture binary or throws an exception</returns>
byte[] ValidatePicture(byte[] pictureBinary, string mimeType);
/// <summary>
/// Convert picture
/// </summary>
/// <param name="pictureBinary">Picture binary</param>
/// <param name="imageQuality">Image quality</param>
/// <param name="format">Format</param>
/// <returns>Picture binary or throws an exception</returns>
byte[] ConvertPicture(byte[] pictureBinary, int imageQuality, string format = "Webp");
}