Documentation/Maemo 5 Developer Guide/Using Data Sharing/Sharing Plug-in - Revision history

imported_>amigadave: use and `, wikify slightly, tidy`


2010-08-10T15:28:47Z
use <source> and <code>, wikify slightly, tidy
Show changes



imported_>agarcia: /* Getting Your Dummy Plugin To Sharing Menus */ Fix link to sharing-plugin-template
2010-08-04T11:04:48Z
Getting Your Dummy Plugin To Sharing Menus:  Fix link to sharing-plugin-template

				
				
				
				
				
				← Older revision
				Revision as of 11:04, 4 August 2010
				
Line 131:
Line 131:
As a pre-requisite, you will need a working Maemo 5 SDK to continue further. As a pre-requisite, you will need a working Maemo 5 SDK to continue further.
We will first install the Sharing Plug-in template: We will first install the Sharing Plug-in template:
*Obtain the template source code ''sharing-plugin-template-0.1.tar.gz'' from <URL HERE>. It contains a good start up file structure for the plug-in creation. *Obtain the template source code ''sharing-plugin-template-0.1.tar.gz'' from [https://garage.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ the maemoexamples repository]. It contains a good start up file structure for the plug-in creation.
*Extract and build the package from the folder using command: *Extract and build the package from the folder using command:
  ./autogen.sh; dpkg-buildpackage -rfakeroot -d   ./autogen.sh; dpkg-buildpackage -rfakeroot -d



imported_>alexzk24: /* Service XML File */
2010-05-28T21:49:42Z
Service XML File

				
				
				
				
				
				← Older revision
				Revision as of 21:49, 28 May 2010
				
Line 177:
Line 177:
         <icon type="setup">@servicesdir@/template-setup.png</icon>            <icon type="setup">@servicesdir@/template-setup.png</icon>  
         <options>            <options>  
        	<option id="privacy" type="enumeration" default="private">               <option id="privacy" type="enumeration" default="private">  
                 <caption domain="osso-sharing-ui" key="share_bd_options_privacy"/>                    <caption domain="osso-sharing-ui" key="share_bd_options_privacy"/>  
                 <value id="private" domain="osso-sharing-ui" key="share_fi_options_privacy_private"/>                    <value id="private" domain="osso-sharing-ui" key="share_fi_options_privacy_private"/>  



79.237.138.216: /* Using Sharing dialog API */
2010-05-23T16:19:48Z
Using Sharing dialog API

				
				
				
				
				
				← Older revision
				Revision as of 16:19, 23 May 2010
				
Line 1:
Line 1:
=Using Sharing dialog API= =Using Sharing dialog API=
With Sharing dialog API user can open the  first dialog, which start the Sharing flow. From the first dialog user can select "Send via Bluetooth", "Send via E-mail" and "Share via servive". With Sharing dialog API user can open the  first dialog, which start the Sharing flow. From the first dialog user can select "Send via Bluetooth", "Send via E-mail" and "Share via service".



More detailed API documentation can be found from [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin here]. More detailed API documentation can be found from [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin here].



imported_>amigadave: /* Sharing your plugin with others */ wikify link
2010-03-31T07:16:21Z
Sharing your plugin with others:  wikify link

				
				
				
				
				
				← Older revision
				Revision as of 07:16, 31 March 2010
				
Line 429:
Line 429:



==Sharing your plugin with others== ==Sharing your plugin with others==
Maemo Extras repository is the best place for your plug-in if you want to get users for it. More information on how you can upload packages to Extras repository can be found [[http://wiki.maemo.org/Uploading_to_Extras here]]. Maemo Extras repository is the best place for your plug-in if you want to get users for it. More information on how you can [[Uploading to Extras-devel|upload packages to Extras repository]] is available.



Before uploading plugin to public repositories make sure you have updated the debian configuration files to match your information under ./debian folder. Before uploading plugin to public repositories make sure you have updated the debian configuration files to match your information under ./debian folder.



imported_>amigadave: categorise
2010-02-12T12:54:03Z
categorise

				
				
				
				
				
				← Older revision
				Revision as of 12:54, 12 February 2010
				
Line 444:
Line 444:
     libsharing-plugin-dev      libsharing-plugin-dev
  Standards-Version: 3.8.0   Standards-Version: 3.8.0

[[Category:Development]]
[[Category:Documentation]]
[[Category:Fremantle]]



imported_>tapio at 15:11, 11 February 2010
2010-02-11T15:11:46Z


				
				
				
				
				
				← Older revision
				Revision as of 15:11, 11 February 2010
				
Line 159:
Line 159:
''Figure 4: Libsharing classes'' ''Figure 4: Libsharing classes''



To see more detail the sharing classes you can browse to [https://garage.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ Sharing plugin example] To see more detail the sharing classes you can browse to [https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/data-sharing-plugin/ Sharing plugin example]



===Service XML File=== ===Service XML File===



imported_>tapio at 15:11, 11 February 2010
2010-02-11T15:11:03Z


				
				
				
				
				
				← Older revision
				Revision as of 15:11, 11 February 2010
				
Line 97:
Line 97:
Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of debian development and working in scratchbox environment is needed in order to follow these guides. Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of debian development and working in scratchbox environment is needed in order to follow these guides.



Plugin template with some example codes is located here [https://garage.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ Data Sharing Plugin example] Plugin template with some example codes is located here [https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/data-sharing-plugin/ Data Sharing Plugin example]



Detailed API documentation is available in [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/ libsharing-plugin-doc] package in gtk-doc format. Detailed API documentation is available in [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/ libsharing-plugin-doc] package in gtk-doc format.



imported_>teniemel: /* Writing Sharing Plug-in for "Send via Service" */
2010-01-23T10:09:09Z
Writing Sharing Plug-in for "Send via Service"

				
				
				
				
				
				← Older revision
				Revision as of 10:09, 23 January 2010
				
Line 97:
Line 97:
Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of debian development and working in scratchbox environment is needed in order to follow these guides. Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of debian development and working in scratchbox environment is needed in order to follow these guides.



Plugin example is located here [https://garage.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ Data Sharing Plugin example] Plugin template with some example codes is located here [https://garage.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ Data Sharing Plugin example]



Detailed API documentation is available in [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/ libsharing-plugin-doc] package in gtk-doc format. Detailed API documentation is available in [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/ libsharing-plugin-doc] package in gtk-doc format.



imported_>teniemel: Organized chapters a bit
2010-01-23T10:04:42Z
Organized chapters a bit

				
				
				
				
				
				← Older revision
				Revision as of 10:04, 23 January 2010
				
Line 1:
Line 1:
=Writing "Send Via" Functionality= =Using Sharing dialog API=
With Sharing dialog API user can open the  first dialog, which start the Sharing flow. From the first dialog user can select "Send via Bluetooth", "Send via E-mail" and "Share via servive".
 
More detailed API documentation can be found from [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin here].
 
Example code how to use the API:
 
  /* create osso context in your app that is passed to sharing */
  osso_context_t *osso = osso_initialize ("my_app", "1.0.0.", FALSE, NULL);
  /* file to open */
  gchar *filename = "/path/to/file";
  sharing_dialog_with_file (osso,
                            GTK_WINDOW (parent),
                            filename);



Send Via functionality is provided by the platform to enable applications to send data via e-mail or over a Bluetooth connection. Because several applications share this functionality, the platform provides a public interface to facilitate the deployment of these services in user applications. The interfaces are defined in two header files: libmodest-dbus-client.h (in the libmodest-dbus-client-dev package) and conbtdialogs-dbus.h (in the conbtdialogs-dev package). The following sample code is an example of the usage of these interfaces. See the maemopad source code available in the SDK repository for a fully functional application using this service. In the example above we use the API to start sharing single file. In case you want to share simultaneously more than one file or you want
to change what button are seen in the dialog use one of the functions below.



 void sharing_dialog_with_files (osso_context_t * osso, GtkWindow * parent, GSList * uris);
 void sharing_dialog_button_mask_with_file (osso_context_t * osso, GtkWindow * parent, const gchar * uris, guint share_button_mask);
 void sharing_dialog_button_mask_with_files (osso_context_t * osso, GtkWindow * parent, GSList * uris, guint share_button_mask);

==Compiling==
When compiling your application use the following pkg-config configuration.
 `pkg-config --cflags --libs sharingdialog`

=Writing "Send Via" Functionality to E-mail and Bluetooth=

Send Via E-mail and Bluetooth can be used directly without Sharing dialog
and the functionality is provided by the platform to enable applications to send data via E-mail or over a Bluetooth connection. Because several applications share this functionality, the platform provides a public interface to facilitate the deployment of these services in user applications. The interfaces are defined in two header files: libmodest-dbus-client.h (in the libmodest-dbus-client-dev package) and conbtdialogs-dbus.h (in the conbtdialogs-dev package). The following sample code is an example of the usage of these interfaces. See the maemopad source code available in the SDK repository for a fully functional application using this service.



maemopad/src/maemopad-window.c maemopad/src/maemopad-window.c
Line 68:
Line 94:
  }   }



=Using Sharing dialog API= =Writing Sharing Plug-in for "Send via Service"=
With Sharing dialog API user can open the  first dialog, which start the Sharing flow. From the first dialog user can select "Send via Bluetooth", "Send via E-mail" and "Share via servive". 
  
More detailed API documentation can be found from [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin here]. 
  
Example code how to use the API: 
  
  /* create osso context in your app that is passed to sharing */ 
  osso_context_t *osso = osso_initialize ("my_app", "1.0.0.", FALSE, NULL); 
  /* file to open */ 
  gchar *filename = "/path/to/file"; 
  sharing_dialog_with_file (osso, 
                            GTK_WINDOW (parent), 
                            filename); 
  
In the example above we use the API to start sharing single file. In case you want to share simultaneously more than one file or you want 
to change what button are seen in the dialog use one of the functions below. 
  
 void sharing_dialog_with_files (osso_context_t * osso, GtkWindow * parent, GSList * uris); 
 void sharing_dialog_button_mask_with_file (osso_context_t * osso, GtkWindow * parent, const gchar * uris, guint share_button_mask); 
 void sharing_dialog_button_mask_with_files (osso_context_t * osso, GtkWindow * parent, GSList * uris, guint share_button_mask); 
  
==Compiling== 
When compiling your application use the following pkg-config configuration. 
 `pkg-config --cflags --libs sharingdialog` 
  
=Sharing Plug-in Creation= 
Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of debian development and working in scratchbox environment is needed in order to follow these guides. Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of debian development and working in scratchbox environment is needed in order to follow these guides.

← Older revision		Revision as of 11:04, 4 August 2010
Line 131:		Line 131:
	As a pre-requisite, you will need a working Maemo 5 SDK to continue further.		As a pre-requisite, you will need a working Maemo 5 SDK to continue further.
	We will first install the Sharing Plug-in template:		We will first install the Sharing Plug-in template:
	*Obtain the template source code ''sharing-plugin-template-0.1.tar.gz'' from ~~<URL HERE>~~. It contains a good start up file structure for the plug-in creation.		*Obtain the template source code ''sharing-plugin-template-0.1.tar.gz'' from [https://garage.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ the maemoexamples repository]. It contains a good start up file structure for the plug-in creation.
	*Extract and build the package from the folder using command:		*Extract and build the package from the folder using command:
	./autogen.sh; dpkg-buildpackage -rfakeroot -d		./autogen.sh; dpkg-buildpackage -rfakeroot -d

← Older revision		Revision as of 21:49, 28 May 2010
Line 177:		Line 177:
	<icon type="setup">@servicesdir@/template-setup.png</icon>		<icon type="setup">@servicesdir@/template-setup.png</icon>
	<options>		<options>
	<option id="privacy" type="enumeration" default="private">		<option id="privacy" type="enumeration" default="private">
	<caption domain="osso-sharing-ui" key="share_bd_options_privacy"/>		<caption domain="osso-sharing-ui" key="share_bd_options_privacy"/>
	<value id="private" domain="osso-sharing-ui" key="share_fi_options_privacy_private"/>		<value id="private" domain="osso-sharing-ui" key="share_fi_options_privacy_private"/>

← Older revision		Revision as of 16:19, 23 May 2010
Line 1:		Line 1:
	=Using Sharing dialog API=		=Using Sharing dialog API=
	With Sharing dialog API user can open the first dialog, which start the Sharing flow. From the first dialog user can select "Send via Bluetooth", "Send via E-mail" and "Share via ~~servive~~".		With Sharing dialog API user can open the first dialog, which start the Sharing flow. From the first dialog user can select "Send via Bluetooth", "Send via E-mail" and "Share via service".

	More detailed API documentation can be found from [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin here].		More detailed API documentation can be found from [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin here].

← Older revision		Revision as of 07:16, 31 March 2010
Line 429:		Line 429:

	==Sharing your plugin with others==		==Sharing your plugin with others==
	Maemo Extras repository is the best place for your plug-in if you want to get users for it. More information on how you can upload packages to Extras repository ~~can be found [[http://wiki.maemo.org/Uploading_to_Extras here~~]].		Maemo Extras repository is the best place for your plug-in if you want to get users for it. More information on how you can [[Uploading to Extras-devel\|upload packages to Extras repository]] is available.

	Before uploading plugin to public repositories make sure you have updated the debian configuration files to match your information under ./debian folder.		Before uploading plugin to public repositories make sure you have updated the debian configuration files to match your information under ./debian folder.

← Older revision		Revision as of 12:54, 12 February 2010
Line 444:		Line 444:
	libsharing-plugin-dev		libsharing-plugin-dev
	Standards-Version: 3.8.0		Standards-Version: 3.8.0

			[[Category:Development]]
			[[Category:Documentation]]
			[[Category:Fremantle]]

← Older revision		Revision as of 15:11, 11 February 2010
Line 159:		Line 159:
	''Figure 4: Libsharing classes''		''Figure 4: Libsharing classes''

	To see more detail the sharing classes you can browse to [https://~~garage~~.maemo.org/svn/maemoexamples/~~trunk~~/data-sharing-plugin/ Sharing plugin example]		To see more detail the sharing classes you can browse to [https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/data-sharing-plugin/ Sharing plugin example]

	===Service XML File===		===Service XML File===

← Older revision		Revision as of 15:11, 11 February 2010
Line 97:		Line 97:
	Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of debian development and working in scratchbox environment is needed in order to follow these guides.		Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of debian development and working in scratchbox environment is needed in order to follow these guides.

	Plugin template with some example codes is located here [https://~~garage~~.maemo.org/svn/maemoexamples/~~trunk~~/data-sharing-plugin/ Data Sharing Plugin example]		Plugin template with some example codes is located here [https://vcs.maemo.org/svn/maemoexamples/tags/maemo_5.0/data-sharing-plugin/ Data Sharing Plugin example]

	Detailed API documentation is available in [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/ libsharing-plugin-doc] package in gtk-doc format.		Detailed API documentation is available in [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/ libsharing-plugin-doc] package in gtk-doc format.

← Older revision		Revision as of 10:09, 23 January 2010
Line 97:		Line 97:
	Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of debian development and working in scratchbox environment is needed in order to follow these guides.		Maemo 5 introduces a new library for handling Sharing related information and services. This chapter will walk you through the process of creating a sharing plug-in using a template plug-in as example. Basic knowledge of debian development and working in scratchbox environment is needed in order to follow these guides.

	Plugin example is located here [https://garage.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ Data Sharing Plugin example]		Plugin template with some example codes is located here [https://garage.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ Data Sharing Plugin example]

	Detailed API documentation is available in [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/ libsharing-plugin-doc] package in gtk-doc format.		Detailed API documentation is available in [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/ libsharing-plugin-doc] package in gtk-doc format.

Documentation/Maemo 5 Developer Guide/Using Data Sharing/Sharing Plug-in - Revision history

imported_>amigadave: use and , wikify slightly, tidy

imported_>agarcia: /* Getting Your Dummy Plugin To Sharing Menus */ Fix link to sharing-plugin-template

imported_>alexzk24: /* Service XML File */

79.237.138.216: /* Using Sharing dialog API */

imported_>amigadave: /* Sharing your plugin with others */ wikify link

imported_>amigadave: categorise

imported_>tapio at 15:11, 11 February 2010

imported_>tapio at 15:11, 11 February 2010

imported_>teniemel: /* Writing Sharing Plug-in for "Send via Service" */

imported_>teniemel: Organized chapters a bit

imported_>amigadave: use and `, wikify slightly, tidy`