GiphyClient class
A client for GIPHY
Sign up for the mandatory API key for each supported platform at developers.giphy.com, compare https://developers.giphy.com/docs/api#quick-start-guide for details.
Constructors
- GiphyClient({required String apiKey, String? randomId})
-
Creates a new client with the given
apiKey
.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
byId(
String id) → Future< GiphyGif> -
Retrieves the GIF with the given
id
. -
close(
) → void - Closes the client and cleans up any resources associated with it.
-
emojis(
{GiphyRating rating = GiphyRating.g, String lang = GiphyLanguage.english}) → Future< GiphySource> - Retrieves the emojis of GIPHY
-
emojisCollection(
{int offset = 0, int limit = _defaultLimit, GiphyRating rating = GiphyRating.g, String lang = GiphyLanguage.english}) → Future< GiphyCollection> - Retrieves a single collection page of the emojis.
-
getRandomId(
) → Future< String> - Retrieves a random ID that can be used to personalize the experience for the associated user
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
random(
{required String tag, GiphyRating rating = GiphyRating.g, GiphyType type = GiphyType.gifs}) → Future< GiphyGif> -
Gets a random GIF that matches the given
tag
-
request(
GiphyRequest request) → Future< GiphySource> -
Requests a
GiphySource
from the given request. -
search(
String query, {GiphyRating rating = GiphyRating.g, String lang = GiphyLanguage.english, GiphyType type = GiphyType.gifs}) → Future< GiphySource> -
Searches for GIFs or Stickers with the given search
query
. -
searchCollection(
String query, {int offset = 0, int limit = _defaultLimit, GiphyRating rating = GiphyRating.g, String lang = GiphyLanguage.english, GiphyType type = GiphyType.gifs}) → Future< GiphyCollection> -
Retrieves a single collection page of the give search
query
. -
toString(
) → String -
A string representation of this object.
inherited
-
trending(
{GiphyRating rating = GiphyRating.g, String lang = GiphyLanguage.english, GiphyType type = GiphyType.gifs}) → Future< GiphySource> - Retrieve the trending GIFs or Stickers.
-
trendingCollection(
{int offset = 0, int limit = _defaultLimit, GiphyRating rating = GiphyRating.g, String lang = GiphyLanguage.english, GiphyType type = GiphyType.gifs}) → Future< GiphyCollection> - Retrieves a single collection page of the trending GIFs or Stickers.
-
trendingSearchTerms(
) → Future< List< String> > - Retrieves the trending search terms (English only)
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited