Service Integration Development

Introduction

Service integration scripts live in a web browser engine (WebKitGtk+) and are written in JavaScript. Since the major responsibility of these scripts is to extract information from a web page and interact with it, you need a good knowledge of HTML and Document Object Model API.

Service integrations are maintained as git repositories at Github. Although it isn't strictly required, experiences with Git version control system and Github code hosting platform are very appreciated. Otherwise you can distribute your work in tar archives and we will create and maintain a Git repository for you, but it will obviously increase maintenance burden of the project.

Documentation

Basic

• Service Integration Tutorial: This guide briefly describes creation of a new service integration for Nuvola Runtime from scratch. Then you should be ready to create your service integration.
• Service Integration Guidelines: These rules apply if you would like to have your service integration maintained as a part of the Nuvola Apps project and distributed in the Nuvola Apps repository.
• NuvolaKit JavaScript API reference.

Advanced

• Web View Snapshot: Web view snapshots are combined with base screenshots of Nuvola integration features to create final screenshots for AppStream metadata.
• URL Filtering (URL Sandbox): Decide which urls are opened in a default web browser instead of Nuvola Player.
• Configuration and session storage: Nuvola Runtime allows service integrations to store both a persistent configuration and a temporary session information.
• Initialization and Preferences Forms: These forms are useful when you need to get user input.
• Web apps with a variable home page URL: This article covers Web apps that don't have a single (constant) home page URL, so their home page has to be specified by user.
• Custom Actions: This article covers API that allows you to add custom actions like thumbs up/down rating.
• Translations: How to mark translatable strings for Gettext-based translations framework for service integration scripts.