Skip to content

PluginAttribute

Summary

Sealed class PluginAttribute.

Remarks

Marks a class as a Plugin. The Plugin attribute cannot be omitted.

Signature 

1
public sealed class PluginAttribute : Attribute

Namespace

cAlgo.API

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
 using cAlgo.API;
 namespace cAlgo.Plugins
 {
     // This sample plugin shows how to use the Plugin attribute and its properties
     // Every Plugin must be annotated with this attribute
     [Plugin(TimeZone = TimeZones.UTC, AccessRights = AccessRights.None)]
     public class PluginAttributeSample : Plugin
     {
     }
 }

Properties

TimeZone

Summary

Sets the timezone for all the Plugin datetime references

Remarks

All dates and times within the Plugin will be converted to this timezone

Signature 

1
public string TimeZone {get; set;}

Return Value

string

Examples

1
2
 [Plugin(TimeZone = TimeZones.EasternStandardTime)]
 public class NewPlugin : Plugin

AccessRights

Summary

Gets or sets the access rights required for the Plugin.

Signature 

1
public AccessRights AccessRights {get; set;}

Return Value

AccessRights

Related Tutorials

AdditionalInfoUrl

Summary

Gets or sets additional info url.

Signature 

1
public string AdditionalInfoUrl {get; set;}

Return Value

string

Examples

1
2
 [Robot(AdditionalInfoUrl = "https://ctrader.com/")]  
 public class AdditionalInfoUrlExampleBot : Robot