Interface IHistoryCollection
Interface for an object representing a collection of command history.
Namespace: SociallyDistant.Core.Core.Scripting
Assembly: SociallyDistant.Framework.dll
Syntax
public interface IHistoryCollection : IReadOnlyCollection<string>, IEnumerable<string>, IEnumerableProperties
HasChanged
Gets a value indicating whether the history has been modified and should be saved.
Declaration
bool HasChanged { get; }Property Value
| Type | Description |
|---|---|
| bool |
this[int]
Gets or sets the value of an item in the history collection.
Declaration
string this[int index] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index of the item to access. |
Property Value
| Type | Description |
|---|---|
| string |
Methods
Add(string)
Adds the specified string of text to the end of the history collection, making it the most recent entry.
Declaration
void Add(string commandLine)Parameters
| Type | Name | Description |
|---|---|---|
| string | commandLine |
Clear()
Clearws all command history.
Declaration
void Clear()GetFromHistory(int)
Gets the value of a history entry that is amount entries behind the most-recent one.
Declaration
string GetFromHistory(int amount)Parameters
| Type | Name | Description |
|---|---|---|
| int | amount | The amount of elements to look back in the collection. |
Returns
| Type | Description |
|---|---|
| string | The value of the item at that point in history, or an empty string if none were found. |
Save()
Saves command history.
Declaration
Task Save()Returns
| Type | Description |
|---|---|
| Task |