Class Plugin
Namespace: Casewhere.Models
Assembly: Casewhere.Models.dll
Represents a plugin entity. Casewhere provides a flexible plugin framework to make it easy to extend your Casewhere solution with more functionalities. From simple tasks like sending emails to complex ones such as executing a SQL query, almost everything can be done using a Casewhere plugin. Casewhere plugins can be developed independently, installed on-demand, and invoked at runtime.
public class Plugin : Entity, IIdentity
Inheritance
Implements
IIdentity
Inherited Members
Entity.GetResourceName(), Entity.Id, Entity.Version, Entity.CreatedBy, Entity.CreatedAt, Entity.ModifiedBy, Entity.ModifiedAt, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()
Extension Methods
ObjectExtension.ConvertToBsonValue(object), EnumExtensions.DeepClone<Plugin>(Plugin)
Constructors
Plugin()
public Plugin()
Properties
ConfigurationFile
public string ConfigurationFile { get; set; }
Property Value
Description
Gets or sets the description of the plugin.
public string Description { get; set; }
Property Value
FileName
Gets the file name of the plugin.
[JsonIgnore]
public string FileName { get; }
Property Value
IsLocked
public bool IsLocked { get; set; }
Property Value
IsPublic
Gets or sets a value indicating whether the plugin is public.
public bool IsPublic { get; set; }
Property Value
Name
Gets or sets the name of the plugin.
public string Name { get; set; }
Property Value
PluginPolicies
Gets or sets the list of plugin policies.
public IList<PluginPolicy> PluginPolicies { get; set; }
Property Value
ProductId
public Guid ProductId { get; set; }
Property Value
Settings
Gets or sets the settings of the plugin. Plugin configuration in a text format, e.g., JSON, XML.
public string Settings { get; set; }
Property Value
SettingsFileName
Gets or sets the file name of the plugin settings.
public string SettingsFileName { get; set; }
Property Value
Tags
public IList<string> Tags { get; set; }
Property Value
Methods
GetFileName(string)
Gets the file name for the given plugin name.
public static string GetFileName(string name)
Parameters
name string
The name of the plugin.
Returns
The file name of the plugin.
GetResourceName()
Gets the display name of the entity.
public override string GetResourceName()
Returns
The display name of the entity.