docs: add xml comments for tenant modules
This commit is contained in:
@@ -11,6 +11,15 @@ namespace TakeoutSaaS.Domain.Tenants.Repositories;
|
||||
/// </summary>
|
||||
public interface ITenantAnnouncementRepository
|
||||
{
|
||||
/// <summary>
|
||||
/// 查询公告列表,按类型、启用状态与生效时间筛选。
|
||||
/// </summary>
|
||||
/// <param name="tenantId">租户 ID。</param>
|
||||
/// <param name="type">公告类型。</param>
|
||||
/// <param name="isActive">启用状态。</param>
|
||||
/// <param name="effectiveAt">生效时间点,为空不限制。</param>
|
||||
/// <param name="cancellationToken">取消标记。</param>
|
||||
/// <returns>公告集合。</returns>
|
||||
Task<IReadOnlyList<TenantAnnouncement>> SearchAsync(
|
||||
long tenantId,
|
||||
TenantAnnouncementType? type,
|
||||
@@ -18,13 +27,40 @@ public interface ITenantAnnouncementRepository
|
||||
DateTime? effectiveAt,
|
||||
CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// 按 ID 获取公告。
|
||||
/// </summary>
|
||||
/// <param name="tenantId">租户 ID。</param>
|
||||
/// <param name="announcementId">公告 ID。</param>
|
||||
/// <param name="cancellationToken">取消标记。</param>
|
||||
/// <returns>公告实体或 null。</returns>
|
||||
Task<TenantAnnouncement?> FindByIdAsync(long tenantId, long announcementId, CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// 新增公告。
|
||||
/// </summary>
|
||||
/// <param name="announcement">公告实体。</param>
|
||||
/// <param name="cancellationToken">取消标记。</param>
|
||||
Task AddAsync(TenantAnnouncement announcement, CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// 更新公告。
|
||||
/// </summary>
|
||||
/// <param name="announcement">公告实体。</param>
|
||||
/// <param name="cancellationToken">取消标记。</param>
|
||||
Task UpdateAsync(TenantAnnouncement announcement, CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// 删除公告。
|
||||
/// </summary>
|
||||
/// <param name="tenantId">租户 ID。</param>
|
||||
/// <param name="announcementId">公告 ID。</param>
|
||||
/// <param name="cancellationToken">取消标记。</param>
|
||||
Task DeleteAsync(long tenantId, long announcementId, CancellationToken cancellationToken = default);
|
||||
|
||||
/// <summary>
|
||||
/// 保存变更。
|
||||
/// </summary>
|
||||
/// <param name="cancellationToken">取消标记。</param>
|
||||
Task SaveChangesAsync(CancellationToken cancellationToken = default);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user