|
| 1 | +<!DOCTYPE html> |
| 2 | +<html> |
| 3 | + <head> |
| 4 | + <meta charset="utf-8"> |
| 5 | + <title>UOF .NET SDK - Migration Guide | Sportradar.OddsFeed.SDK </title> |
| 6 | + <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 7 | + <meta name="title" content="UOF .NET SDK - Migration Guide | Sportradar.OddsFeed.SDK "> |
| 8 | + |
| 9 | + |
| 10 | + <link rel="icon" href="../images/favicon.ico"> |
| 11 | + <link rel="stylesheet" href="../public/docfx.min.css"> |
| 12 | + <link rel="stylesheet" href="../public/main.css"> |
| 13 | + <meta name="docfx:navrel" content="../toc.html"> |
| 14 | + <meta name="docfx:tocrel" content="toc.html"> |
| 15 | + |
| 16 | + <meta name="docfx:rel" content="../"> |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | + <meta name="loc:inThisArticle" content="In this article"> |
| 21 | + <meta name="loc:searchResultsCount" content="{count} results for "{query}""> |
| 22 | + <meta name="loc:searchNoResults" content="No results for "{query}""> |
| 23 | + <meta name="loc:tocFilter" content="Filter by title"> |
| 24 | + <meta name="loc:nextArticle" content="Next"> |
| 25 | + <meta name="loc:prevArticle" content="Previous"> |
| 26 | + <meta name="loc:themeLight" content="Light"> |
| 27 | + <meta name="loc:themeDark" content="Dark"> |
| 28 | + <meta name="loc:themeAuto" content="Auto"> |
| 29 | + <meta name="loc:changeTheme" content="Change theme"> |
| 30 | + <meta name="loc:copy" content="Copy"> |
| 31 | + <meta name="loc:downloadPdf" content="Download PDF"> |
| 32 | + |
| 33 | + <script type="module" src="./../public/docfx.min.js"></script> |
| 34 | + |
| 35 | + <script> |
| 36 | + const theme = localStorage.getItem('theme') || 'auto' |
| 37 | + document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) |
| 38 | + </script> |
| 39 | + |
| 40 | + </head> |
| 41 | + |
| 42 | + <body class="tex2jax_ignore" data-layout="" data-yaml-mime=""> |
| 43 | + <header class="bg-body border-bottom"> |
| 44 | + <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> |
| 45 | + <div class="container-xxl flex-nowrap"> |
| 46 | + <a class="navbar-brand" href="../index.html"> |
| 47 | + <img id="logo" class="svg" src="../images/uf-ns-h60.png" alt="Sportradar.OddsFeed.SDK"> |
| 48 | + Sportradar.OddsFeed.SDK |
| 49 | + </a> |
| 50 | + <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> |
| 51 | + <i class="bi bi-three-dots"></i> |
| 52 | + </button> |
| 53 | + <div class="collapse navbar-collapse" id="navpanel"> |
| 54 | + <div id="navbar"> |
| 55 | + <form class="search" role="search" id="search"> |
| 56 | + <i class="bi bi-search"></i> |
| 57 | + <input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search"> |
| 58 | + </form> |
| 59 | + </div> |
| 60 | + </div> |
| 61 | + </div> |
| 62 | + </nav> |
| 63 | + </header> |
| 64 | + |
| 65 | + <main class="container-xxl"> |
| 66 | + <div class="toc-offcanvas"> |
| 67 | + <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> |
| 68 | + <div class="offcanvas-header"> |
| 69 | + <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> |
| 70 | + <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> |
| 71 | + </div> |
| 72 | + <div class="offcanvas-body"> |
| 73 | + <nav class="toc" id="toc"></nav> |
| 74 | + </div> |
| 75 | + </div> |
| 76 | + </div> |
| 77 | + |
| 78 | + <div class="content"> |
| 79 | + <div class="actionbar"> |
| 80 | + <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> |
| 81 | + <i class="bi bi-list"></i> |
| 82 | + </button> |
| 83 | + |
| 84 | + <nav id="breadcrumb"></nav> |
| 85 | + </div> |
| 86 | + |
| 87 | + <article data-uid=""> |
| 88 | +<h1 id="uof-net-sdk---migration-guide">UOF .NET SDK - Migration Guide</h1> |
| 89 | + |
| 90 | +<p>The UOF .NET SDK 2.x.x is upgraded to 3.0.0, and this is your roadmap to a smooth transition from your current SDK version to the latest version. The upgrade is designed to elevate your experience and |
| 91 | +align the SDK more closely with your business needs.</p> |
| 92 | +<p>This guide is intended to offer practical advice to ensure your transition is not only efficient but also enhances the performance and capabilities of your software.</p> |
| 93 | +<h2 id="1-upgraded-dependencies">1. Upgraded dependencies</h2> |
| 94 | +<ul> |
| 95 | +<li>RabbitMQ.Client 6.8.1</li> |
| 96 | +<li>Dawn.Guard 1.12.0</li> |
| 97 | +<li>Humanizer 2.14.1</li> |
| 98 | +<li>Microsoft.Bcl.AsyncInterfaces 9.0.1</li> |
| 99 | +<li>Microsoft.Extensions.Caching.Memory 9.0.1</li> |
| 100 | +<li>Microsoft.Extensions.Configuration 9.0.1</li> |
| 101 | +<li>Microsoft.Extensions.DependencyInjection 9.0.1</li> |
| 102 | +<li>Microsoft.Extensions.Diagnostics.HealthChecks 9.0.1</li> |
| 103 | +<li>Microsoft.Extensions.Http 9.0.1</li> |
| 104 | +<li>System.Configuration.ConfigurationManager 9.0.1</li> |
| 105 | +<li>OpenTelemetry 1.11.1</li> |
| 106 | +<li>OpenTelemetry.Extensions.Hosting 1.11.1</li> |
| 107 | +<li>OpenTelemetry.Instrumentation.Runtime 1.10.0 (added)</li> |
| 108 | +<li>OpenTelemetry.Exporter.OpenTelemetryProtocol 1.11.1 (added)</li> |
| 109 | +<li>Removed: OpenTelemetry.Api</li> |
| 110 | +</ul> |
| 111 | +<h2 id="2-update-the-methods-and-classes-in-your-code">2. Update the Methods and Classes in Your Code</h2> |
| 112 | +<p>Review your codebase to identify any parts that might be affected by the upgrade. Look for deprecated methods or classes that have been removed in the new version. Update your code to use the new APIs |
| 113 | +provided by the SDK. This may involve making changes to method calls, imports, and references. Handle any breaking changes or deprecations by updating your code accordingly. You can |
| 114 | +contact support if you encounter specific issues.</p> |
| 115 | +<p>The following classes and methods are changed. Hence, you will need to update your code to use the new names:</p> |
| 116 | +<h4 id="removed-methods-classes-and-interfaces">Removed Methods, Classes and Interfaces</h4> |
| 117 | +<table> |
| 118 | +<thead> |
| 119 | +<tr> |
| 120 | +<th>Removed Methods / Classes / Interfaces</th> |
| 121 | +<th>Alternative Methods / Classes / Interfaces</th> |
| 122 | +</tr> |
| 123 | +</thead> |
| 124 | +<tbody> |
| 125 | +<tr> |
| 126 | +<td>ISoccerEvent</td> |
| 127 | +<td>IMatch</td> |
| 128 | +</tr> |
| 129 | +<tr> |
| 130 | +<td>ISoccerStatistics</td> |
| 131 | +<td>IMatchStatistics</td> |
| 132 | +</tr> |
| 133 | +<tr> |
| 134 | +<td>ISoccerStatus</td> |
| 135 | +<td>IMatchStatus</td> |
| 136 | +</tr> |
| 137 | +<tr> |
| 138 | +<td>ICalculationFilterV1</td> |
| 139 | +<td>ICalculationFilter</td> |
| 140 | +</tr> |
| 141 | +<tr> |
| 142 | +<td>ICalculationV1</td> |
| 143 | +<td>ICalculation</td> |
| 144 | +</tr> |
| 145 | +<tr> |
| 146 | +<td>ICustomBetSelectionBuilderV1</td> |
| 147 | +<td>ICustomBetSelectionBuilder</td> |
| 148 | +</tr> |
| 149 | +<tr> |
| 150 | +<td>IMatchStatusV1</td> |
| 151 | +<td>IMatchStatus</td> |
| 152 | +</tr> |
| 153 | +<tr> |
| 154 | +<td>ISelectionV1</td> |
| 155 | +<td>ISelection</td> |
| 156 | +</tr> |
| 157 | +</tbody> |
| 158 | +</table> |
| 159 | +<h4 id="removed-methods--properties">Removed Methods / Properties</h4> |
| 160 | +<table> |
| 161 | +<thead> |
| 162 | +<tr> |
| 163 | +<th>Method / Property name</th> |
| 164 | +<th>Recommendation</th> |
| 165 | +</tr> |
| 166 | +</thead> |
| 167 | +<tbody> |
| 168 | +<tr> |
| 169 | +<td>ExportableCompetition.CompetitorsVirtual</td> |
| 170 | +<td>Use Competitor.IsVirtual property to identify virtual competitors</td> |
| 171 | +</tr> |
| 172 | +<tr> |
| 173 | +<td>ICustomBetSelectionBuilder.Build(Urn eventId, int marketId, string specifiers, string outcomeId)</td> |
| 174 | +<td>Use ICustomBetSelectionBuilder.Build(Urn eventId, int marketId, string specifiers, string outcomeId, double? odds = null)</td> |
| 175 | +</tr> |
| 176 | +<tr> |
| 177 | +<td>IRecoveryConfigurationBuilder.SetAdjustAfterAge(bool adjustAfterAge)</td> |
| 178 | +<td>internally always true</td> |
| 179 | +</tr> |
| 180 | +<tr> |
| 181 | +<td>IUofProducerConfiguration.AdjustAfterAge</td> |
| 182 | +<td>internally always true</td> |
| 183 | +</tr> |
| 184 | +</tbody> |
| 185 | +</table> |
| 186 | +<h4 id="updated-methods--properties">Updated Methods / Properties</h4> |
| 187 | +<table> |
| 188 | +<thead> |
| 189 | +<tr> |
| 190 | +<th>Method / Property name</th> |
| 191 | +<th>Recommendation</th> |
| 192 | +</tr> |
| 193 | +</thead> |
| 194 | +<tbody> |
| 195 | +<tr> |
| 196 | +<td>ICompetitor.IsVirtual</td> |
| 197 | +<td>Check it to be true to confirm that the competitor is virual. Consider all other values as an indicator that the competitor is not virtual</td> |
| 198 | +</tr> |
| 199 | +</tbody> |
| 200 | +</table> |
| 201 | +<h4 id="renamed-methods--properties">Renamed Methods / Properties</h4> |
| 202 | +<ul> |
| 203 | +<li>IAvailableSelections.Event to EventId</li> |
| 204 | +<li>IAvailableSelectionsFilter.Event to EventId</li> |
| 205 | +</ul> |
| 206 | +<h4 id="new-features">New Features</h4> |
| 207 | +<p>SDK Usage Service: This service will allow us to anonymously track producer downtrends, helping us proactively identify potential bottlenecks and broader implementation trends before they lead to |
| 208 | +future issues.</p> |
| 209 | +<p>New configuration properties:</p> |
| 210 | +<ul> |
| 211 | +<li>IUofUsageConfiguration exposed as IUofConfiguration.Usage for properties configuring usage export (metrics)</li> |
| 212 | +<li>IUofConfiguration.Usage.IsExportEnabled (default: enabled)</li> |
| 213 | +<li>Added IConfigurationBuilder.EnableUsageExport(bool enable) method</li> |
| 214 | +</ul> |
| 215 | +<h2 id="5-test-your-project">5. Test your project</h2> |
| 216 | +<p>Thoroughly test your project after making the changes. Test all critical functionality to ensure that everything still works as expected. Pay special attention to any areas of your setup that interact |
| 217 | +with the SDK, as these are likely to be the most affected by the upgrade.</p> |
| 218 | +<h2 id="6-update-the-documentation">6. Update the Documentation</h2> |
| 219 | +<p>Update your project's documentation and any training materials to reflect the changes introduced by the upgrade. This will help your team members understand and work with the new version.</p> |
| 220 | +<h2 id="7-deploy-to-production">7. Deploy to Production</h2> |
| 221 | +<p>Once you are confident that your project works correctly with the upgraded SDK, you can deploy the updated version to your production environment.</p> |
| 222 | +<h2 id="8-monitoring-and-maintenance">8. Monitoring and Maintenance</h2> |
| 223 | +<p>After deployment, monitor your project closely for any unexpected issues or performance problems. Be prepared to address any post-upgrade issues promptly.</p> |
| 224 | +<h2 id="9-feedback-and-reporting">9. Feedback and Reporting</h2> |
| 225 | +<p>If you encounter any bugs or issues in the SDK, consider reporting them to [email protected]. Providing feedback can help improve the SDK for future releases. </p> |
| 226 | + |
| 227 | +</article> |
| 228 | + |
| 229 | + <div class="contribution d-print-none"> |
| 230 | + </div> |
| 231 | + |
| 232 | + <div class="next-article d-print-none border-top" id="nextArticle"></div> |
| 233 | + |
| 234 | + </div> |
| 235 | + |
| 236 | + <div class="affix"> |
| 237 | + <nav id="affix"></nav> |
| 238 | + </div> |
| 239 | + </main> |
| 240 | + |
| 241 | + <div class="container-xxl search-results" id="search-results"></div> |
| 242 | + |
| 243 | + <footer class="border-top text-secondary"> |
| 244 | + <div class="container-xxl"> |
| 245 | + <div class="flex-fill"> |
| 246 | + Copyright © 2024, Sportradar AG. Send comments or questions to <a href='mailto:sdk%40sportradar.com?Subject=Odds%20Feed%20SDK%20Std%20Documentation: UnifiedFeed SDK .NET Standard 2.0&body=Your%20feedback%20is%20used%20to%20improve%20the%20documentation%20and%20the%20product.%20Your%20e-mail%20address%20will%20not%20be%20used%20for%20any%20other%20purpose%20and%20is%20disposed%20of%20after%20the%20issue%20you%20report%20is%20resolved.%20While%20working%20to%20resolve%20the%20issue%20that%20you%20report%2C%20you%20may%20be%20contacted%20via%20e-mail%20to%20get%20further%20details%20or%20clarification%20on%20the%20feedback%20you%20sent.%20After%20the%20issue%20you%20report%20has%20been%20addressed%2C%20you%20may%20receive%20an%20e-mail%20to%20let%20you%20know%20that%20your%20feedback%20has%20been%20addressed.'>SDK Team</a>. |
| 247 | + </div> |
| 248 | + </div> |
| 249 | + </footer> |
| 250 | + </body> |
| 251 | +</html> |
0 commit comments