From bf4c48980f81e566065c07f3fe534ce7551ebdcc Mon Sep 17 00:00:00 2001
From: crupest <crupest@outlook.com>
Date: Thu, 29 Apr 2021 19:29:35 +0800
Subject: ...

---
 BackEnd/Timeline/Services/Api/ISearchService.cs | 33 +++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 BackEnd/Timeline/Services/Api/ISearchService.cs

(limited to 'BackEnd/Timeline/Services/Api/ISearchService.cs')

diff --git a/BackEnd/Timeline/Services/Api/ISearchService.cs b/BackEnd/Timeline/Services/Api/ISearchService.cs
new file mode 100644
index 00000000..d8b4bb44
--- /dev/null
+++ b/BackEnd/Timeline/Services/Api/ISearchService.cs
@@ -0,0 +1,33 @@
+using System;
+using System.Threading.Tasks;
+using Timeline.Entities;
+
+namespace Timeline.Services.Api
+{
+    public interface ISearchService
+    {
+        /// <summary>
+        /// Search timelines whose name or title contains query string.
+        /// </summary>
+        /// <param name="query">String to contain.</param>
+        /// <returns>Search results.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="query"/> is null.</exception>
+        /// <exception cref="ArgumentException">Thrown when <paramref name="query"/> is empty.</exception>
+        /// <remarks>
+        /// Implementation should promise high score is at first.
+        /// </remarks>
+        Task<SearchResult<TimelineEntity>> SearchTimelineAsync(string query);
+
+        /// <summary>
+        /// Search users whose username or nickname contains query string.
+        /// </summary>
+        /// <param name="query">String to contain.</param>
+        /// <returns>Search results.</returns>
+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="query"/> is null.</exception>
+        /// <exception cref="ArgumentException">Thrown when <paramref name="query"/> is empty.</exception>
+        /// <remarks>
+        /// Implementation should promise high score is at first.
+        /// </remarks>
+        Task<SearchResult<UserEntity>> SearchUserAsync(string query);
+    }
+}
-- 
cgit v1.2.3