lib/Emails.Transactional.Plugin/src/Templates/ITemplateStorage.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: Emails.Transactional
* File: ITemplateStorage.cs 
*
* ITemplateStorage.cs is part of Emails.Transactional which is part of the larger 
* VNLib collection of libraries and utilities.
*
* Emails.Transactional is free software: you can redistribute it and/or modify 
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
* Emails.Transactional is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License 
* along with Emails.Transactional. If not, see http://www.gnu.org/licenses/.
*/


using System.Threading;
using System.Threading.Tasks;

namespace Emails.Transactional.Templates
{
    /// <summary>
    /// An abstraction that defines a storage for email templates
    /// </summary>
    internal interface ITemplateStorage
    {
        /// <summary>
        /// Gets an email template from its id
        /// </summary>
        /// <param name="templateId">The id of the template to fetch</param>
        /// <param name="cancellation">A token to cancel the fetch operation</param>
        /// <returns>A task that completes with the template model instance</returns>
        /// <exception cref="TemplateLookupFailedException"></exception>
        Task<IEmailTemplate> GetTemplateAsync(string templateId, CancellationToken cancellation);
    }
}