kotlin-components-docs/mozilla.appservices.merino

Package-level declarations

Types

CuratedRecommendationLocale

enum CuratedRecommendationLocale : Enum<CuratedRecommendationLocale>

CuratedRecommendationsApiException

sealed class CuratedRecommendationsApiException : Exception

CuratedRecommendationsBucket

data class CuratedRecommendationsBucket(var recommendations: List<RecommendationDataItem>, var title: String? = null)

CuratedRecommendationsClient

open class CuratedRecommendationsClient : Disposable, AutoCloseable, CuratedRecommendationsClientInterface

CuratedRecommendationsClientInterface

interface CuratedRecommendationsClientInterface

CuratedRecommendationsRequest

data class CuratedRecommendationsRequest( var locale: CuratedRecommendationLocale, var region: String? = null, var count: Int? = 100, var topics: List<String>? = null, var feeds: List<String>? = null, var sections: List<SectionSettings>? = null, var experimentName: String? = null, var experimentBranch: String? = null, var enableInterestPicker: Boolean = false)

CuratedRecommendationsResponse

data class CuratedRecommendationsResponse( var recommendedAt: Long, var data: List<RecommendationDataItem>, var feeds: Feeds? = null, var interestPicker: InterestPicker? = null)

Disposable

interface Disposable

FakespotCta

data class FakespotCta(var ctaCopy: String, var url: String)

FakespotFeed

data class FakespotFeed( var products: List<FakespotProduct>, var defaultCategoryName: String, var headerCopy: String, var footerCopy: String, var cta: FakespotCta)

FakespotProduct

data class FakespotProduct(var id: String, var title: String, var category: String, var imageUrl: String, var url: String)

Feeds

data class Feeds( var needToKnow: CuratedRecommendationsBucket? = null, var fakespot: FakespotFeed? = null, var topStoriesSection: FeedSection? = null, var business: FeedSection? = null, var career: FeedSection? = null, var arts: FeedSection? = null, var food: FeedSection? = null, var health: FeedSection? = null, var home: FeedSection? = null, var finance: FeedSection? = null, var government: FeedSection? = null, var sports: FeedSection? = null, var tech: FeedSection? = null, var travel: FeedSection? = null, var education: FeedSection? = null, var hobbies: FeedSection? = null, var societyParenting: FeedSection? = null, var educationScience: FeedSection? = null, var society: FeedSection? = null)

FeedSection

data class FeedSection( var receivedFeedRank: Int, var recommendations: List<RecommendationDataItem>, var title: String, var subtitle: String? = null, var layout: Layout, var isFollowed: Boolean, var isBlocked: Boolean)

InterestPicker

data class InterestPicker(var receivedFeedRank: Int, var title: String, var subtitle: String, var sections: List<InterestPickerSection>)

InterestPickerSection

data class InterestPickerSection(var sectionId: String)

InternalException

class InternalException(message: String) : Exception

Layout

data class Layout(var name: String, var responsiveLayouts: List<ResponsiveLayout>)

RecommendationDataItem

data class RecommendationDataItem( var corpusItemId: String, var scheduledCorpusItemId: String, var url: String, var title: String, var excerpt: String, var topic: String? = null, var publisher: String, var isTimeSensitive: Boolean, var imageUrl: String, var iconUrl: String?, var tileId: Long, var receivedRank: Long)

ResponsiveLayout

data class ResponsiveLayout(var columnCount: Int, var tiles: List<Tile>)

SectionSettings

data class SectionSettings(var sectionId: String, var isFollowed: Boolean, var isBlocked: Boolean)

Tile

data class Tile(var size: String, var position: Int, var hasAd: Boolean, var hasExcerpt: Boolean)