https://github.com/paulkinlan/webintents

A client side service discovery and execution model.
https://github.com/paulkinlan/webintents

Last synced: about 1 month ago
JSON representation

A client side service discovery and execution model.

• Host: GitHub
• URL: https://github.com/paulkinlan/webintents
• Owner: PaulKinlan
• License: apache-2.0
• Created: 2011-06-13T21:30:43.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2020-10-01T20:19:53.000Z (over 4 years ago)
• Last Synced: 2025-04-04T13:23:51.589Z (about 1 month ago)
• Language: JavaScript
• Homepage: http://webintents.org/
• Size: 22 MB
• Stars: 476
• Watchers: 15
• Forks: 49
• Open Issues: 55
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Web Intents

===========

Web Intents is a discovery mechanism and extremely light-weight RPC system between web apps, modeled after the similarly-named system in Android.  An Intent is an action to be performed by a provider.  Intents provides a declarative syntax that allows providers to list the Intents they handle and a registration system that enumerates available providers.  A client requests an Intent be handled, the User Agent allows the user to select which provider to use, and the provider performs the action of the Intent, possibly using data passed as input in the Intent.  The provider may return data as output to the client.

Usage

=====

To use today

------------

No browsers currently support this API natively.  To use this system simple drop the following code in to your site:

    

When browsers start to implement this natively the Shim will defer all its functionality to the native interface.

Declaration

-----------

To register your service application to be able to handle image sharing simply declare an intent tag.

    

This will register the current page's ability to share images. 

Invocation

----------

To build a client application that can use the share functionality, it is as simple as using the following code: 

    var intent = new Intent(

        "http://webintents.org/share", 

        "image/*", 

        "http://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/Three_jolly_kittens.png/800px-Three_jolly_kittens.png" 

    );

    window.navigator.startActivity(intent);

Service

-------

When a service is invoked via startActivity, the "intent" object on window will be populated with the data provided by the client.

    window.intent

That's it.

To send data back to the client that invoked it, it is as simple as calling postResult() on the intent.

    window.intent.postResult("something cool");

Building

========

Prerequisites:

Node.js: http://nodejs.org/

NPM: http://npmjs.org/

    uglify-js: npm -g install uglify-js

    

    ./make all

This will build and minify both the server and client components.

Building Tools

--------------

The tools are a collection of all the apps and extensions that are currently live and available on the web.

    ./make tools

Building Apps

-------------

The apps are a subset of tools, are fully formed, live web apps such as cloudfilepicker.com

    ./make apps

Building Extensions

-------------------

The extensions are a subset of tools and are fully formed extensions for browsers that support intents.

    ./make extensions

Running

=======

Prerequisites:

AppEngine: http://appengine.google.com/

nginx: http://nginx.org/en/

To run the server locally:

    ./server/run.sh

The server will not be set up on port 80 or webintents.org so will need to do the following:

1) Edit /etc/hosts - add the following "127.0.0.1 webintents.org"

2) Start nginx using using the configuration in https://github.com/PaulKinlan/WebIntents/tree/master/conf