FavoriteTimeFrames
Summary
Provides access to favorite TimeFrames API for plugins.
Signature
| public abstract interface FavoriteTimeFrames
|
Namespace
cAlgo.API
Examples
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 | using cAlgo.API;
using System.Linq;
namespace cAlgo.Plugins;
[Plugin(AccessRights = AccessRights.None)]
public class Test : Plugin
{
protected override void OnStart()
{
TimeFrameManager.Favorite.Added += args => Print($"Favorite TimeFrames added: {string.Join(", ", args.TimeFrames.Select(timeFrame => timeFrame.Name))}");
TimeFrameManager.Favorite.Removed += args => Print($"Favorite TimeFrames removed: {string.Join(", ", args.TimeFrames.Select(timeFrame => timeFrame.Name))}");
TimeFrameManager.Favorite.Add(TimeFrame.Daily);
TimeFrameManager.Favorite.Add(TimeFrame.Range1);
TimeFrameManager.Favorite.Add(TimeFrame.Range100);
Print($"Is Range100 on Favorite TimeFrames: {TimeFrameManager.Favorite.Contains(TimeFrame.Range100)}");
TimeFrameManager.Favorite.Remove(TimeFrame.Range100);
}
}
|
See Also
Methods
Add
Summary
Adds a time frame to favorite TimeFrames.
Signature
| public abstract void Add(TimeFrame timeFrame)
|
Parameters
| Name | Type | Description |
| timeFrame | TimeFrame | TimeFrame |
Return Value
void
Remove
Summary
Removes a time frame from favorite TimeFrames.
Signature
| public abstract bool Remove(TimeFrame timeFrame)
|
Parameters
| Name | Type | Description |
| timeFrame | TimeFrame | TimeFrame |
Return Value
bool
Contains
Summary
Returns True if passed TimeFrame is in favorite TimeFrames otherwise False.
Signature
| public abstract bool Contains(TimeFrame timeFrame)
|
Parameters
| Name | Type | Description |
| timeFrame | TimeFrame | TimeFrame |
Return Value
bool
Events
Added
Summary
Occurs when new TimeFrames are added to favorite TimeFrames.
Signature
| public abstract event Action<FavoriteTimeFramesAddedEventArgs> Added;
|
Removed
Summary
Occurs when TimeFrames are removed from favorite TimeFrames.
Signature
| public abstract event Action<FavoriteTimeFramesRemovedEventArgs> Removed;
|