BaseResult

sealed class BaseResult

A BaseResult is the root type of a result that can be added to a scrolling list of media.

Note: Currently, only BaseResult.Image is available.

Summary

Classes
Image Type of BaseResult

Classes

Image

class Image(
    image: List<BaseMedia>,
    thumbnail: List<BaseMedia>?,
    placeholder: List<BaseMedia>?,
    link: String?,
    label: String?,
    source: Any?,
    theme: AppTheme,
    sourceQuery: String? = null
) : BaseResult(source, theme, sourceQuery)

Type of BaseResult

Parameters
image: List<BaseMedia> A list of available media for a result, in all available formats. These media objects are used for sharing.
thumbnail: List<BaseMedia>? An optional list of thumbnail media, in all available formats. These media objects are used for the image carousels.
placeholder: List<BaseMedia>? An optional list of placeholder media, in all available formats. These media objects will be displayed while the thumbnails load.
link: String? The link that will be used when sharing this media.
label: String? The label or title that will be used when sharing this media.
source: Any? An optional source of this result that can be used during analytics generation.
theme: AppTheme The theme at the time this item was created.
sourceQuery: String? = null An optional query source of this result that can be used during analytics generation.

If something needs to be added or if you find an error in our documentation, please let us know either on our GitHub or Discord.

Last updated on June 16, 2023