GiphySettings class

A configuration class for Giphy settings.

Constructors

GiphySettings.new({GiphyTheme theme = GiphyTheme.automaticTheme, List<GiphyContentType> mediaTypeConfig = const [GiphyContentType.recents, GiphyContentType.gif, GiphyContentType.sticker, GiphyContentType.text, GiphyContentType.emoji, GiphyContentType.clips], bool showConfirmationScreen = false, GiphyRating rating = GiphyRating.pg13, GiphyRendition? renditionType, GiphyClipsRendition? clipsPreviewRenditionType, GiphyRendition? confirmationRenditionType, bool showCheckeredBackground = false, int stickerColumnCount = 3, GiphyContentType selectedContentType = GiphyContentType.gif, bool showSuggestionsBar = true, bool enableDynamicText = false, GiphyFileFormat fileFormat = GiphyFileFormat.webp, bool disableEmojiVariations = false})
Constructs an instance of GiphySettings with the given settings.
const

Properties

clipsPreviewRenditionType GiphyClipsRendition?
The specific rendition type to use for clip previews.
final
confirmationRenditionType GiphyRendition?
A rendition type for the confirmation screen.
final
disableEmojiVariations bool
If true, disables variations of emojis.
final
enableDynamicText bool
If true, allows to create animated text results for search queries where there are no matching results in GIPHY's library.
final
fileFormat GiphyFileFormat
A file format for the grid.
final
hashCode int
The hash code for this object.
no setterinherited
mediaTypeConfig List<GiphyContentType>
Type(s) of content to be displayed in the dialog.
final
rating GiphyRating
A specific content rating for the search results.
final
renditionType GiphyRendition?
A rendition type for the grid.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectedContentType GiphyContentType
The default Giphy Content-Type.
final
showCheckeredBackground bool
Enable/disable the checkered background for stickers and text media type.
final
showConfirmationScreen bool
Show a secondary confirmation screen when the user taps a GIF, which shows a larger rendition of the asset.
final
showSuggestionsBar bool
If true, shows the suggestions bar.
final
stickerColumnCount int
For carousel layouts, we provide the option to set the number of columns for stickers and text. We recommend using 3 columns for blurred mode.
final
theme GiphyTheme
The theme to use for the Giphy UI.
final

Methods

copyWith({GiphyTheme? theme, List<GiphyContentType>? mediaTypeConfig, bool? showConfirmationScreen, GiphyRating? rating, GiphyRendition? renditionType, GiphyClipsRendition? clipsPreviewRenditionType, GiphyRendition? confirmationRenditionType, bool? showCheckeredBackground, int? stickerColumnCount, GiphyContentType? selectedContentType, bool? showSuggestionsBar, bool? enableDynamicText, GiphyFileFormat? fileFormat, bool? disableEmojiVariations}) GiphySettings
Creates a copy of this settings object with the given overrides.
isContentTypeEnabled(GiphyContentType contentType) bool
Checks if a specific content type is enabled in the configuration.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Converts this settings object into a JSON map.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited