Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.12 KB

README.md

File metadata and controls

24 lines (17 loc) · 1.12 KB
Raw

Android Components > Service > Pocket

A library for easily getting Pocket recommendations that transparently handles downloading, caching and periodically refreshing Pocket data. Currently this supports Pocket recommended stories.

Usage

  • Use PocketStoriesService#startPeriodicStoriesRefresh and PocketStoriesService#stopPeriodicStoriesRefresh as high up in the client app as possible (preferably in the Application object or in a single Activity) to ensure the background story refresh functionality works for the entirety of the app lifetime.
  • Use PocketStoriesService.getStories to get the current list of Pocket recommended stories.

Setting up the dependency

Use Gradle to download the library from maven.mozilla.org (Setup repository):

implementation "org.mozilla.components:service-pocket:{latest-version}"

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/