android-components / mozilla.components.service.pocket.data / PocketGlobalVideoRecommendation

PocketGlobalVideoRecommendation

data class PocketGlobalVideoRecommendation (source)

A recommended video as returned from the Pocket Global Video Recommendation endpoint v2.

Types

Name Summary
Author data class Author
An author or publisher of a PocketGlobalVideoRecommendation.

Properties

Name Summary
authors val authors: List<Author>
the authors or publishers of this recommendation; unclear if this can be empty.
domain val domain: String
the domain where the video appears, e.g. “youtube.com”.
excerpt val excerpt: String
a summary of the video.
id val id: Long
a unique identifier for this recommendation.
imageSrc val imageSrc: String
a url to a still image representing the video.
popularitySortId val popularitySortId: Int
the index of this recommendation in the list if the list was sorted by popularity.
publishedTimestamp val publishedTimestamp: String
unknown: please ask for clarification if needed. This may be “0”.
sortId val sortId: Int
the index of this recommendation in the list which is sorted by date added to the API results.
title val title: String
the title of the video.
tvURL val tvURL: String
a url to the video on pages formatted for TV form factors (e.g. YouTube.com/tv).
url val url: String
a url to the video.

Extension Functions

Name Summary
loadResourceAsString fun Any.loadResourceAsString(path: String): String
Loads a file from the resources folder and returns its content as a string object.