Package xyz.thegrapevine.jnewsapi

Class NewsClient

java.lang.Object

xyz.thegrapevine.jnewsapi.NewsClient

public class NewsClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
NewsClient(java.lang.String key)	Instantiates the news client.

Method Summary

Modifier and Type	Method	Description
EverythingResponse	everything(HTTPParameter... args)	Returns everything related to a query.
SourcesResponse	sources(HTTPParameter... args)	Returns a detailed list of sources.
TopHeadlinesResponse	topHeadlines(HTTPParameter... args)	Gets the top headlines of the day.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NewsClient

public NewsClient(java.lang.String key)

Instantiates the news client.

Parameters:

key - Token to connect to the API with.

Method Detail

topHeadlines

public TopHeadlinesResponse topHeadlines(HTTPParameter... args)
                                  throws NewsAPIException

Gets the top headlines of the day.

Parameters:

args - Array of parameters to pass to the client.

Returns:

A TopHeadlinesResponse object.

Throws:

NewsAPIException - A custom exception for the client.

sources

public SourcesResponse sources(HTTPParameter... args)
                        throws NewsAPIException

Returns a detailed list of sources.

Parameters:

args - Array of parameters to pass to the client.

Returns:

A SourcesResponse object.

Throws:

NewsAPIException - A custom exception for the client.

everything

public EverythingResponse everything(HTTPParameter... args)
                              throws NewsAPIException

Returns everything related to a query.

Parameters:

args - Array of parameters to pass to the client.

Returns:

A EverythingResponse object.

Throws:

NewsAPIException - A custom exception for the client.