Interface IFavourite
The system entity for favourites
Inherited Members
System.IEquatable<LemonEdge.API.Core.IBaseEntity>.Equals(LemonEdge.API.Core.IBaseEntity)
System.ComponentModel.INotifyPropertyChanged.PropertyChanged
System.ComponentModel.INotifyPropertyChanging.PropertyChanging
Namespace: LemonEdge.API.Entities
Assembly: API.dll
Syntax
[EntityDefinition(EntityID.Favourite, "dbo.LT_Favourites", "Favourite", LabelColumn = "Name", IsStandingDataEntity = true)]
[DefaultEntityIcon(ImageType.Canvas)]
public interface IFavourite : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties
Properties
CustomLayoutID
Links to ILayout. Any custom layout to apply to this item when being displayed.
Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.Layouts, "ID", SingleJoinType.ZeroToOne, "Custom Layout", "Favourites", DeleteWithRelationship = true, PartOfParentSet = false, LinkToItemInSet = false, InheritPermissions = false, PreventAutoConstraint = false)]
[EntityDescription("Any custom layout to apply to this item when being displayed.")]
Guid? CustomLayoutID { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
FavouriteID
[Key] The globally unique id of the entity (of type FavouriteTypeID) being linked to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityDescription("The item itself.")]
Guid FavouriteID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
FavouriteTypeID
[Key] The type of entity that is being linked to
Declaration
[EntityProperty(SQLType.UniqueIdentifier, false, IsEntityTypeLink = true)]
[EntityDescription("The type of item.")]
Guid FavouriteTypeID { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Name
The name of the item being linked to by this favourite entity. Usually just the label from the entity as defined by LabelColumn
Declaration
[EntityProperty(SQLType.NVarChar, (short)500, false)]
[EntityDescription("The name of the item being linked to.")]
[Required]
string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |