Interface IAddIn
The system entity for addins
See https://web.lemonedge.com/help/addin-view/ for more information
Inherited Members
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.AddIns, "dbo.LT_AddIns", "AddIn", LabelColumn = "Name", IsStandingDataEntity = true)]
[DefaultEntityIcon(ImageType.AddIn)]
public interface IAddIn : IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
Active
Indicates whether or not this AddIn is active and should be loaded by the LemonEdge platform. Inactive AddIns are ignored.
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this dll is active and will be loaded into all runtimes of the applciation (all clients, service, tasks) unless specific UI selections are made.")]
bool Active { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AddInData
Holds the actuall raw .net custom dll.
Declaration
[EntityProperty(SQLType.VarBinary, false)]
[EntityDescription("Holds the actuall raw .net custom dll.")]
byte[] AddInData { get; set; }
Property Value
Type | Description |
---|---|
System.Byte[] |
AddInModuleID
Links to IAddInModule. The parent module this add in belongs to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.AddInModules, "ID", SingleJoinType.One, "AddIns", "AddInModules", DeleteWithRelationship = true, PartOfParentSet = true, LinkToItemInSet = true, InheritPermissions = true)]
Guid AddInModuleID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Description
A user friendly description of this add in
Declaration
[EntityProperty(SQLType.NVarChar, (short)2000, true)]
[EntityDescription("A user friendly description of this AddIns function.")]
string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String |
IsConsoleOnlyUI
Indicates this contains UI code that can only be shown by the console application and thus will only be loaded by that client application. If you create a custom view you will need to create that custom view for all client applications that will need to access it.
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this dll has view components for the .net core console, and will *only* be loaded in that client app.")]
[PropertyValidation("MyItem.IsConsoleOnlyUI == true", "MyItem.IsWPFOnlyUI == false && MyItem.IsXamarinOnlyUI == false && MyItem.IsCore == false", "Console UI can only be marked as true if WPF and Xamarin are false.")]
bool IsConsoleOnlyUI { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsCore
Indicates this dll is core and should be loaded in all services/clients/etc as it contains entity class definitions, processes and core functionality.
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this dll is core and should be loaded in all services/clients/etc as it contains entity class definitions, processes and core functionality.")]
[PropertyValidation("MyItem.IsCore == true", "MyItem.IsWPFOnlyUI == false && MyItem.IsXamarinOnlyUI == false && MyItem.IsConsoleOnlyUI == false", "Is Core can only be marked as true if WPF and Xamarin UI are false.")]
bool IsCore { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsCoreUI
Indicates this dll has core UI implementations and should be loaded in all clients applications (android/ios/console/windows/etc).
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this dll has core UI implementations and should be loaded in all clients applications (android/ios/console/windows/etc).")]
[PropertyValidation("MyItem.IsCoreUI == true", "MyItem.IsCore == false", "Is Core UI can only be marked as true if IsCore is set to false. Core UI dlls can not be loaded into services/etc.")]
[PropertyValidation("MyItem.IsCoreUI == true", "MyItem.IsWPFOnlyUI == false && MyItem.IsXamarinOnlyUI == false && MyItem.IsConsoleOnlyUI == false", "Is Core UI can only be marked as true if individual UI's are false. Is Core UI indicates they will be loaded into all clients (xamarin/console/wpf) regardless.")]
bool IsCoreUI { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsWPFOnlyUI
Indicates this contains UI code that can only be shown by the WPF Windows only application and thus will only be loaded by that client application. If you create a custom view you will need to create that custom view for all client applications that will need to access it.
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this dll has view components for the WPF client, and will *only* be loaded in that client app.")]
[PropertyValidation("MyItem.IsWPFOnlyUI == true", "MyItem.IsXamarinOnlyUI == false && MyItem.IsConsoleOnlyUI == false && MyItem.IsCore == false", "WPF UI can only be marked as true if Xamarin, Console and IsCore are false.")]
bool IsWPFOnlyUI { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsXamarinOnlyUI
Indicates this contains UI code that can only be shown by the mobile xamarin application and thus will only be loaded by that client application. If you create a custom view you will need to create that custom view for all client applications that will need to access it.
Declaration
[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this dll has view components for the xamarin client, and will *only* be loaded in that mobile (iOS/Androind/Windows UWP) app.")]
[PropertyValidation("MyItem.IsXamarinOnlyUI == true", "MyItem.IsWPFOnlyUI == false && MyItem.IsConsoleOnlyUI == false && MyItem.IsCore == false", "Xamarin UI can only be marked as true if WPF, Console and IsCore are false.")]
bool IsXamarinOnlyUI { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
The unique friendly name of this add in
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The unique name of this AddIn.")]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Sequence
The sequence this AddIn is loaded in to the system relative to other addin within this AddIn Module.
Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("Holds the order of this AddIn within the module, that it is loaded in the system, so dependant AddIns can be loaded first.")]
[EntitySequence]
short Sequence { get; set; }
Property Value
Type | Description |
---|---|
System.Int16 |
SharedKey
If this dll is shared in more than one database that a service connects to at the same time, this key indicates its the same dll and prevents it being loaded twice or more.
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, true)]
[EntityDescription("If this dll is shared in more than one database that a service connects to at the same time, this key indicates it's the same dll and prevents it being loaded twice or more.")]
string SharedKey { get; set; }
Property Value
Type | Description |
---|---|
System.String |