Lyo.Tag 3.0.0

Lyo.Tag

Contracts for hanging tags on entities. The target is an EntityRef, and the person or system that applied the tag is an optional second EntityRef. A feature can attach tags without tying them through a foreign key.

ITagStore

• AddTagAsync(EntityRef forEntity, string tag, string tagType = "tag", EntityRef? fromEntity = null, string? slug = null, CancellationToken ct = default) writes a tag. The same (forEntity, tag, tagType, slug) tuple is a no-op if it already exists. A null or whitespace slug becomes empty. Leave fromEntity off and the well-known system actor is recorded.
• RemoveTagAsync(EntityRef forEntity, string tag, string tagType = "tag", string? slug = null, CancellationToken ct = default) drops the matching assignment. The slug you pass has to match what was stored, including empty when nothing was stored.
• GetTagsForEntityAsync(EntityRef forEntity, string? tagType = null, CancellationToken ct = default) lists every TagRecord on that entity. Pass tagType to narrow the result.
• GetEntitiesWithTagAsync(string tag, string? forEntityType = null, string? tagType = null, CancellationToken ct = default) lists every entity that carries that tag value. Entity type and tag type filters are optional.
• GetAllTagsForEntityTypeAsync(string forEntityType, string? tagType = null, CancellationToken ct = default) lists the distinct tag values used on any entity of that type.

GetTopTagsAsync(int take, TagSort sortBy = TagSort.Count, SortDirection direction = SortDirection.Desc, string? forEntityType = null, string? tagType = null, string? name = null, string? text = null, int skip = 0, CancellationToken ct = default) returns each tag name and tag type with how many active assignments use that pair. take must be at least 1. skip defaults to 0 and must not be negative, so GetTopTagsAsync(10, skip: 10) is the next page of 10. Sort by count or name, ascending or descending. Defaults are count, descending, so GetTopTagsAsync(10) is the top 10 by usage. Name ascending is GetTopTagsAsync(10, TagSort.Name, SortDirection.Asc). Count sorts break ties by name, then tag type. Name sorts break ties by tag type. The tie-break does not follow the requested direction. Pass forEntityType, tagType, or name to count only that slice. Pass text to keep rows whose name or tag type contains that text, ignoring case, so GetTopTagsAsync(10, text: "alp") can return both alpha and alpine. A null or whitespace tagType, name, or text applies no filter. Soft-deleted rows are excluded.

• RemoveAllTagsForEntityAsync(EntityRef forEntity, CancellationToken ct = default) soft-deletes every tag assignment on that entity.

TagCount

• Name. Display text for the tag, such as "urgent".
• TagType. Namespace discriminator grouped with Name. Default assignments use "tag".
• Count. Active assignment rows for that name and tag type. Soft-deleted rows are not included.

TagSort

• Count. Order by how many active assignments use the tag.
• Name. Order by the tag name.

TagRecord

• Name. Display text for the tag, such as "urgent".
• TagType. Namespace discriminator. Default is "tag". Other usual values include "category" and "label".
• Slug. Optional slug suitable for URLs. Empty if none was given.
• SubjectRef / ActorRef. Projected as EntityRef.

Dependencies

Generated from ProjectReference / PackageReference (same model as docs/Lyo.ProjectGraph.html).

• Lyo.Common.Core (direct, lyo)
• Lyo.EntityReference.Models (direct, lyo)
• Lyo.Exceptions (transitive, lyo)
• Microsoft.Bcl.AsyncInterfaces 10.0.5 (transitive, microsoft, netstandard2.0)
• System.Memory 4.6.3 (transitive, microsoft, netstandard2.0)
• System.Text.Json 10.0.5 (transitive, microsoft, netstandard2.0)