< Summary

Class:Microsoft.Azure.CognitiveServices.Search.NewsSearch.NewsOperationsExtensions
Assembly:Microsoft.Azure.CognitiveServices.Search.BingNewsSearch
File(s):C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Search.BingNewsSearch\src\Generated\NewsSearch\NewsOperationsExtensions.cs
Covered lines:9
Uncovered lines:0
Coverable lines:9
Total lines:842
Line coverage:100% (9 of 9)
Covered branches:0
Total branches:0

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
SearchAsync()-100%100%
CategoryAsync()-100%100%
TrendingAsync()-100%100%

File(s)

C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Search.BingNewsSearch\src\Generated\NewsSearch\NewsOperationsExtensions.cs

#LineLine coverage
 1// <auto-generated>
 2// Code generated by Microsoft (R) AutoRest Code Generator.
 3// Changes may cause incorrect behavior and will be lost if the code is
 4// regenerated.
 5// </auto-generated>
 6
 7namespace Microsoft.Azure.CognitiveServices.Search.NewsSearch
 8{
 9    using Models;
 10    using System.Threading;
 11    using System.Threading.Tasks;
 12
 13    /// <summary>
 14    /// Extension methods for NewsOperations.
 15    /// </summary>
 16    public static partial class NewsOperationsExtensions
 17    {
 18            /// <summary>
 19            /// The News Search API lets you send a search query to Bing and get back a
 20            /// list of news that are relevant to the search query. This section provides
 21            /// technical details about the query parameters and headers that you use to
 22            /// request news and the JSON response objects that contain them.  For examples
 23            /// that show how to make requests, see [Searching the web for
 24            /// news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
 25            /// </summary>
 26            /// <param name='operations'>
 27            /// The operations group for this extension method.
 28            /// </param>
 29            /// <param name='query'>
 30            /// The user's search query string. The query string cannot be empty. The query
 31            /// string may contain [Bing Advanced
 32            /// Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example,
 33            /// to limit news to a specific domain, use the
 34            /// [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this
 35            /// parameter only with the News Search API. Do not specify this parameter when
 36            /// calling the Trending Topics API or News Category API.
 37            /// </param>
 38            /// <param name='acceptLanguage'>
 39            /// A comma-delimited list of one or more languages to use for user interface
 40            /// strings. The list is in decreasing order of preference. For additional
 41            /// information, including expected format, see
 42            /// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This
 43            /// header and the
 44            /// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang
 45            /// query parameter are mutually exclusive; do not specify both. If you set
 46            /// this header, you must also specify the
 47            /// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc)
 48            /// query parameter. To determine the market to return results for, Bing uses
 49            /// the first supported language it finds from the list and combines it with
 50            /// the cc parameter value. If the list does not include a supported language,
 51            /// Bing finds the closest language and market that supports the request or it
 52            /// uses an aggregated or default market for the results. To determine the
 53            /// market that Bing used, see the BingAPIs-Market header. Use this header and
 54            /// the cc query parameter only if you specify multiple languages. Otherwise,
 55            /// use the
 56            /// [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt)
 57            /// and
 58            /// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang
 59            /// query parameters. A user interface string is a string that's used as a
 60            /// label in a user interface. There are few user interface strings in the JSON
 61            /// response objects. Any links to Bing.com properties in the response objects
 62            /// apply the specified language.
 63            /// </param>
 64            /// <param name='userAgent'>
 65            /// The user agent originating the request. Bing uses the user agent to provide
 66            /// mobile users with an optimized experience. Although optional, you are
 67            /// encouraged to always specify this header. The user-agent should be the same
 68            /// string that any commonly used browser sends. For information about user
 69            /// agents, see [RFC
 70            /// 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
 71            /// following are examples of user-agent strings. Windows Phone: Mozilla/5.0
 72            /// (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM;
 73            /// Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5;
 74            /// en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like
 75            /// Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone;
 76            /// CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko)
 77            /// Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0
 78            /// (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad:
 79            /// Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1
 80            /// (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53
 81            /// </param>
 82            /// <param name='clientId'>
 83            /// Bing uses this header to provide users with consistent behavior across Bing
 84            /// API calls. Bing often flights new features and improvements, and it uses
 85            /// the client ID as a key for assigning traffic on different flights. If you
 86            /// do not use the same client ID for a user across multiple requests, then
 87            /// Bing may assign the user to multiple conflicting flights. Being assigned to
 88            /// multiple conflicting flights can lead to an inconsistent user experience.
 89            /// For example, if the second request has a different flight assignment than
 90            /// the first, the experience may be unexpected. Also, Bing can use the client
 91            /// ID to tailor web results to that client ID’s search history, providing a
 92            /// richer experience for the user. Bing also uses this header to help improve
 93            /// result rankings by analyzing the activity generated by a client ID. The
 94            /// relevance improvements help with better quality of results delivered by
 95            /// Bing APIs and in turn enables higher click-through rates for the API
 96            /// consumer. IMPORTANT: Although optional, you should consider this header
 97            /// required. Persisting the client ID across multiple requests for the same
 98            /// end user and device combination enables 1) the API consumer to receive a
 99            /// consistent user experience, and 2) higher click-through rates via better
 100            /// quality of results from the Bing APIs. Each user that uses your application
 101            /// on the device must have a unique, Bing generated client ID. If you do not
 102            /// include this header in the request, Bing generates an ID and returns it in
 103            /// the X-MSEdge-ClientID response header. The only time that you should NOT
 104            /// include this header in a request is the first time the user uses your app
 105            /// on that device. Use the client ID for each Bing API request that your app
 106            /// makes for this user on the device. Persist the client ID. To persist the ID
 107            /// in a browser app, use a persistent HTTP cookie to ensure the ID is used
 108            /// across all sessions. Do not use a session cookie. For other apps such as
 109            /// mobile apps, use the device's persistent storage to persist the ID. The
 110            /// next time the user uses your app on that device, get the client ID that you
 111            /// persisted. Bing responses may or may not include this header. If the
 112            /// response includes this header, capture the client ID and use it for all
 113            /// subsequent Bing requests for the user on that device. If you include the
 114            /// X-MSEdge-ClientID, you must not include cookies in the request.
 115            /// </param>
 116            /// <param name='clientIp'>
 117            /// The IPv4 or IPv6 address of the client device. The IP address is used to
 118            /// discover the user's location. Bing uses the location information to
 119            /// determine safe search behavior. Although optional, you are encouraged to
 120            /// always specify this header and the X-Search-Location header. Do not
 121            /// obfuscate the address (for example, by changing the last octet to 0).
 122            /// Obfuscating the address results in the location not being anywhere near the
 123            /// device's actual location, which may result in Bing serving erroneous
 124            /// results.
 125            /// </param>
 126            /// <param name='location'>
 127            /// A semicolon-delimited list of key/value pairs that describe the client's
 128            /// geographical location. Bing uses the location information to determine safe
 129            /// search behavior and to return relevant local content. Specify the key/value
 130            /// pair as &lt;key&gt;:&lt;value&gt;. The following are the keys that you use
 131            /// to specify the user's location. lat (required): The latitude of the
 132            /// client's location, in degrees. The latitude must be greater than or equal
 133            /// to -90.0 and less than or equal to +90.0. Negative values indicate southern
 134            /// latitudes and positive values indicate northern latitudes. long (required):
 135            /// The longitude of the client's location, in degrees. The longitude must be
 136            /// greater than or equal to -180.0 and less than or equal to +180.0. Negative
 137            /// values indicate western longitudes and positive values indicate eastern
 138            /// longitudes. re (required): The radius, in meters, which specifies the
 139            /// horizontal accuracy of the coordinates. Pass the value returned by the
 140            /// device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m
 141            /// for cell tower triangulation, and 18,000m for reverse IP lookup. ts
 142            /// (optional): The UTC UNIX timestamp of when the client was at the location.
 143            /// (The UNIX timestamp is the number of seconds since January 1, 1970.) head
 144            /// (optional): The client's relative heading or direction of travel. Specify
 145            /// the direction of travel as degrees from 0 through 360, counting clockwise
 146            /// relative to true north. Specify this key only if the sp key is nonzero. sp
 147            /// (optional): The horizontal velocity (speed), in meters per second, that the
 148            /// client device is traveling. alt (optional): The altitude of the client
 149            /// device, in meters. are (optional): The radius, in meters, that specifies
 150            /// the vertical accuracy of the coordinates. Specify this key only if you
 151            /// specify the alt key. Although many of the keys are optional, the more
 152            /// information that you provide, the more accurate the location results are.
 153            /// Although optional, you are encouraged to always specify the user's
 154            /// geographical location. Providing the location is especially important if
 155            /// the client's IP address does not accurately reflect the user's physical
 156            /// location (for example, if the client uses VPN). For optimal results, you
 157            /// should include this header and the X-MSEdge-ClientIP header, but at a
 158            /// minimum, you should include this header.
 159            /// </param>
 160            /// <param name='countryCode'>
 161            /// A 2-character country code of the country where the results come from. This
 162            /// API supports only the United States market. If you specify this query
 163            /// parameter, it must be set to us. If you set this parameter, you must also
 164            /// specify the Accept-Language header. Bing uses the first supported language
 165            /// it finds from the languages list, and combine that language with the
 166            /// country code that you specify to determine the market to return results
 167            /// for. If the languages list does not include a supported language, Bing
 168            /// finds the closest language and market that supports the request, or it may
 169            /// use an aggregated or default market for the results instead of a specified
 170            /// one. You should use this query parameter and the Accept-Language query
 171            /// parameter only if you specify multiple languages; otherwise, you should use
 172            /// the mkt and setLang query parameters. This parameter and the mkt query
 173            /// parameter are mutually exclusive—do not specify both.
 174            /// </param>
 175            /// <param name='count'>
 176            /// The number of news articles to return in the response. The actual number
 177            /// delivered may be less than requested. The default is 10 and the maximum
 178            /// value is 100. The actual number delivered may be less than requested.You
 179            /// may use this parameter along with the offset parameter to page results. For
 180            /// example, if your user interface displays 20 articles per page, set count to
 181            /// 20 and offset to 0 to get the first page of results. For each subsequent
 182            /// page, increment offset by 20 (for example, 0, 20, 40). It is possible for
 183            /// multiple pages to include some overlap in results.
 184            /// </param>
 185            /// <param name='freshness'>
 186            /// Filter news by the date and time that Bing discovered the news. The
 187            /// following are the possible filter values. Day: Return news discovered
 188            /// within the last 24 hours. Week: Return news discovered within the last 7
 189            /// days. Month: Return news discovered within the last 30 days. Use this
 190            /// parameter only with the News Search API. Do not specify this parameter when
 191            /// calling the News Category API or the Trending Topics API. Possible values
 192            /// include: 'Day', 'Week', 'Month'
 193            /// </param>
 194            /// <param name='market'>
 195            /// The market where the results come from. Typically, mkt is the country where
 196            /// the user is making the request from. However, it could be a different
 197            /// country if the user is not located in a country where Bing delivers
 198            /// results. The market must be in the form &lt;language code&gt;-&lt;country
 199            /// code&gt;. For example, en-US. The string is case insensitive. For a list of
 200            /// possible market values, see [Market
 201            /// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-cod
 202            /// NOTE: If known, you are encouraged to always specify the market. Specifying
 203            /// the market helps Bing route the request and return an appropriate and
 204            /// optimal response. If you specify a market that is not listed in [Market
 205            /// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-cod
 206            /// Bing uses a best fit market code based on an internal mapping that is
 207            /// subject to change. This parameter and the
 208            /// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc)
 209            /// query parameter are mutually exclusive—do not specify both.
 210            /// </param>
 211            /// <param name='offset'>
 212            /// The zero-based offset that indicates the number of news to skip before
 213            /// returning news. The default is 0. The offset should be less than
 214            /// ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-re
 215            /// - count). Use this parameter along with the count parameter to page
 216            /// results. For example, if your user interface displays 20 news per page, set
 217            /// count to 20 and offset to 0 to get the first page of results. For each
 218            /// subsequent page, increment offset by 20 (for example, 0, 20, 40). It is
 219            /// possible for multiple pages to include some overlap in results.
 220            /// </param>
 221            /// <param name='originalImage'>
 222            /// A Boolean value that determines whether the image's contentUrl contains a
 223            /// URL that points to a thumbnail of the original article's image or the image
 224            /// itself. If the article includes an image, and this parameter is set to
 225            /// true, the image's contentUrl property contains a URL that you may use to
 226            /// download the original image from the publisher's website. Otherwise, if
 227            /// this parameter is false, the image's contentUrl and thumbnailUrl URLs both
 228            /// point to the same thumbnail image. Use this parameter only with the News
 229            /// Search API. Do not specify this parameter when calling the Trending Topics
 230            /// API or News Category API.
 231            /// </param>
 232            /// <param name='safeSearch'>
 233            /// Filter news for adult content. The following are the possible filter
 234            /// values. Off: Return news articles with adult text, images, or videos.
 235            /// Moderate: Return news articles with adult text but not adult images or
 236            /// videos. Strict: Do not return news articles with adult text, images, or
 237            /// videos. If the request comes from a market that Bing's adult policy
 238            /// requires that safeSearch is set to Strict, Bing ignores the safeSearch
 239            /// value and uses Strict. If you use the site: query operator, there is the
 240            /// chance that the response may contain adult content regardless of what the
 241            /// safeSearch query parameter is set to. Use site: only if you are aware of
 242            /// the content on the site and your scenario supports the possibility of adult
 243            /// content. Possible values include: 'Off', 'Moderate', 'Strict'
 244            /// </param>
 245            /// <param name='setLang'>
 246            /// The language to use for user interface strings. Specify the language using
 247            /// the ISO 639-1 2-letter language code. For example, the language code for
 248            /// English is EN. The default is EN (English). Although optional, you should
 249            /// always specify the language. Typically, you set setLang to the same
 250            /// language specified by mkt unless the user wants the user interface strings
 251            /// displayed in a different language. This parameter and the
 252            /// [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference
 253            /// header are mutually exclusive; do not specify both. A user interface string
 254            /// is a string that's used as a label in a user interface. There are few user
 255            /// interface strings in the JSON response objects. Also, any links to Bing.com
 256            /// properties in the response objects apply the specified language.
 257            /// </param>
 258            /// <param name='sortBy'>
 259            /// The order to return the news in. The following are the possible
 260            /// case-insensitive values. Date: If the request is through the News Search
 261            /// API, the response returns news articles sorted by date from the most recent
 262            /// to the oldest. If the request is through the News Trending Topics API, the
 263            /// response returns trending topics sorted by date from the most recent to the
 264            /// oldest.
 265            /// </param>
 266            /// <param name='textDecorations'>
 267            /// A Boolean value that determines whether display strings contain decoration
 268            /// markers such as hit highlighting characters. If true, the strings may
 269            /// include markers. The default is false. To specify whether to use Unicode
 270            /// characters or HTML tags as the markers, see the
 271            /// [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#text
 272            /// query parameter. For information about hit highlighting, see [Hit
 273            /// Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
 274            /// </param>
 275            /// <param name='textFormat'>
 276            /// The type of markers to use for text decorations (see the textDecorations
 277            /// query parameter). Possible values are Raw—Use Unicode characters to mark
 278            /// content that needs special formatting. The Unicode characters are in the
 279            /// range E000 through E019. For example, Bing uses E000 and E001 to mark the
 280            /// beginning and end of query terms for hit highlighting. HTML—Use HTML tags
 281            /// to mark content that needs special formatting. For example, use &lt;b&gt;
 282            /// tags to highlight query terms in display strings. The default is Raw. For
 283            /// display strings that contain escapable HTML characters such as &lt;, &gt;,
 284            /// and &amp;, if textFormat is set to HTML, Bing escapes the characters as
 285            /// appropriate (for example, &lt; is escaped to &amp;lt;). Possible values
 286            /// include: 'Raw', 'Html'
 287            /// </param>
 288            /// <param name='cancellationToken'>
 289            /// The cancellation token.
 290            /// </param>
 291            public static async Task<News> SearchAsync(this INewsOperations operations, string query, string acceptLangu
 292            {
 2293                using (var _result = await operations.SearchWithHttpMessagesAsync(query, acceptLanguage, userAgent, clie
 294                {
 2295                    return _result.Body;
 296                }
 2297            }
 298
 299            /// <summary>
 300            /// The News Category API lets lets you search on Bing and get back a list of
 301            /// top news articles by category. This section provides technical details
 302            /// about the query parameters and headers that you use to request news and the
 303            /// JSON response objects that contain them.  For examples that show how to
 304            /// make requests, see [Searching the web for
 305            /// news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
 306            /// </summary>
 307            /// <param name='operations'>
 308            /// The operations group for this extension method.
 309            /// </param>
 310            /// <param name='acceptLanguage'>
 311            /// A comma-delimited list of one or more languages to use for user interface
 312            /// strings. The list is in decreasing order of preference. For additional
 313            /// information, including expected format, see
 314            /// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This
 315            /// header and the
 316            /// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang
 317            /// query parameter are mutually exclusive; do not specify both. If you set
 318            /// this header, you must also specify the
 319            /// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc)
 320            /// query parameter. To determine the market to return results for, Bing uses
 321            /// the first supported language it finds from the list and combines it with
 322            /// the cc parameter value. If the list does not include a supported language,
 323            /// Bing finds the closest language and market that supports the request or it
 324            /// uses an aggregated or default market for the results. To determine the
 325            /// market that Bing used, see the BingAPIs-Market header. Use this header and
 326            /// the cc query parameter only if you specify multiple languages. Otherwise,
 327            /// use the
 328            /// [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt)
 329            /// and
 330            /// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang
 331            /// query parameters. A user interface string is a string that's used as a
 332            /// label in a user interface. There are few user interface strings in the JSON
 333            /// response objects. Any links to Bing.com properties in the response objects
 334            /// apply the specified language.
 335            /// </param>
 336            /// <param name='userAgent'>
 337            /// The user agent originating the request. Bing uses the user agent to provide
 338            /// mobile users with an optimized experience. Although optional, you are
 339            /// encouraged to always specify this header. The user-agent should be the same
 340            /// string that any commonly used browser sends. For information about user
 341            /// agents, see [RFC
 342            /// 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
 343            /// following are examples of user-agent strings. Windows Phone: Mozilla/5.0
 344            /// (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM;
 345            /// Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5;
 346            /// en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like
 347            /// Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone;
 348            /// CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko)
 349            /// Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0
 350            /// (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad:
 351            /// Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1
 352            /// (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53
 353            /// </param>
 354            /// <param name='clientId'>
 355            /// Bing uses this header to provide users with consistent behavior across Bing
 356            /// API calls. Bing often flights new features and improvements, and it uses
 357            /// the client ID as a key for assigning traffic on different flights. If you
 358            /// do not use the same client ID for a user across multiple requests, then
 359            /// Bing may assign the user to multiple conflicting flights. Being assigned to
 360            /// multiple conflicting flights can lead to an inconsistent user experience.
 361            /// For example, if the second request has a different flight assignment than
 362            /// the first, the experience may be unexpected. Also, Bing can use the client
 363            /// ID to tailor web results to that client ID’s search history, providing a
 364            /// richer experience for the user. Bing also uses this header to help improve
 365            /// result rankings by analyzing the activity generated by a client ID. The
 366            /// relevance improvements help with better quality of results delivered by
 367            /// Bing APIs and in turn enables higher click-through rates for the API
 368            /// consumer. IMPORTANT: Although optional, you should consider this header
 369            /// required. Persisting the client ID across multiple requests for the same
 370            /// end user and device combination enables 1) the API consumer to receive a
 371            /// consistent user experience, and 2) higher click-through rates via better
 372            /// quality of results from the Bing APIs. Each user that uses your application
 373            /// on the device must have a unique, Bing generated client ID. If you do not
 374            /// include this header in the request, Bing generates an ID and returns it in
 375            /// the X-MSEdge-ClientID response header. The only time that you should NOT
 376            /// include this header in a request is the first time the user uses your app
 377            /// on that device. Use the client ID for each Bing API request that your app
 378            /// makes for this user on the device. Persist the client ID. To persist the ID
 379            /// in a browser app, use a persistent HTTP cookie to ensure the ID is used
 380            /// across all sessions. Do not use a session cookie. For other apps such as
 381            /// mobile apps, use the device's persistent storage to persist the ID. The
 382            /// next time the user uses your app on that device, get the client ID that you
 383            /// persisted. Bing responses may or may not include this header. If the
 384            /// response includes this header, capture the client ID and use it for all
 385            /// subsequent Bing requests for the user on that device. If you include the
 386            /// X-MSEdge-ClientID, you must not include cookies in the request.
 387            /// </param>
 388            /// <param name='clientIp'>
 389            /// The IPv4 or IPv6 address of the client device. The IP address is used to
 390            /// discover the user's location. Bing uses the location information to
 391            /// determine safe search behavior. Although optional, you are encouraged to
 392            /// always specify this header and the X-Search-Location header. Do not
 393            /// obfuscate the address (for example, by changing the last octet to 0).
 394            /// Obfuscating the address results in the location not being anywhere near the
 395            /// device's actual location, which may result in Bing serving erroneous
 396            /// results.
 397            /// </param>
 398            /// <param name='location'>
 399            /// A semicolon-delimited list of key/value pairs that describe the client's
 400            /// geographical location. Bing uses the location information to determine safe
 401            /// search behavior and to return relevant local content. Specify the key/value
 402            /// pair as &lt;key&gt;:&lt;value&gt;. The following are the keys that you use
 403            /// to specify the user's location. lat (required): The latitude of the
 404            /// client's location, in degrees. The latitude must be greater than or equal
 405            /// to -90.0 and less than or equal to +90.0. Negative values indicate southern
 406            /// latitudes and positive values indicate northern latitudes. long (required):
 407            /// The longitude of the client's location, in degrees. The longitude must be
 408            /// greater than or equal to -180.0 and less than or equal to +180.0. Negative
 409            /// values indicate western longitudes and positive values indicate eastern
 410            /// longitudes. re (required): The radius, in meters, which specifies the
 411            /// horizontal accuracy of the coordinates. Pass the value returned by the
 412            /// device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m
 413            /// for cell tower triangulation, and 18,000m for reverse IP lookup. ts
 414            /// (optional): The UTC UNIX timestamp of when the client was at the location.
 415            /// (The UNIX timestamp is the number of seconds since January 1, 1970.) head
 416            /// (optional): The client's relative heading or direction of travel. Specify
 417            /// the direction of travel as degrees from 0 through 360, counting clockwise
 418            /// relative to true north. Specify this key only if the sp key is nonzero. sp
 419            /// (optional): The horizontal velocity (speed), in meters per second, that the
 420            /// client device is traveling. alt (optional): The altitude of the client
 421            /// device, in meters. are (optional): The radius, in meters, that specifies
 422            /// the vertical accuracy of the coordinates. Specify this key only if you
 423            /// specify the alt key. Although many of the keys are optional, the more
 424            /// information that you provide, the more accurate the location results are.
 425            /// Although optional, you are encouraged to always specify the user's
 426            /// geographical location. Providing the location is especially important if
 427            /// the client's IP address does not accurately reflect the user's physical
 428            /// location (for example, if the client uses VPN). For optimal results, you
 429            /// should include this header and the X-MSEdge-ClientIP header, but at a
 430            /// minimum, you should include this header.
 431            /// </param>
 432            /// <param name='countryCode'>
 433            /// A 2-character country code of the country where the results come from. This
 434            /// API supports only the United States market. If you specify this query
 435            /// parameter, it must be set to us. If you set this parameter, you must also
 436            /// specify the Accept-Language header. Bing uses the first supported language
 437            /// it finds from the languages list, and combine that language with the
 438            /// country code that you specify to determine the market to return results
 439            /// for. If the languages list does not include a supported language, Bing
 440            /// finds the closest language and market that supports the request, or it may
 441            /// use an aggregated or default market for the results instead of a specified
 442            /// one. You should use this query parameter and the Accept-Language query
 443            /// parameter only if you specify multiple languages; otherwise, you should use
 444            /// the mkt and setLang query parameters. This parameter and the mkt query
 445            /// parameter are mutually exclusive—do not specify both.
 446            /// </param>
 447            /// <param name='category'>
 448            /// The category of articles to return. For example, Sports articles or
 449            /// Entertainment articles. For a list of possible categories, see [News
 450            /// Categories by
 451            /// Market](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#categorie
 452            /// Use this parameter only with News Category API. If you do not specify this
 453            /// parameter, the response includes both: Headline articles typically
 454            /// published in the last 24 hours from any category and articles from each
 455            /// parent category (up to four articles). If the article is a headline, the
 456            /// article's headline field is set to true. By default, the response includes
 457            /// up to 12 headline articles. To specify the number of headline articles to
 458            /// return, set the
 459            /// [headlineCount](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#h
 460            /// query parameter.
 461            /// </param>
 462            /// <param name='count'>
 463            /// The number of news articles to return in the response. The actual number
 464            /// delivered may be less than requested. The default is 10 and the maximum
 465            /// value is 100. The actual number delivered may be less than requested.You
 466            /// may use this parameter along with the offset parameter to page results. For
 467            /// example, if your user interface displays 20 articles per page, set count to
 468            /// 20 and offset to 0 to get the first page of results. For each subsequent
 469            /// page, increment offset by 20 (for example, 0, 20, 40). It is possible for
 470            /// multiple pages to include some overlap in results. If you do not specify
 471            /// the
 472            /// [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#catego
 473            /// parameter, Bing ignores this parameter.
 474            /// </param>
 475            /// <param name='headlineCount'>
 476            /// The number of headline articles to return in the response. The default is
 477            /// 12. Specify this parameter only if you do not specify the
 478            /// [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#catego
 479            /// parameter.
 480            /// </param>
 481            /// <param name='market'>
 482            /// The market where the results come from. Typically, mkt is the country where
 483            /// the user is making the request from. However, it could be a different
 484            /// country if the user is not located in a country where Bing delivers
 485            /// results. The market must be in the form &lt;language code&gt;-&lt;country
 486            /// code&gt;. For example, en-US. The string is case insensitive. For a list of
 487            /// possible market values, see [Market
 488            /// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-cod
 489            /// NOTE: If known, you are encouraged to always specify the market. Specifying
 490            /// the market helps Bing route the request and return an appropriate and
 491            /// optimal response. If you specify a market that is not listed in [Market
 492            /// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-cod
 493            /// Bing uses a best fit market code based on an internal mapping that is
 494            /// subject to change. This parameter and the
 495            /// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc)
 496            /// query parameter are mutually exclusive—do not specify both.
 497            /// </param>
 498            /// <param name='offset'>
 499            /// The zero-based offset that indicates the number of news to skip before
 500            /// returning news. The default is 0. The offset should be less than
 501            /// ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-re
 502            /// - count). Use this parameter along with the count parameter to page
 503            /// results. For example, if your user interface displays 20 news per page, set
 504            /// count to 20 and offset to 0 to get the first page of results. For each
 505            /// subsequent page, increment offset by 20 (for example, 0, 20, 40). It is
 506            /// possible for multiple pages to include some overlap in results. If you do
 507            /// not specify the
 508            /// [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#catego
 509            /// parameter, Bing ignores this parameter.
 510            /// </param>
 511            /// <param name='originalImage'>
 512            /// A Boolean value that determines whether the image's contentUrl contains a
 513            /// URL that points to a thumbnail of the original article's image or the image
 514            /// itself. If the article includes an image, and this parameter is set to
 515            /// true, the image's contentUrl property contains a URL that you may use to
 516            /// download the original image from the publisher's website. Otherwise, if
 517            /// this parameter is false, the image's contentUrl and thumbnailUrl URLs both
 518            /// point to the same thumbnail image. Use this parameter only with the News
 519            /// Search API or News Category API. Trending Topics API ignore this parameter.
 520            /// </param>
 521            /// <param name='safeSearch'>
 522            /// Filter news for adult content. The following are the possible filter
 523            /// values. Off: Return news articles with adult text, images, or videos.
 524            /// Moderate: Return news articles with adult text but not adult images or
 525            /// videos. Strict: Do not return news articles with adult text, images, or
 526            /// videos. If the request comes from a market that Bing's adult policy
 527            /// requires that safeSearch is set to Strict, Bing ignores the safeSearch
 528            /// value and uses Strict. If you use the site: query operator, there is the
 529            /// chance that the response may contain adult content regardless of what the
 530            /// safeSearch query parameter is set to. Use site: only if you are aware of
 531            /// the content on the site and your scenario supports the possibility of adult
 532            /// content. Possible values include: 'Off', 'Moderate', 'Strict'
 533            /// </param>
 534            /// <param name='setLang'>
 535            /// The language to use for user interface strings. Specify the language using
 536            /// the ISO 639-1 2-letter language code. For example, the language code for
 537            /// English is EN. The default is EN (English). Although optional, you should
 538            /// always specify the language. Typically, you set setLang to the same
 539            /// language specified by mkt unless the user wants the user interface strings
 540            /// displayed in a different language. This parameter and the
 541            /// [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference
 542            /// header are mutually exclusive; do not specify both. A user interface string
 543            /// is a string that's used as a label in a user interface. There are few user
 544            /// interface strings in the JSON response objects. Also, any links to Bing.com
 545            /// properties in the response objects apply the specified language.
 546            /// </param>
 547            /// <param name='textDecorations'>
 548            /// A Boolean value that determines whether display strings contain decoration
 549            /// markers such as hit highlighting characters. If true, the strings may
 550            /// include markers. The default is false. To specify whether to use Unicode
 551            /// characters or HTML tags as the markers, see the
 552            /// [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#text
 553            /// query parameter. For information about hit highlighting, see [Hit
 554            /// Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
 555            /// </param>
 556            /// <param name='textFormat'>
 557            /// The type of markers to use for text decorations (see the textDecorations
 558            /// query parameter). Possible values are Raw—Use Unicode characters to mark
 559            /// content that needs special formatting. The Unicode characters are in the
 560            /// range E000 through E019. For example, Bing uses E000 and E001 to mark the
 561            /// beginning and end of query terms for hit highlighting. HTML—Use HTML tags
 562            /// to mark content that needs special formatting. For example, use &lt;b&gt;
 563            /// tags to highlight query terms in display strings. The default is Raw. For
 564            /// display strings that contain escapable HTML characters such as &lt;, &gt;,
 565            /// and &amp;, if textFormat is set to HTML, Bing escapes the characters as
 566            /// appropriate (for example, &lt; is escaped to &amp;lt;). Possible values
 567            /// include: 'Raw', 'Html'
 568            /// </param>
 569            /// <param name='cancellationToken'>
 570            /// The cancellation token.
 571            /// </param>
 572            public static async Task<News> CategoryAsync(this INewsOperations operations, string acceptLanguage = defaul
 573            {
 2574                using (var _result = await operations.CategoryWithHttpMessagesAsync(acceptLanguage, userAgent, clientId,
 575                {
 2576                    return _result.Body;
 577                }
 2578            }
 579
 580            /// <summary>
 581            /// The News Trending Topics API lets lets you search on Bing and get back a
 582            /// list of trending news topics that are currently trending on Bing. This
 583            /// section provides technical details about the query parameters and headers
 584            /// that you use to request news and the JSON response objects that contain
 585            /// them.  For examples that show how to make requests, see [Searching the web
 586            /// for
 587            /// news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
 588            /// </summary>
 589            /// <param name='operations'>
 590            /// The operations group for this extension method.
 591            /// </param>
 592            /// <param name='acceptLanguage'>
 593            /// A comma-delimited list of one or more languages to use for user interface
 594            /// strings. The list is in decreasing order of preference. For additional
 595            /// information, including expected format, see
 596            /// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This
 597            /// header and the
 598            /// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang
 599            /// query parameter are mutually exclusive; do not specify both. If you set
 600            /// this header, you must also specify the
 601            /// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc)
 602            /// query parameter. To determine the market to return results for, Bing uses
 603            /// the first supported language it finds from the list and combines it with
 604            /// the cc parameter value. If the list does not include a supported language,
 605            /// Bing finds the closest language and market that supports the request or it
 606            /// uses an aggregated or default market for the results. To determine the
 607            /// market that Bing used, see the BingAPIs-Market header. Use this header and
 608            /// the cc query parameter only if you specify multiple languages. Otherwise,
 609            /// use the
 610            /// [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt)
 611            /// and
 612            /// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang
 613            /// query parameters. A user interface string is a string that's used as a
 614            /// label in a user interface. There are few user interface strings in the JSON
 615            /// response objects. Any links to Bing.com properties in the response objects
 616            /// apply the specified language.
 617            /// </param>
 618            /// <param name='userAgent'>
 619            /// The user agent originating the request. Bing uses the user agent to provide
 620            /// mobile users with an optimized experience. Although optional, you are
 621            /// encouraged to always specify this header. The user-agent should be the same
 622            /// string that any commonly used browser sends. For information about user
 623            /// agents, see [RFC
 624            /// 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
 625            /// following are examples of user-agent strings. Windows Phone: Mozilla/5.0
 626            /// (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM;
 627            /// Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5;
 628            /// en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like
 629            /// Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone;
 630            /// CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko)
 631            /// Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0
 632            /// (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad:
 633            /// Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1
 634            /// (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53
 635            /// </param>
 636            /// <param name='clientId'>
 637            /// Bing uses this header to provide users with consistent behavior across Bing
 638            /// API calls. Bing often flights new features and improvements, and it uses
 639            /// the client ID as a key for assigning traffic on different flights. If you
 640            /// do not use the same client ID for a user across multiple requests, then
 641            /// Bing may assign the user to multiple conflicting flights. Being assigned to
 642            /// multiple conflicting flights can lead to an inconsistent user experience.
 643            /// For example, if the second request has a different flight assignment than
 644            /// the first, the experience may be unexpected. Also, Bing can use the client
 645            /// ID to tailor web results to that client ID’s search history, providing a
 646            /// richer experience for the user. Bing also uses this header to help improve
 647            /// result rankings by analyzing the activity generated by a client ID. The
 648            /// relevance improvements help with better quality of results delivered by
 649            /// Bing APIs and in turn enables higher click-through rates for the API
 650            /// consumer. IMPORTANT: Although optional, you should consider this header
 651            /// required. Persisting the client ID across multiple requests for the same
 652            /// end user and device combination enables 1) the API consumer to receive a
 653            /// consistent user experience, and 2) higher click-through rates via better
 654            /// quality of results from the Bing APIs. Each user that uses your application
 655            /// on the device must have a unique, Bing generated client ID. If you do not
 656            /// include this header in the request, Bing generates an ID and returns it in
 657            /// the X-MSEdge-ClientID response header. The only time that you should NOT
 658            /// include this header in a request is the first time the user uses your app
 659            /// on that device. Use the client ID for each Bing API request that your app
 660            /// makes for this user on the device. Persist the client ID. To persist the ID
 661            /// in a browser app, use a persistent HTTP cookie to ensure the ID is used
 662            /// across all sessions. Do not use a session cookie. For other apps such as
 663            /// mobile apps, use the device's persistent storage to persist the ID. The
 664            /// next time the user uses your app on that device, get the client ID that you
 665            /// persisted. Bing responses may or may not include this header. If the
 666            /// response includes this header, capture the client ID and use it for all
 667            /// subsequent Bing requests for the user on that device. If you include the
 668            /// X-MSEdge-ClientID, you must not include cookies in the request.
 669            /// </param>
 670            /// <param name='clientIp'>
 671            /// The IPv4 or IPv6 address of the client device. The IP address is used to
 672            /// discover the user's location. Bing uses the location information to
 673            /// determine safe search behavior. Although optional, you are encouraged to
 674            /// always specify this header and the X-Search-Location header. Do not
 675            /// obfuscate the address (for example, by changing the last octet to 0).
 676            /// Obfuscating the address results in the location not being anywhere near the
 677            /// device's actual location, which may result in Bing serving erroneous
 678            /// results.
 679            /// </param>
 680            /// <param name='location'>
 681            /// A semicolon-delimited list of key/value pairs that describe the client's
 682            /// geographical location. Bing uses the location information to determine safe
 683            /// search behavior and to return relevant local content. Specify the key/value
 684            /// pair as &lt;key&gt;:&lt;value&gt;. The following are the keys that you use
 685            /// to specify the user's location. lat (required): The latitude of the
 686            /// client's location, in degrees. The latitude must be greater than or equal
 687            /// to -90.0 and less than or equal to +90.0. Negative values indicate southern
 688            /// latitudes and positive values indicate northern latitudes. long (required):
 689            /// The longitude of the client's location, in degrees. The longitude must be
 690            /// greater than or equal to -180.0 and less than or equal to +180.0. Negative
 691            /// values indicate western longitudes and positive values indicate eastern
 692            /// longitudes. re (required): The radius, in meters, which specifies the
 693            /// horizontal accuracy of the coordinates. Pass the value returned by the
 694            /// device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m
 695            /// for cell tower triangulation, and 18,000m for reverse IP lookup. ts
 696            /// (optional): The UTC UNIX timestamp of when the client was at the location.
 697            /// (The UNIX timestamp is the number of seconds since January 1, 1970.) head
 698            /// (optional): The client's relative heading or direction of travel. Specify
 699            /// the direction of travel as degrees from 0 through 360, counting clockwise
 700            /// relative to true north. Specify this key only if the sp key is nonzero. sp
 701            /// (optional): The horizontal velocity (speed), in meters per second, that the
 702            /// client device is traveling. alt (optional): The altitude of the client
 703            /// device, in meters. are (optional): The radius, in meters, that specifies
 704            /// the vertical accuracy of the coordinates. Specify this key only if you
 705            /// specify the alt key. Although many of the keys are optional, the more
 706            /// information that you provide, the more accurate the location results are.
 707            /// Although optional, you are encouraged to always specify the user's
 708            /// geographical location. Providing the location is especially important if
 709            /// the client's IP address does not accurately reflect the user's physical
 710            /// location (for example, if the client uses VPN). For optimal results, you
 711            /// should include this header and the X-MSEdge-ClientIP header, but at a
 712            /// minimum, you should include this header.
 713            /// </param>
 714            /// <param name='countryCode'>
 715            /// A 2-character country code of the country where the results come from. This
 716            /// API supports only the United States market. If you specify this query
 717            /// parameter, it must be set to us. If you set this parameter, you must also
 718            /// specify the Accept-Language header. Bing uses the first supported language
 719            /// it finds from the languages list, and combine that language with the
 720            /// country code that you specify to determine the market to return results
 721            /// for. If the languages list does not include a supported language, Bing
 722            /// finds the closest language and market that supports the request, or it may
 723            /// use an aggregated or default market for the results instead of a specified
 724            /// one. You should use this query parameter and the Accept-Language query
 725            /// parameter only if you specify multiple languages; otherwise, you should use
 726            /// the mkt and setLang query parameters. This parameter and the mkt query
 727            /// parameter are mutually exclusive—do not specify both.
 728            /// </param>
 729            /// <param name='count'>
 730            /// The number of news articles to return in the response. The actual number
 731            /// delivered may be less than requested. The default is 10 and the maximum
 732            /// value is 100. The actual number delivered may be less than requested.You
 733            /// may use this parameter along with the offset parameter to page results. For
 734            /// example, if your user interface displays 20 articles per page, set count to
 735            /// 20 and offset to 0 to get the first page of results. For each subsequent
 736            /// page, increment offset by 20 (for example, 0, 20, 40). It is possible for
 737            /// multiple pages to include some overlap in results.
 738            /// </param>
 739            /// <param name='market'>
 740            /// The market where the results come from. Typically, mkt is the country where
 741            /// the user is making the request from. However, it could be a different
 742            /// country if the user is not located in a country where Bing delivers
 743            /// results. The market must be in the form &lt;language code&gt;-&lt;country
 744            /// code&gt;. For example, en-US. The string is case insensitive. For a list of
 745            /// possible market values, see [Market
 746            /// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-cod
 747            /// NOTE: If known, you are encouraged to always specify the market. Specifying
 748            /// the market helps Bing route the request and return an appropriate and
 749            /// optimal response. If you specify a market that is not listed in [Market
 750            /// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-cod
 751            /// Bing uses a best fit market code based on an internal mapping that is
 752            /// subject to change. This parameter and the
 753            /// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc)
 754            /// query parameter are mutually exclusive—do not specify both.
 755            /// </param>
 756            /// <param name='offset'>
 757            /// The zero-based offset that indicates the number of news to skip before
 758            /// returning news. The default is 0. The offset should be less than
 759            /// ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-re
 760            /// - count). Use this parameter along with the count parameter to page
 761            /// results. For example, if your user interface displays 20 news per page, set
 762            /// count to 20 and offset to 0 to get the first page of results. For each
 763            /// subsequent page, increment offset by 20 (for example, 0, 20, 40). It is
 764            /// possible for multiple pages to include some overlap in results.
 765            /// </param>
 766            /// <param name='safeSearch'>
 767            /// Filter news for adult content. The following are the possible filter
 768            /// values. Off: Return news articles with adult text, images, or videos.
 769            /// Moderate: Return news articles with adult text but not adult images or
 770            /// videos. Strict: Do not return news articles with adult text, images, or
 771            /// videos. If the request comes from a market that Bing's adult policy
 772            /// requires that safeSearch is set to Strict, Bing ignores the safeSearch
 773            /// value and uses Strict. If you use the site: query operator, there is the
 774            /// chance that the response may contain adult content regardless of what the
 775            /// safeSearch query parameter is set to. Use site: only if you are aware of
 776            /// the content on the site and your scenario supports the possibility of adult
 777            /// content. Possible values include: 'Off', 'Moderate', 'Strict'
 778            /// </param>
 779            /// <param name='setLang'>
 780            /// The language to use for user interface strings. Specify the language using
 781            /// the ISO 639-1 2-letter language code. For example, the language code for
 782            /// English is EN. The default is EN (English). Although optional, you should
 783            /// always specify the language. Typically, you set setLang to the same
 784            /// language specified by mkt unless the user wants the user interface strings
 785            /// displayed in a different language. This parameter and the
 786            /// [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference
 787            /// header are mutually exclusive; do not specify both. A user interface string
 788            /// is a string that's used as a label in a user interface. There are few user
 789            /// interface strings in the JSON response objects. Also, any links to Bing.com
 790            /// properties in the response objects apply the specified language.
 791            /// </param>
 792            /// <param name='since'>
 793            /// The Unix epoch time (Unix timestamp) that Bing uses to select the trending
 794            /// topics. Bing returns trending topics that it discovered on or after the
 795            /// specified date and time, not the date the topic was published. To use this
 796            /// parameter, also specify the sortBy parameter. Use this parameter only with
 797            /// the News Trending Topics API. Do not specify this parameter when calling
 798            /// the News Search API or News Category API.
 799            /// </param>
 800            /// <param name='sortBy'>
 801            /// The order to return the news in. The following are the possible
 802            /// case-insensitive values. Date: If the request is through the News Search
 803            /// API, the response returns news articles sorted by date from the most recent
 804            /// to the oldest. If the request is through the News Trending Topics API, the
 805            /// response returns trending topics sorted by date from the most recent to the
 806            /// oldest.
 807            /// </param>
 808            /// <param name='textDecorations'>
 809            /// A Boolean value that determines whether display strings contain decoration
 810            /// markers such as hit highlighting characters. If true, the strings may
 811            /// include markers. The default is false. To specify whether to use Unicode
 812            /// characters or HTML tags as the markers, see the
 813            /// [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#text
 814            /// query parameter. For information about hit highlighting, see [Hit
 815            /// Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
 816            /// </param>
 817            /// <param name='textFormat'>
 818            /// The type of markers to use for text decorations (see the textDecorations
 819            /// query parameter). Possible values are Raw—Use Unicode characters to mark
 820            /// content that needs special formatting. The Unicode characters are in the
 821            /// range E000 through E019. For example, Bing uses E000 and E001 to mark the
 822            /// beginning and end of query terms for hit highlighting. HTML—Use HTML tags
 823            /// to mark content that needs special formatting. For example, use &lt;b&gt;
 824            /// tags to highlight query terms in display strings. The default is Raw. For
 825            /// display strings that contain escapable HTML characters such as &lt;, &gt;,
 826            /// and &amp;, if textFormat is set to HTML, Bing escapes the characters as
 827            /// appropriate (for example, &lt; is escaped to &amp;lt;). Possible values
 828            /// include: 'Raw', 'Html'
 829            /// </param>
 830            /// <param name='cancellationToken'>
 831            /// The cancellation token.
 832            /// </param>
 833            public static async Task<TrendingTopics> TrendingAsync(this INewsOperations operations, string acceptLanguag
 834            {
 2835                using (var _result = await operations.TrendingWithHttpMessagesAsync(acceptLanguage, userAgent, clientId,
 836                {
 2837                    return _result.Body;
 838                }
 2839            }
 840
 841    }
 842}
Generated by: ReportGenerator 4.6.4.0
8/12/2020 - 3:47:14 PM
GitHub | www.palmmedia.de

Methods/Properties

SearchAsync()
CategoryAsync()
TrendingAsync()