Interface IWatcher

The system entity for a watcher, which tracks interested parties against entities within the system

See https://web.lemonedge.com/help/watchers/ for more information

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.Watcher, "dbo.LT_Watchers", "Watcher")]
[DefaultEntityIcon(ImageType.Eye)]
public interface IWatcher : IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

EntityID

[Key] The globally unique id of the entity that this watcher is against

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
Guid EntityID { get; set; }
Property Value
Type Description
System.Guid

EntityTypeID

[Key] The type of entity that this watcher is against

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false, IsEntityTypeLink = true)]
Guid EntityTypeID { get; set; }
Property Value
Type Description
System.Guid

RoleID

[Key] Links to IRole. Optional - The Role (and thus all Users of the Role) that is watching this item

A User, Role or Team must be selected as a Watcher, though the rest can be blank

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.Roles, "ID", SingleJoinType.ZeroToOne, "Role", "Watchers", DeleteWithRelationship = true)]
[EntityDescription("The role to notify when this watcher is triggered.")]
Guid? RoleID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

TeamID

[Key] Links to ITeam. Optional - The Team (and thus all Users of the Team) that is watching this item

A User, Role or Team must be selected as a Watcher, though the rest can be blank

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.Teams, "ID", SingleJoinType.ZeroToOne, "Team", "Watchers", DeleteWithRelationship = true)]
[EntityDescription("The team to notify when this watcher is triggered.")]
Guid? TeamID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

UserID

[Key] Links to IUser. Optional - The User that is watching this item

A User, Role or Team must be selected as a Watcher, though the rest can be blank

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.Users, "ID", SingleJoinType.ZeroToOne, "User", "Watchers", DeleteWithRelationship = true)]
[EntityDescription("The individual user to notify when this watcher is triggered.")]
Guid? UserID { get; set; }
Property Value
Type Description
System.Nullable<System.Guid>

WatcherTypeID

[Key] Links to IWatcherType. The type of watcher

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityRelationship(EntityID.WatcherType, "ID", SingleJoinType.One, "Watcher Type", "Watchers", DeleteWithRelationship = true)]
[EntityDescription("The watcher type.")]
Guid WatcherTypeID { get; set; }
Property Value
Type Description
System.Guid

Extension Methods

See Also