at.mukprojects.giphy4j

Class Giphy

java.lang.Object

at.mukprojects.giphy4j.Giphy

public class Giphy
extends Object

This class represents the main API.

Author:

Mathias Markl

Constructor Summary

Constructors

Constructor and Description
Giphy(String apiKey) Constructs a new Giphy object.

Method Summary

Modifier and Type	Method and Description
SearchFeed	search(String query, int offset) Returns a SearchFeed object.
SearchFeed	search(String query, int limit, int offset) Returns a SearchFeed object.
SerachGiphy	searchByID(String id) Returns a SerachGiphy object.
SearchFeed	searchSticker(String query, int offset) Returns a SearchFeed object.
SearchFeed	searchSticker(String query, int limit, int offset) Returns a SearchFeed object.
SerachGiphy	translate(String query) Returns a SerachGiphy object.
SerachGiphy	translateSticker(String query) Returns a SerachGiphy object.
SearchFeed	trend() Returns a SearchFeed object.
SearchFeed	trendSticker() Returns a SearchFeed object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Giphy

public Giphy(String apiKey)

Constructs a new Giphy object.

Parameters:

apiKey - The API key.

Method Detail

search

public SearchFeed search(String query,
                         int offset)
                  throws GiphyException

Returns a SearchFeed object.

Parameters:

query - The query parameters. Multiple parameters are separated by a space.

offset - The offset.

Returns:

Returns a SearchFeed object.

Throws:

GiphyException - If an error occurs a exception is thrown.

search

public SearchFeed search(String query,
                         int limit,
                         int offset)
                  throws GiphyException

Returns a SearchFeed object.

Parameters:

query - The query parameters. Multiple parameters are separated by a space.

limit - The result limit. The maximum is 100.

offset - The offset.

Returns:

Returns a SearchFeed object.

Throws:

GiphyException - If an error occurs a exception is thrown.

searchByID

public SerachGiphy searchByID(String id)
                       throws GiphyException

Returns a SerachGiphy object.

Parameters:

id - The Giphy id.

Returns:

Returns a SerachGiphy object.

Throws:

GiphyException - If an error occurs a exception is thrown.

translate

public SerachGiphy translate(String query)
                      throws GiphyException

Returns a SerachGiphy object.

Parameters:

query - The query parameters.

Returns:

Returns a SerachGiphy object.

Throws:

GiphyException - If an error occurs a exception is thrown.

trend

public SearchFeed trend()
                 throws GiphyException

Returns a SearchFeed object.

Returns:

Returns a SearchFeed object.

Throws:

GiphyException - If an error occurs a exception is thrown.

searchSticker

public SearchFeed searchSticker(String query,
                                int offset)
                         throws GiphyException

Returns a SearchFeed object.

Parameters:

query - The query parameters. Multiple parameters are separated by a space.

offset - The offset.

Returns:

Returns a SearchFeed object.

Throws:

GiphyException - If an error occurs a exception is thrown.

searchSticker

public SearchFeed searchSticker(String query,
                                int limit,
                                int offset)
                         throws GiphyException

Returns a SearchFeed object.

Parameters:

query - The query parameters. Multiple parameters are separated by a space.

limit - The result limit. The maximum is 100.

offset - The offset.

Returns:

Returns a SearchFeed object.

Throws:

GiphyException - If an error occurs a exception is thrown.

translateSticker

public SerachGiphy translateSticker(String query)
                             throws GiphyException

Returns a SerachGiphy object.

Parameters:

query - The query parameters.

Returns:

Returns a SerachGiphy object.

Throws:

GiphyException - If an error occurs a exception is thrown.

trendSticker

public SearchFeed trendSticker()
                        throws GiphyException

Returns a SearchFeed object.

Returns:

Returns a SearchFeed object.

Throws:

GiphyException - If an error occurs a exception is thrown.