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.
Giphy(String apiKey, RequestSender sender) Constructs a new HttpRequestSender object.

Method Summary

Modifier and Type	Method and Description
SearchFeed	search(String query, int offset) Search all Giphy GIFs for a word or phrase and returns a SearchFeed object.
SearchFeed	search(String query, int limit, int offset) Search all Giphy GIFs for a word or phrase and returns a SearchFeed object.
SearchGiphy	searchByID(String id) Returns a SerachGiphy object.
SearchRandom	searchRandom(String tag) Returns a random GIF, limited by tag.
SearchRandom	searchRandomSticker(String tag) Returns a random GIF, limited by tag.
SearchFeed	searchSticker(String query, int offset) Search all Giphy Sticker GIFs for a word or phrase and returns a SearchFeed object.
SearchFeed	searchSticker(String query, int limit, int offset) Search all Giphy Sticker GIFs for a word or phrase and returns a SearchFeed object.
SearchGiphy	translate(String query) The translate API draws on search, but also translates from one vocabulary to another.
SearchGiphy	translateSticker(String query) The translate API draws on search, but also translates from one vocabulary to another.
SearchFeed	trend() Fetch GIFs currently trending online.
SearchFeed	trendSticker() Fetch GIFs currently trending online.

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 GiphyAPI key

Giphy

public Giphy(String apiKey,
             RequestSender sender)

Constructs a new HttpRequestSender object.

It's recommended to use the simple constructor without a sender argument. This one is just for testing purposes or in case you want to use the sender with different settings.

Parameters:

apiKey - the GiphyAPI key

sender - the sender object

Method Detail

search

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

Search all Giphy GIFs for a word or phrase and returns a SearchFeed object.

Be aware that not every response has all information available. In that case the value will be returned as null.

Parameters:

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

offset - the offset

Returns:

the SearchFeed object

Throws:

GiphyException - if an error occurs during the search

search

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

Search all Giphy GIFs for a word or phrase and returns a SearchFeed object.

Be aware that not every response has all information available. In that case the value will be returned as null.

Parameters:

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

limit - the result limit. The maximum is 100.

offset - the offset

Returns:

the SearchFeed object

Throws:

GiphyException - if an error occurs during the search

searchByID

public SearchGiphy searchByID(String id)
                       throws GiphyException

Returns a SerachGiphy object.

Be aware that not every response has all information available. In that case the value will be returned as null.

Parameters:

id - the Giphy id

Returns:

the SerachGiphy object

Throws:

GiphyException - if an error occurs during the search

translate

public SearchGiphy translate(String query)
                      throws GiphyException

The translate API draws on search, but also translates from one vocabulary to another. In this case, words and phrases to GIFs.

Be aware that not every response has all information available. In that case the value will be returned as null.

Parameters:

query - the query parameters

Returns:

the SerachGiphy object

Throws:

GiphyException - if an error occurs during the search

searchRandom

public SearchRandom searchRandom(String tag)
                          throws GiphyException

Returns a random GIF, limited by tag.

Be aware that not every response has all information available. In that case the value will be returned as null.

Parameters:

tag - the GIF tag to limit randomness

Returns:

the SerachGiphy object

Throws:

GiphyException - if an error occurs during the search

trend

public SearchFeed trend()
                 throws GiphyException

Fetch GIFs currently trending online. Hand curated by the Giphy editorial team. The data returned mirrors the GIFs showcased on the Giphy homepage. Returns 25 results by default.

Be aware that not every response has all information available. In that case the value will be returned as null.

Returns:

the SearchFeed object

Throws:

GiphyException - if an error occurs during the search

searchSticker

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

Search all Giphy Sticker GIFs for a word or phrase and returns a SearchFeed object.

Be aware that not every response has all information available. In that case the value will be returned as null.

Parameters:

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

offset - the offset

Returns:

the SearchFeed object

Throws:

GiphyException - if an error occurs during the search

searchSticker

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

Search all Giphy Sticker GIFs for a word or phrase and returns a SearchFeed object.

Be aware that not every response has all information available. In that case the value will be returned as null.

Parameters:

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

limit - the result limit. The maximum is 100.

offset - the offset

Returns:

the SearchFeed object

Throws:

GiphyException - if an error occurs during the search

translateSticker

public SearchGiphy translateSticker(String query)
                             throws GiphyException

The translate API draws on search, but also translates from one vocabulary to another. In this case, words and phrases to GIFs.

Be aware that not every response has all information available. In that case the value will be returned as null.

Parameters:

query - the query parameters

Returns:

the SerachGiphy object

Throws:

GiphyException - if an error occurs during the search

trendSticker

public SearchFeed trendSticker()
                        throws GiphyException

Fetch GIFs currently trending online. Hand curated by the Giphy editorial team. The data returned mirrors the GIFs showcased on the Giphy homepage. Returns 25 results by default.

Be aware that not every response has all information available. In that case the value will be returned as null.

Returns:

the SearchFeed object

Throws:

GiphyException - if an error occurs during the search

searchRandomSticker

public SearchRandom searchRandomSticker(String tag)
                                 throws GiphyException

Returns a random GIF, limited by tag.

Be aware that not every response has all information available. In that case the value will be returned as null.

Parameters:

tag - the GIF tag to limit randomness

Returns:

the SerachGiphy object

Throws:

GiphyException - if an error occurs during the search