mirror of
https://github.com/Flow-Launcher/Flow.Launcher.git
synced 2026-03-11 08:54:32 +00:00
add method comments for LastOpenedHistoryResult
This commit is contained in:
parent
6d6003fd80
commit
9c2f2398f1
1 changed files with 30 additions and 0 deletions
|
|
@ -5,17 +5,37 @@ using Flow.Launcher.Plugin;
|
|||
|
||||
namespace Flow.Launcher.Storage;
|
||||
|
||||
/// <summary>
|
||||
/// A serializable result used to record the last opened history for reopening results.
|
||||
/// Inherits common result fields from <see cref="Result"/> and adds the original query and execution time.
|
||||
/// </summary>
|
||||
public class LastOpenedHistoryResult : Result
|
||||
{
|
||||
/// <summary>
|
||||
/// The query string from Query.TrimmedQuery property, it is stored as a string instead of the entire Query class <see cref="Result"/>.
|
||||
/// This is used so results can be reopened or re-run using the serialized query string.
|
||||
/// </summary>
|
||||
public string Query { get; set; } = string.Empty;
|
||||
|
||||
/// <summary>
|
||||
/// The UTC date and time when this result was executed/opened.
|
||||
/// </summary>
|
||||
public DateTime ExecutedDateTime { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of <see cref="LastOpenedHistoryResult"/>.
|
||||
/// Sets <see cref="OriginQuery"/> using the current <see cref="Query"/> value, because OriginQuery is not serialized.
|
||||
/// </summary>
|
||||
public LastOpenedHistoryResult()
|
||||
{
|
||||
this.OriginQuery = new Query { TrimmedQuery = Query };
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a <see cref="LastOpenedHistoryResult"/> from an existing <see cref="Result"/>.
|
||||
/// Copies required fields and sets up default reopening actions.
|
||||
/// </summary>
|
||||
/// <param name="result">The original result to create history from.</param>
|
||||
public LastOpenedHistoryResult(Result result)
|
||||
{
|
||||
Title = result.Title;
|
||||
|
|
@ -39,6 +59,10 @@ public class LastOpenedHistoryResult : Result
|
|||
AsyncAction = null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a deep copy of <see cref="LastOpenedHistoryResult"/>.
|
||||
/// </summary>
|
||||
/// <returns>A new <see cref="LastOpenedHistoryResult"/> containing the same required data.</returns>
|
||||
public LastOpenedHistoryResult Copy()
|
||||
{
|
||||
|
||||
|
|
@ -59,6 +83,12 @@ public class LastOpenedHistoryResult : Result
|
|||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determines whether the specified <see cref="Result"/> is equivalent to this history result.
|
||||
/// Comparison uses <see cref="Result.RecordKey"/> when available; otherwise falls back to title/subtitle/plugin id and query.
|
||||
/// </summary>
|
||||
/// <param name="r">The result to compare to.</param>
|
||||
/// <returns><c>true</c> if the results are considered equal; otherwise <c>false</c>.</returns>
|
||||
public bool Equals(Result r)
|
||||
{
|
||||
if (string.IsNullOrEmpty(RecordKey) || string.IsNullOrEmpty(r.RecordKey))
|
||||
|
|
|
|||
Loading…
Reference in a new issue