-
Notifications
You must be signed in to change notification settings - Fork 368
/
ITemplateCreationResult.cs
48 lines (40 loc) · 1.58 KB
/
ITemplateCreationResult.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
46
47
48
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
#nullable enable
using Microsoft.TemplateEngine.Abstractions;
namespace Microsoft.TemplateEngine.Edge.Template
{
/// <summary>
/// Represents result of template instantiation / dry run via <see cref="TemplateCreator.InstantiateAsync(ITemplateInfo, string?, string?, string?, System.Collections.Generic.IReadOnlyDictionary{string, string?}, bool, string?, bool, System.Threading.CancellationToken)"></see>. />.
/// </summary>
public interface ITemplateCreationResult
{
/// <summary>
/// Result of template dry run.
/// Template dry run always performed prior to instantiation.
/// </summary>
ICreationEffects? CreationEffects { get; }
/// <summary>
/// Error message, null if operation is successful.
/// Should be localized.
/// </summary>
string? ErrorMessage { get; }
/// <summary>
/// The output directory used for template instantiation.
/// </summary>
string? OutputBaseDirectory { get; }
/// <summary>
/// The result of template instantiation.
/// Null in case of dry run.
/// </summary>
ICreationResult? CreationResult { get; }
/// <summary>
/// Status of template instantiation.
/// </summary>
CreationResultStatus Status { get; }
/// <summary>
/// Processed template name.
/// </summary>
string TemplateFullName { get; }
}
}