com.microsoft.azure.cognitiveservices.search.newssearch

Interface BingNews

public interface BingNews

An instance of this class provides access to all the operations defined in BingNews.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BingNews.BingNewsCategoryDefinition The entirety of category definition.
static interface	BingNews.BingNewsCategoryDefinitionStages Grouping of category definition stages.
static interface	BingNews.BingNewsSearchDefinition The entirety of search definition.
static interface	BingNews.BingNewsSearchDefinitionStages Grouping of search definition stages.
static interface	BingNews.BingNewsTrendingDefinition The entirety of trending definition.
static interface	BingNews.BingNewsTrendingDefinitionStages Grouping of trending definition stages.

Method Summary

Modifier and Type	Method and Description
BingNews.BingNewsCategoryDefinitionStages.WithExecute	category() The News Category API lets lets you search on Bing and get back a list of top news articles by category.
NewsModel	category(CategoryOptionalParameter categoryOptionalParameter) The News Category API lets lets you search on Bing and get back a list of top news articles by category.
rx.Observable<NewsModel>	categoryAsync(CategoryOptionalParameter categoryOptionalParameter) The News Category API lets lets you search on Bing and get back a list of top news articles by category.
BingNews.BingNewsSearchDefinitionStages.WithQuery	search() The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query.
NewsModel	search(String query, SearchOptionalParameter searchOptionalParameter) The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query.
rx.Observable<NewsModel>	searchAsync(String query, SearchOptionalParameter searchOptionalParameter) The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query.
BingNews.BingNewsTrendingDefinitionStages.WithExecute	trending() The News Trending Topics API lets lets you search on Bing and get back a list of trending news topics that are currently trending on Bing.
TrendingTopics	trending(TrendingOptionalParameter trendingOptionalParameter) The News Trending Topics API lets lets you search on Bing and get back a list of trending news topics that are currently trending on Bing.
rx.Observable<TrendingTopics>	trendingAsync(TrendingOptionalParameter trendingOptionalParameter) The News Trending Topics API lets lets you search on Bing and get back a list of trending news topics that are currently trending on Bing.

Method Detail

search

NewsModel search(String query,
                 SearchOptionalParameter searchOptionalParameter)

The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).

Parameters:

query - The user's search query string. The query string cannot be empty. The query string may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit news to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the News Search API. Do not specify this parameter when calling the Trending Topics API or News Category API.

searchOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the NewsModel object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

searchAsync

rx.Observable<NewsModel> searchAsync(String query,
                                     SearchOptionalParameter searchOptionalParameter)

The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).

Parameters:

query - The user's search query string. The query string cannot be empty. The query string may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit news to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the News Search API. Do not specify this parameter when calling the Trending Topics API or News Category API.

searchOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the NewsModel object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

search

BingNews.BingNewsSearchDefinitionStages.WithQuery search()

The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).

Returns:

the first stage of the search call

category

NewsModel category(CategoryOptionalParameter categoryOptionalParameter)

The News Category API lets lets you search on Bing and get back a list of top news articles by category. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).

Parameters:

categoryOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the NewsModel object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

categoryAsync

rx.Observable<NewsModel> categoryAsync(CategoryOptionalParameter categoryOptionalParameter)

The News Category API lets lets you search on Bing and get back a list of top news articles by category. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).

Parameters:

categoryOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the NewsModel object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

category

BingNews.BingNewsCategoryDefinitionStages.WithExecute category()

The News Category API lets lets you search on Bing and get back a list of top news articles by category. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).

Returns:

the first stage of the category call

trending

TrendingTopics trending(TrendingOptionalParameter trendingOptionalParameter)

The News Trending Topics API lets lets you search on Bing and get back a list of trending news topics that are currently trending on Bing. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).

Parameters:

trendingOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the TrendingTopics object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

trendingAsync

rx.Observable<TrendingTopics> trendingAsync(TrendingOptionalParameter trendingOptionalParameter)

The News Trending Topics API lets lets you search on Bing and get back a list of trending news topics that are currently trending on Bing. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).

Parameters:

trendingOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the TrendingTopics object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

trending

BingNews.BingNewsTrendingDefinitionStages.WithExecute trending()

The News Trending Topics API lets lets you search on Bing and get back a list of trending news topics that are currently trending on Bing. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).

Returns:

the first stage of the trending call