Skip to content

Extension API

Jump to bottom
Uwe Trottmann edited this page Nov 23, 2017 · 33 revisions

Learn how to build an extension for SeriesGuide.

If added by the user in SeriesGuide, an extension can provide an action button shown below an episode or movie.

The button might link to external content (app deep-link, web page, ...) or trigger an action in another app (play, record, ...). Or it can just display some status information (e.g. "downloaded"). Have a look at the available extensions on Google Play.

Extensions examples

Get started

  1. Add the API dependency to your Android project:
    implementation 'com.uwetrottmann.seriesguide:seriesguide-api:2.0.0'
    The artifact is published on Maven Central.
  2. Create a new class that extends SeriesGuideExtension and implements at least one of the onRequest methods.
  3. Create a new class that extends SeriesGuideExtensionReceiver.
  4. Add the required tags to your AndroidManifest.xml file. Read the class documentation of SeriesGuideExtension for details.

Install your extension side-by-side with SeriesGuide. You should be able to add it from the extension customization screen. The activity of this screen, com.battlelancer.seriesguide.extensions.ExtensionsConfigurationActivity, is also exported so you can directly start it if you want to direct users to it.

Example extension

An example extension Android project for Android Studio is available.

API Reference

Take a look at the API reference documentation for additional details, for example to add a configuration screen.

Change log

2.0.2 (2017-11-23, supported as of SeriesGuide 40-beta5)

  • Extensions now publish actions via sendBroadcast(Intent) instead of startService(Intent). This is to handle an edge case where SeriesGuide was idle and the extension would crash when publishing an action on Android O.
  • Until your extension is updated its actions will not be displayed in SeriesGuide. It will stay enabled though.

2.0.0 (2017-11-10, supported as of SeriesGuide 40-beta4)

  • Extensions must now be registered through a <receiver> component instead of a <service>. This is required to work around background restrictions introduced for apps targeting SDK 26. You can subclass the new SeriesGuideExtensionReceiver and copy the properties of your existing <service> component in your manifest to the new <receiver> tag.
  • SeriesGuideExtension now implements JobIntentService instead of IntentService. This requires your subclass to be exported and given the BIND_JOB_SERVICE permission in your manifest. In addition, on SDK 25 and lower the library will add the WAKE_LOCK permission required by JobIntentService to your manifest.
  • Existing extensions will be disabled when updating to SeriesGuide 40. They can be enabled again by the user (assuming they have been updated as stated above).
  • See the example project for guidance on how to keep your existing SeriesGuideExtension subclass and manifest tags for compatibility with old versions of SeriesGuide.

1.4.0 (2017-10-28)

  • Converted the library to an Android library (AAR).

1.3.0 (2016-09-22, supported as of SeriesGuide 33-beta1)

  • Add show release date to Episode. Formatted as an ISO string, for example: 2016-09-22T02:00:00.000Z.
  • Support for movies. Added Movie and an additonal onRequest method specific for movie actions. Extensions can choose if to implement episode or movie actions, or both.

1.2.0 (2015-07-13, supported as of SeriesGuide 24-beta3)

1.1.1 (2014-08-21)

  • Updated Intents helper class to create intents that do not create new tasks.

1.1.0 (2014-04-02)

  • Create Intents class to create intents for viewing shows or episodes with SeriesGuide.

1.0.1 (2014-03-26)

  • Initial release. Extensions can provide actions for episodes.
Clone this wiki locally