< Summary

Class:Microsoft.Azure.CognitiveServices.Search.LocalSearch.LocalExtensions
Assembly:Microsoft.Azure.CognitiveServices.Search.BingLocalSearch
File(s):C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Search.BingLocalSearch\src\Generated\LocalSearch\LocalExtensions.cs
Covered lines:0
Uncovered lines:4
Coverable lines:4
Total lines:433
Line coverage:0% (0 of 4)
Covered branches:0
Total branches:0

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
Search(...)-0%100%
SearchAsync()-0%100%

File(s)

C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Search.BingLocalSearch\src\Generated\LocalSearch\LocalExtensions.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.LocalSearch
 8{
 9    using Models;
 10    using System.Collections;
 11    using System.Collections.Generic;
 12    using System.Threading;
 13    using System.Threading.Tasks;
 14
 15    /// <summary>
 16    /// Extension methods for Local.
 17    /// </summary>
 18    public static partial class LocalExtensions
 19    {
 20            /// <summary>
 21            /// The Local Search API lets you send a search query to Bing and get back
 22            /// search results that include local businesses such as restaurants, hotels,
 23            /// retail stores, or other local businesses. The query can specify the name of
 24            /// the local business or it can ask for a list (for example, restaurants near
 25            /// me).
 26            /// </summary>
 27            /// <param name='operations'>
 28            /// The operations group for this extension method.
 29            /// </param>
 30            /// <param name='query'>
 31            /// The user's search term.
 32            /// </param>
 33            /// <param name='acceptLanguage'>
 34            /// A comma-delimited list of one or more languages to use for user interface
 35            /// strings. The list is in decreasing order of preference. For additional
 36            /// information, including expected format, see
 37            /// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This
 38            /// header and the setLang query parameter are mutually exclusive; do not
 39            /// specify both. If you set this header, you must also specify the cc query
 40            /// parameter. Bing will use the first supported language it finds from the
 41            /// list, and combine that language with the cc parameter value to determine
 42            /// the market to return results for. If the list does not include a supported
 43            /// language, Bing will find the closest language and market that supports the
 44            /// request, and may use an aggregated or default market for the results
 45            /// instead of a specified one. You should use this header and the cc query
 46            /// parameter only if you specify multiple languages; otherwise, you should use
 47            /// the mkt and setLang query parameters. A user interface string is a string
 48            /// that's used as a label in a user interface. There are very few user
 49            /// interface strings in the JSON response objects. Any links in the response
 50            /// objects to Bing.com properties will apply the specified language.
 51            /// </param>
 52            /// <param name='pragma'>
 53            /// By default, Bing returns cached content, if available. To prevent Bing from
 54            /// returning cached content, set the Pragma header to no-cache (for example,
 55            /// Pragma: no-cache).
 56            /// </param>
 57            /// <param name='userAgent'>
 58            /// The user agent originating the request. Bing uses the user agent to provide
 59            /// mobile users with an optimized experience. Although optional, you are
 60            /// strongly encouraged to always specify this header. The user-agent should be
 61            /// the same string that any commonly used browser would send. For information
 62            /// about user agents, see [RFC
 63            /// 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
 64            /// </param>
 65            /// <param name='clientId'>
 66            /// Bing uses this header to provide users with consistent behavior across Bing
 67            /// API calls. Bing often flights new features and improvements, and it uses
 68            /// the client ID as a key for assigning traffic on different flights. If you
 69            /// do not use the same client ID for a user across multiple requests, then
 70            /// Bing may assign the user to multiple conflicting flights. Being assigned to
 71            /// multiple conflicting flights can lead to an inconsistent user experience.
 72            /// For example, if the second request has a different flight assignment than
 73            /// the first, the experience may be unexpected. Also, Bing can use the client
 74            /// ID to tailor web results to that client ID’s search history, providing a
 75            /// richer experience for the user. Bing also uses this header to help improve
 76            /// result rankings by analyzing the activity generated by a client ID. The
 77            /// relevance improvements help with better quality of results delivered by
 78            /// Bing APIs and in turn enables higher click-through rates for the API
 79            /// consumer. IMPORTANT: Although optional, you should consider this header
 80            /// required. Persisting the client ID across multiple requests for the same
 81            /// end user and device combination enables 1) the API consumer to receive a
 82            /// consistent user experience, and 2) higher click-through rates via better
 83            /// quality of results from the Bing APIs. Each user that uses your application
 84            /// on the device must have a unique, Bing generated client ID. If you do not
 85            /// include this header in the request, Bing generates an ID and returns it in
 86            /// the X-MSEdge-ClientID response header. The only time that you should NOT
 87            /// include this header in a request is the first time the user uses your app
 88            /// on that device. Use the client ID for each Bing API request that your app
 89            /// makes for this user on the device. Persist the client ID. To persist the ID
 90            /// in a browser app, use a persistent HTTP cookie to ensure the ID is used
 91            /// across all sessions. Do not use a session cookie. For other apps such as
 92            /// mobile apps, use the device's persistent storage to persist the ID. The
 93            /// next time the user uses your app on that device, get the client ID that you
 94            /// persisted. Bing responses may or may not include this header. If the
 95            /// response includes this header, capture the client ID and use it for all
 96            /// subsequent Bing requests for the user on that device. If you include the
 97            /// X-MSEdge-ClientID, you must not include cookies in the request.
 98            /// </param>
 99            /// <param name='clientIp'>
 100            /// The IPv4 or IPv6 address of the client device. The IP address is used to
 101            /// discover the user's location. Bing uses the location information to
 102            /// determine safe search behavior. Although optional, you are encouraged to
 103            /// always specify this header and the X-Search-Location header. Do not
 104            /// obfuscate the address (for example, by changing the last octet to 0).
 105            /// Obfuscating the address results in the location not being anywhere near the
 106            /// device's actual location, which may result in Bing serving erroneous
 107            /// results.
 108            /// </param>
 109            /// <param name='location'>
 110            /// A semicolon-delimited list of key/value pairs that describe the client's
 111            /// geographical location. Bing uses the location information to determine safe
 112            /// search behavior and to return relevant local content. Specify the key/value
 113            /// pair as &lt;key&gt;:&lt;value&gt;. The following are the keys that you use
 114            /// to specify the user's location. lat (required): The latitude of the
 115            /// client's location, in degrees. The latitude must be greater than or equal
 116            /// to -90.0 and less than or equal to +90.0. Negative values indicate southern
 117            /// latitudes and positive values indicate northern latitudes. long (required):
 118            /// The longitude of the client's location, in degrees. The longitude must be
 119            /// greater than or equal to -180.0 and less than or equal to +180.0. Negative
 120            /// values indicate western longitudes and positive values indicate eastern
 121            /// longitudes. re (required): The radius, in meters, which specifies the
 122            /// horizontal accuracy of the coordinates. Pass the value returned by the
 123            /// device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m
 124            /// for cell tower triangulation, and 18,000m for reverse IP lookup. ts
 125            /// (optional): The UTC UNIX timestamp of when the client was at the location.
 126            /// (The UNIX timestamp is the number of seconds since January 1, 1970.) head
 127            /// (optional): The client's relative heading or direction of travel. Specify
 128            /// the direction of travel as degrees from 0 through 360, counting clockwise
 129            /// relative to true north. Specify this key only if the sp key is nonzero. sp
 130            /// (optional): The horizontal velocity (speed), in meters per second, that the
 131            /// client device is traveling. alt (optional): The altitude of the client
 132            /// device, in meters. are (optional): The radius, in meters, that specifies
 133            /// the vertical accuracy of the coordinates. Specify this key only if you
 134            /// specify the alt key. Although many of the keys are optional, the more
 135            /// information that you provide, the more accurate the location results are.
 136            /// Although optional, you are encouraged to always specify the user's
 137            /// geographical location. Providing the location is especially important if
 138            /// the client's IP address does not accurately reflect the user's physical
 139            /// location (for example, if the client uses VPN). For optimal results, you
 140            /// should include this header and the X-MSEdge-ClientIP header, but at a
 141            /// minimum, you should include this header.
 142            /// </param>
 143            /// <param name='countryCode'>
 144            /// A 2-character country code of the country where the results come from. This
 145            /// API supports only the United States market. If you specify this query
 146            /// parameter, it must be set to us. If you set this parameter, you must also
 147            /// specify the Accept-Language header. Bing uses the first supported language
 148            /// it finds from the languages list, and combine that language with the
 149            /// country code that you specify to determine the market to return results
 150            /// for. If the languages list does not include a supported language, Bing
 151            /// finds the closest language and market that supports the request, or it may
 152            /// use an aggregated or default market for the results instead of a specified
 153            /// one. You should use this query parameter and the Accept-Language query
 154            /// parameter only if you specify multiple languages; otherwise, you should use
 155            /// the mkt and setLang query parameters. This parameter and the mkt query
 156            /// parameter are mutually exclusive—do not specify both.
 157            /// </param>
 158            /// <param name='market'>
 159            /// The market where the results come from. You are strongly encouraged to
 160            /// always specify the market, if known. Specifying the market helps Bing route
 161            /// the request and return an appropriate and optimal response. This parameter
 162            /// and the cc query parameter are mutually exclusive—do not specify both.
 163            /// </param>
 164            /// <param name='localCategories'>
 165            /// comma-delimiated list of business categories to search for. Supported
 166            /// categories can be high-level such as EatDrink, Shop, SeeDo.
 167            /// </param>
 168            /// <param name='localCircularView'>
 169            /// Preferred location to search around, expressed as Latitude, longitude and
 170            /// radius in meters. For example 47.61503,-122.1719,5000. Note that circular
 171            /// view should only be used to indicate a search around a point on the map,
 172            /// not as an approximation for a view port of a map rectangle.
 173            /// </param>
 174            /// <param name='localMapView'>
 175            /// Preferred bounding box for results, specified in NW_latitude, NW_Longitude,
 176            /// SE_Latitude, SE_Longitude format. For example 47.64,-122.13,47.63,-122.12.
 177            /// These values are lat, long pairs for the Northwest corner and the Southeast
 178            /// corner of a rectangle.
 179            /// </param>
 180            /// <param name='count'>
 181            /// Preferred number of results to return. If not specified, then Bing returns
 182            /// 1-20 of the most relevant results.
 183            /// </param>
 184            /// <param name='first'>
 185            /// First result to return. zero-based. default is 0.
 186            /// </param>
 187            /// <param name='responseFormat'>
 188            /// The media type to use for the response. The following are the possible
 189            /// case-insensitive values: JSON, JSONLD. The default is JSON. If you specify
 190            /// JSONLD, the response body includes JSON-LD objects that contain the search
 191            /// results.
 192            /// </param>
 193            /// <param name='safeSearch'>
 194            /// A filter used to filter adult content. Off: Return webpages with adult
 195            /// text, images, or videos. Moderate: Return webpages with adult text, but not
 196            /// adult images or videos. Strict: Do not return webpages with adult text,
 197            /// images, or videos. The default is Moderate. If the request comes from a
 198            /// market that Bing's adult policy requires that safeSearch is set to Strict,
 199            /// Bing ignores the safeSearch value and uses Strict. If you use the site:
 200            /// query operator, there is the chance that the response may contain adult
 201            /// content regardless of what the safeSearch query parameter is set to. Use
 202            /// site: only if you are aware of the content on the site and your scenario
 203            /// supports the possibility of adult content. Possible values include: 'Off',
 204            /// 'Moderate', 'Strict'
 205            /// </param>
 206            /// <param name='setLang'>
 207            /// The language to use for user interface strings. Specify the language using
 208            /// the ISO 639-1 2-letter language code. For example, the language code for
 209            /// English is EN. The default is EN (English). Although optional, you should
 210            /// always specify the language. Typically, you set setLang to the same
 211            /// language specified by mkt unless the user wants the user interface strings
 212            /// displayed in a different language. This parameter and the Accept-Language
 213            /// header are mutually exclusive; do not specify both. A user interface string
 214            /// is a string that's used as a label in a user interface. There are few user
 215            /// interface strings in the JSON response objects. Also, any links to Bing.com
 216            /// properties in the response objects apply the specified language.
 217            /// </param>
 218            public static SearchResponse Search(this ILocal operations, string query, string acceptLanguage = default(st
 219            {
 0220                return operations.SearchAsync(query, acceptLanguage, pragma, userAgent, clientId, clientIp, location, co
 221            }
 222
 223            /// <summary>
 224            /// The Local Search API lets you send a search query to Bing and get back
 225            /// search results that include local businesses such as restaurants, hotels,
 226            /// retail stores, or other local businesses. The query can specify the name of
 227            /// the local business or it can ask for a list (for example, restaurants near
 228            /// me).
 229            /// </summary>
 230            /// <param name='operations'>
 231            /// The operations group for this extension method.
 232            /// </param>
 233            /// <param name='query'>
 234            /// The user's search term.
 235            /// </param>
 236            /// <param name='acceptLanguage'>
 237            /// A comma-delimited list of one or more languages to use for user interface
 238            /// strings. The list is in decreasing order of preference. For additional
 239            /// information, including expected format, see
 240            /// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This
 241            /// header and the setLang query parameter are mutually exclusive; do not
 242            /// specify both. If you set this header, you must also specify the cc query
 243            /// parameter. Bing will use the first supported language it finds from the
 244            /// list, and combine that language with the cc parameter value to determine
 245            /// the market to return results for. If the list does not include a supported
 246            /// language, Bing will find the closest language and market that supports the
 247            /// request, and may use an aggregated or default market for the results
 248            /// instead of a specified one. You should use this header and the cc query
 249            /// parameter only if you specify multiple languages; otherwise, you should use
 250            /// the mkt and setLang query parameters. A user interface string is a string
 251            /// that's used as a label in a user interface. There are very few user
 252            /// interface strings in the JSON response objects. Any links in the response
 253            /// objects to Bing.com properties will apply the specified language.
 254            /// </param>
 255            /// <param name='pragma'>
 256            /// By default, Bing returns cached content, if available. To prevent Bing from
 257            /// returning cached content, set the Pragma header to no-cache (for example,
 258            /// Pragma: no-cache).
 259            /// </param>
 260            /// <param name='userAgent'>
 261            /// The user agent originating the request. Bing uses the user agent to provide
 262            /// mobile users with an optimized experience. Although optional, you are
 263            /// strongly encouraged to always specify this header. The user-agent should be
 264            /// the same string that any commonly used browser would send. For information
 265            /// about user agents, see [RFC
 266            /// 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
 267            /// </param>
 268            /// <param name='clientId'>
 269            /// Bing uses this header to provide users with consistent behavior across Bing
 270            /// API calls. Bing often flights new features and improvements, and it uses
 271            /// the client ID as a key for assigning traffic on different flights. If you
 272            /// do not use the same client ID for a user across multiple requests, then
 273            /// Bing may assign the user to multiple conflicting flights. Being assigned to
 274            /// multiple conflicting flights can lead to an inconsistent user experience.
 275            /// For example, if the second request has a different flight assignment than
 276            /// the first, the experience may be unexpected. Also, Bing can use the client
 277            /// ID to tailor web results to that client ID’s search history, providing a
 278            /// richer experience for the user. Bing also uses this header to help improve
 279            /// result rankings by analyzing the activity generated by a client ID. The
 280            /// relevance improvements help with better quality of results delivered by
 281            /// Bing APIs and in turn enables higher click-through rates for the API
 282            /// consumer. IMPORTANT: Although optional, you should consider this header
 283            /// required. Persisting the client ID across multiple requests for the same
 284            /// end user and device combination enables 1) the API consumer to receive a
 285            /// consistent user experience, and 2) higher click-through rates via better
 286            /// quality of results from the Bing APIs. Each user that uses your application
 287            /// on the device must have a unique, Bing generated client ID. If you do not
 288            /// include this header in the request, Bing generates an ID and returns it in
 289            /// the X-MSEdge-ClientID response header. The only time that you should NOT
 290            /// include this header in a request is the first time the user uses your app
 291            /// on that device. Use the client ID for each Bing API request that your app
 292            /// makes for this user on the device. Persist the client ID. To persist the ID
 293            /// in a browser app, use a persistent HTTP cookie to ensure the ID is used
 294            /// across all sessions. Do not use a session cookie. For other apps such as
 295            /// mobile apps, use the device's persistent storage to persist the ID. The
 296            /// next time the user uses your app on that device, get the client ID that you
 297            /// persisted. Bing responses may or may not include this header. If the
 298            /// response includes this header, capture the client ID and use it for all
 299            /// subsequent Bing requests for the user on that device. If you include the
 300            /// X-MSEdge-ClientID, you must not include cookies in the request.
 301            /// </param>
 302            /// <param name='clientIp'>
 303            /// The IPv4 or IPv6 address of the client device. The IP address is used to
 304            /// discover the user's location. Bing uses the location information to
 305            /// determine safe search behavior. Although optional, you are encouraged to
 306            /// always specify this header and the X-Search-Location header. Do not
 307            /// obfuscate the address (for example, by changing the last octet to 0).
 308            /// Obfuscating the address results in the location not being anywhere near the
 309            /// device's actual location, which may result in Bing serving erroneous
 310            /// results.
 311            /// </param>
 312            /// <param name='location'>
 313            /// A semicolon-delimited list of key/value pairs that describe the client's
 314            /// geographical location. Bing uses the location information to determine safe
 315            /// search behavior and to return relevant local content. Specify the key/value
 316            /// pair as &lt;key&gt;:&lt;value&gt;. The following are the keys that you use
 317            /// to specify the user's location. lat (required): The latitude of the
 318            /// client's location, in degrees. The latitude must be greater than or equal
 319            /// to -90.0 and less than or equal to +90.0. Negative values indicate southern
 320            /// latitudes and positive values indicate northern latitudes. long (required):
 321            /// The longitude of the client's location, in degrees. The longitude must be
 322            /// greater than or equal to -180.0 and less than or equal to +180.0. Negative
 323            /// values indicate western longitudes and positive values indicate eastern
 324            /// longitudes. re (required): The radius, in meters, which specifies the
 325            /// horizontal accuracy of the coordinates. Pass the value returned by the
 326            /// device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m
 327            /// for cell tower triangulation, and 18,000m for reverse IP lookup. ts
 328            /// (optional): The UTC UNIX timestamp of when the client was at the location.
 329            /// (The UNIX timestamp is the number of seconds since January 1, 1970.) head
 330            /// (optional): The client's relative heading or direction of travel. Specify
 331            /// the direction of travel as degrees from 0 through 360, counting clockwise
 332            /// relative to true north. Specify this key only if the sp key is nonzero. sp
 333            /// (optional): The horizontal velocity (speed), in meters per second, that the
 334            /// client device is traveling. alt (optional): The altitude of the client
 335            /// device, in meters. are (optional): The radius, in meters, that specifies
 336            /// the vertical accuracy of the coordinates. Specify this key only if you
 337            /// specify the alt key. Although many of the keys are optional, the more
 338            /// information that you provide, the more accurate the location results are.
 339            /// Although optional, you are encouraged to always specify the user's
 340            /// geographical location. Providing the location is especially important if
 341            /// the client's IP address does not accurately reflect the user's physical
 342            /// location (for example, if the client uses VPN). For optimal results, you
 343            /// should include this header and the X-MSEdge-ClientIP header, but at a
 344            /// minimum, you should include this header.
 345            /// </param>
 346            /// <param name='countryCode'>
 347            /// A 2-character country code of the country where the results come from. This
 348            /// API supports only the United States market. If you specify this query
 349            /// parameter, it must be set to us. If you set this parameter, you must also
 350            /// specify the Accept-Language header. Bing uses the first supported language
 351            /// it finds from the languages list, and combine that language with the
 352            /// country code that you specify to determine the market to return results
 353            /// for. If the languages list does not include a supported language, Bing
 354            /// finds the closest language and market that supports the request, or it may
 355            /// use an aggregated or default market for the results instead of a specified
 356            /// one. You should use this query parameter and the Accept-Language query
 357            /// parameter only if you specify multiple languages; otherwise, you should use
 358            /// the mkt and setLang query parameters. This parameter and the mkt query
 359            /// parameter are mutually exclusive—do not specify both.
 360            /// </param>
 361            /// <param name='market'>
 362            /// The market where the results come from. You are strongly encouraged to
 363            /// always specify the market, if known. Specifying the market helps Bing route
 364            /// the request and return an appropriate and optimal response. This parameter
 365            /// and the cc query parameter are mutually exclusive—do not specify both.
 366            /// </param>
 367            /// <param name='localCategories'>
 368            /// comma-delimiated list of business categories to search for. Supported
 369            /// categories can be high-level such as EatDrink, Shop, SeeDo.
 370            /// </param>
 371            /// <param name='localCircularView'>
 372            /// Preferred location to search around, expressed as Latitude, longitude and
 373            /// radius in meters. For example 47.61503,-122.1719,5000. Note that circular
 374            /// view should only be used to indicate a search around a point on the map,
 375            /// not as an approximation for a view port of a map rectangle.
 376            /// </param>
 377            /// <param name='localMapView'>
 378            /// Preferred bounding box for results, specified in NW_latitude, NW_Longitude,
 379            /// SE_Latitude, SE_Longitude format. For example 47.64,-122.13,47.63,-122.12.
 380            /// These values are lat, long pairs for the Northwest corner and the Southeast
 381            /// corner of a rectangle.
 382            /// </param>
 383            /// <param name='count'>
 384            /// Preferred number of results to return. If not specified, then Bing returns
 385            /// 1-20 of the most relevant results.
 386            /// </param>
 387            /// <param name='first'>
 388            /// First result to return. zero-based. default is 0.
 389            /// </param>
 390            /// <param name='responseFormat'>
 391            /// The media type to use for the response. The following are the possible
 392            /// case-insensitive values: JSON, JSONLD. The default is JSON. If you specify
 393            /// JSONLD, the response body includes JSON-LD objects that contain the search
 394            /// results.
 395            /// </param>
 396            /// <param name='safeSearch'>
 397            /// A filter used to filter adult content. Off: Return webpages with adult
 398            /// text, images, or videos. Moderate: Return webpages with adult text, but not
 399            /// adult images or videos. Strict: Do not return webpages with adult text,
 400            /// images, or videos. The default is Moderate. If the request comes from a
 401            /// market that Bing's adult policy requires that safeSearch is set to Strict,
 402            /// Bing ignores the safeSearch value and uses Strict. If you use the site:
 403            /// query operator, there is the chance that the response may contain adult
 404            /// content regardless of what the safeSearch query parameter is set to. Use
 405            /// site: only if you are aware of the content on the site and your scenario
 406            /// supports the possibility of adult content. Possible values include: 'Off',
 407            /// 'Moderate', 'Strict'
 408            /// </param>
 409            /// <param name='setLang'>
 410            /// The language to use for user interface strings. Specify the language using
 411            /// the ISO 639-1 2-letter language code. For example, the language code for
 412            /// English is EN. The default is EN (English). Although optional, you should
 413            /// always specify the language. Typically, you set setLang to the same
 414            /// language specified by mkt unless the user wants the user interface strings
 415            /// displayed in a different language. This parameter and the Accept-Language
 416            /// header are mutually exclusive; do not specify both. A user interface string
 417            /// is a string that's used as a label in a user interface. There are few user
 418            /// interface strings in the JSON response objects. Also, any links to Bing.com
 419            /// properties in the response objects apply the specified language.
 420            /// </param>
 421            /// <param name='cancellationToken'>
 422            /// The cancellation token.
 423            /// </param>
 424            public static async Task<SearchResponse> SearchAsync(this ILocal operations, string query, string acceptLang
 425            {
 0426                using (var _result = await operations.SearchWithHttpMessagesAsync(query, acceptLanguage, pragma, userAge
 427                {
 0428                    return _result.Body;
 429                }
 0430            }
 431
 432    }
 433}
Generated by: ReportGenerator 4.6.4.0
8/12/2020 - 3:47:14 PM
GitHub | www.palmmedia.de

Methods/Properties

Search(...)
SearchAsync()