Skip to content

Commit 3693ea0

Browse files
committed
Marked legacy ITopicRoutingService as [Obsolete]
The `ITopicRoutingService` is used by the **OnTopic-WebForms** and **OnTopic-MVC** projects as a way of determining the current topic based on the routing information. This approach was replaced with library-specific internal methods, such as **OnTopic-AspNetCore-MVC**'s `ITopicRepository` extension which allows `Load()` to accept a `RouteData` object. Further, we don't intend to provide support for this in future front-end libraries. Since **OnTopic-WebForms** is already obsolete, and **OnTopic-MVC** isn't expected to be upgraded to support **OnTopic 5.0**, we're marking this as `[Obsolete]`.
1 parent 04f4fd0 commit 3693ea0

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

OnTopic/ITopicRoutingService.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
| Client Ignia, LLC
44
| Project Topics Library
55
\=============================================================================================================================*/
6+
using System;
67

78
namespace OnTopic {
89

@@ -17,6 +18,11 @@ namespace OnTopic {
1718
/// adapter to framework-specific libraries (e.g., <code>HttpContext</code>). In addition, custom versions may be created
1819
/// in order to establish custom mappings between URL or route data and the hierarchy of topics, should the need arise.
1920
/// </remarks>
21+
[Obsolete(
22+
"The ITopicRoutingService is no longer used in the latest clients, and will be removed in OnTopic Library 5.0. In the " +
23+
"latest OnTopic.AspNetCore.Mvc libraries, it is replaced with a ITopicRepository.Load() extension method which accepts " +
24+
"RouteData as an argument, in order to lookup topics based on that library's routing conventions."
25+
)]
2026
public interface ITopicRoutingService {
2127

2228
/*==========================================================================================================================

0 commit comments

Comments
 (0)