Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
ackava committed Jun 22, 2022
1 parent 91a8e91 commit 7fa8870
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions NeuroSpeech.Eternity/Workflow.cs
Original file line number Diff line number Diff line change
Expand Up @@ -164,13 +164,13 @@ public static Task<string> CreateAsync(EternityContext context, TInput input, st

/// <summary>
/// This will preserve the workflow in the storage after it was successfully executed.
/// Default is 7 days.
/// Default is 5 minutes.
/// </summary>
public TimeSpan PreserveTime { get; set; } = TimeSpan.FromMinutes(5);

/// <summary>
/// This will preserve the workflow in the storge after it was failed.
/// Default is 30 days.
/// Default is 1 day.
/// </summary>
public TimeSpan FailurePreserveTime { get; set; } = TimeSpan.FromDays(1);

Expand All @@ -192,10 +192,25 @@ public static Task<string> CreateAsync(EternityContext context, TInput input, st
private EternityEntity _entity;
EternityEntity IWorkflow.Entity { get => _entity; set => _entity = value; }

/// <summary>
/// You can change priority, higher priority workflows are
/// executed first. You can change priority in the middle of execution
/// if you are going to wait for an event or add some delay.
/// Please call SaveaAync to save changes.
/// </summary>
public int Priority { get => _entity.Priority; set => _entity.Priority = value; }

/// <summary>
/// You can add/remove extra key value pairs associated with this workflow.
/// Please call SaveaAync to save changes.
/// </summary>
public IDictionary<string,string> Extra { get => _entity.ExtraDictionary; }

/// <summary>
/// Save Priority and other Extra key value pairs, you can retrive Extra
/// by calling GetStatusAsync method.
/// </summary>
/// <returns></returns>
public Task SaveAsync()
{
return Context.SaveAsync(this);
Expand Down

0 comments on commit 7fa8870

Please sign in to comment.