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

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
-
With the Sharing dialog API, the user can open the first dialog, which starts the Sharing flow. From the first dialog the user can select "Send via Bluetooth", "Send via E-mail" and "Share via service".
+
=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 an example. Basic knowledge of Debian development and working in a Scratchbox environment is needed in order to follow these guides.
-
More detailed API documentation can be found from [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin here].
+
The example plugin can be browsed via the [[Subversion]] [https://vcs.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ web interface]
-
Example code how to use the API:
+
Sharing API reference documentation is available in the [http://maemo.org/packages/view/libsharing-plugin-doc/ libsharing-plugin-doc] package, or [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/ on maemo.org].
-
<source lang="c">
+
Before starting to create your own plugin,  it is a good idea to check the default services OVI and Flickr. From those you can see two different UI flows for creating a sharing account.
-
/* create osso context in your app that is passed to sharing */
+
In OVI the UI flow is pretty simple and clear, you just enter the user name and password and then validate the account. In Flickr the flow is more complex, as before validation the user must login to the Flickr website to get authentication and continue the validation after that.
-
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);
+
-
</source>
+
-
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
+
Sharing account creation can be accessed from the ‘Settings’ application:
-
to change what button are seen in the dialog use one of the functions below.
+
-
 
+
-
<source lang="c">
+
-
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);
+
-
</source>
+
-
 
+
-
==Compiling==
+
-
 
+
-
When compiling your application use the following pkg-config configuration:
+
-
`pkg-config --cflags --libs sharingdialog`
+
-
 
+
-
==Writing "Send Via" Functionality for 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: <code>libmodest-dbus-client.h</code> (in the <code>libmodest-dbus-client-dev</code> package) and <code>conbtdialogs-dbus.h</code> (in the <code>conbtdialogs-dev</code> 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
+
-
<source lang="c">
+
-
/* send via email: */
+
-
#include <libmodest-dbus-client/libmodest-dbus-client.h>
+
-
/* send via bt: */
+
-
#include <conbtdialogs-dbus.h>
+
-
/*......*/
+
-
static void maemopad_window_on_menu_sendvia_email (GtkButton *button, gpointer data)
+
-
{
+
-
MaemopadWindow *self = MAEMOPAD_WINDOW (data);
+
-
gboolean result = TRUE;
+
-
GSList *list = NULL;
+
-
g_assert (self);
+
-
/* Attach the saved file (and not the one currently on screen). If the file
+
-
  * has not been saved yet, nothing is attached */
+
-
if (self->file_name) {
+
-
  list = g_slist_append(list, self->file_name);
+
-
  result = libmodest_dbus_client_compose_mail(self->osso, /*osso_context_t*/
+
-
    NULL, /*to*/
+
-
    NULL, /*cc*/
+
-
    NULL, /*bcc*/
+
-
    NULL, /*body*/
+
-
    NULL, /*subject*/
+
-
    list /*attachments*/);
+
-
}
+
-
g_slist_free(list);
+
-
if (result == FALSE)
+
-
  g_print("Could not send via email\n");
+
-
}
+
-
 
+
-
static gboolean maemopad_window_rpc_sendvia_bluetooth (const gchar *path)
+
-
{
+
-
DBusGProxy *proxy = NULL;
+
-
DBusGConnection *sys_conn = NULL;
+
-
GError *error = NULL;
+
-
gboolean result = TRUE;
+
-
gchar **files = NULL;
+
-
/*sys_conn = osso_get_sys_dbus_connection(ctx);*/
+
-
sys_conn = dbus_g_bus_get(DBUS_BUS_SYSTEM, &error);
+
-
if(sys_conn == NULL)
+
-
{
+
-
  return FALSE;
+
-
}
+
-
files = g_new0(gchar*, 2);
+
-
*files = g_strdup(path);
+
-
files[1] = NULL;
+
-
/* Open connection for btdialogs service */
+
-
proxy = dbus_g_proxy_new_for_name(sys_conn,
+
-
  CONBTDIALOGS_DBUS_SERVICE,
+
-
  CONBTDIALOGS_DBUS_PATH,
+
-
  CONBTDIALOGS_DBUS_INTERFACE);
+
-
/* Send send file request to btdialogs service */
+
-
if (!dbus_g_proxy_call(proxy, CONBTDIALOGS_SEND_FILE_REQ,
+
-
  &error, G_TYPE_STRV, files,
+
-
  G_TYPE_INVALID, G_TYPE_INVALID))
+
-
{
+
-
  g_print("Error: %s\n", error->message);
+
-
  g_clear_error (&error);
+
-
  result = FALSE;
+
-
}
+
-
g_strfreev(files);
+
-
g_object_unref(proxy);
+
-
return result;
+
-
}
+
-
</source>
+
-
 
+
-
==Writing Sharing Plug-in for "Send via Service"==
+
-
 
+
-
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 a Scratchbox environment is needed in order to follow these guides.
+
-
 
+
-
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.
+
-
 
+
-
Before starting to create your own plugin it is a good idea to check the default services: OVI and Flickr. From those you can see two different UI flows for creating accounts. In OVI the UI flow is pretty simple and clear, you just type a user name and password and then validate the account. In Flickr the flow is more complex, as before validation the user must login to Flickr via a web page to get authentication and continue the validation after that.
+
-
 
+
-
Account creation is started from Settings:
+
  Settings -> Sharing accounts -> New -> Select service ...
  Settings -> Sharing accounts -> New -> Select service ...
-
===Sharing User Interfaces===
+
==Sharing User Interfaces==
-
 
+
The Sharing application implements common UI functionality needed for sharing files, and  abstracts away much of the other functionality required for a file-sharing application. Sharing Application service support can be extended by using Sharing Plug-ins. These plug-ins can be created by any 3rd party developer. The plug-ins should implement the [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/libsharing-plugin-SharingPluginInterface.html Sharing plug-in API functions listed in the API reference] and define some parameters in a service definition XML file. <!-- Which parameters, where is the documentation regarding the XML format? -->
-
Sharing application abstracts the file sharing and implements common parts needed for file sharing application. Sharing Application service support can be extended by using Sharing Plug-ins. These plug-ins can be created by any 3rd party developer. The plug-ins should implement the Sharing Plug-in API functions and define some parameters in a service definition XML file.
+
-
Figure 1 below shows Sharing accounts dialog opened from the control panel. With the Sharing accounts, you can create a new Sharing account or edit an existing one. If you install a custom Sharing plug-in, you can see the service it provides in the "Select service list" when creating a new Sharing account.
+
Figure 1 below shows the Sharing accounts dialog opened from the Settings application. You can create a new Sharing account or edit an existing one from the Sharing dialog. If you install a custom Sharing plug-in, you can see the service it provides in the "Select service list" when creating a new Sharing account.
Line 124: Line 23:
-
Figure 2 shows the Sharing Dialog user interface that is used to share images with the selected account on some service. The images displayed can come for example from the Photos application or from the device camera. You can choose the account created for your service from the "Account" combo box which holds all existing Sharing accounts.
+
Figure 2 shows the Sharing Dialog user interface that is used to share images to the selected account on some service. The images displayed can come for example from the Photos application or from the device camera. You can choose the account created for your service from the "Account" combo box which holds all existing Sharing accounts.
[[Image:SharingDialogInterface.png]]
[[Image:SharingDialogInterface.png]]
Line 130: Line 29:
''Figure 2: Sharing Dialog User Interface''
''Figure 2: Sharing Dialog User Interface''
-
===Getting Familiar With Target Service API===
+
==Getting Familiar With Target Service API==
 +
Many web services provide APIs that are available for 3rd party developers. In this tutorial, we focus on services that provide APIs for image and video uploads. It is possible to give the title, description and tags for the images using the common service API.
 +
Sharing supports image scaling and metadata filtering as common options for any service. Sharing plug-ins can have service specific options, like privacy. These settings can be accessed through the Options dialog (as shown in Figure 2.)
-
Many web services provide APIs that are available for 3rd party developers. In this tutorial, we focus on services that provide APIs for image and video uploads. It is possible to give a title, description and tags for the images using the common service API. Sharing supports image scaling and metadata filtering as common options for any service. Sharing Plug-ins can have service-specific options, like privacy. These settings can be accessed through the Options dialog (in Figure 2.)
+
==Adding Your Dummy Plugin To The Sharing Menus==
-
 
+
As a prerequisite, you will need a working Maemo 5 SDK to continue further.
-
===Getting Your Dummy Plugin To Sharing Menus===
+
We will first install the Sharing plug-in template:
-
 
+
*Obtain the template source code from [https://vcs.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ the Maemo examples repository]. It contains a good template file structure for a Sharing plug-in. The source code can be checked out with the command:
-
As a prerequisite, you will need a working Maemo 5 SDK to continue further. We will first install the Sharing Plug-in template:
+
svn checkout https://vcs.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/
-
 
+
*Build a Debian package from the folder using the command:
-
* 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 creating a plugin.
+
-
* Extract and build the package from the folder using command:
+
  ./autogen.sh; dpkg-buildpackage -rfakeroot -d
  ./autogen.sh; dpkg-buildpackage -rfakeroot -d
-
* Install the package built for your Scratchbox environment or to the device if it was built with the ARM target.
+
*Install the built package to your Scratchbox environment or to the device if it was built with the ARM target.
-
*The template dummy service should be now visible in the Sharing account when creating new accounts.  
+
*The template dummy service should be now visible in the Sharing application when creating new accounts.  
-
 
+
-
{{ambox
+
-
|text=Note that this template plugin does not send any data before you write the implementation for it.
+
-
}}
+
-
 
+
-
==Editing Template Plug-in==
+
-
In this section, we peek under the hood by opening the files found from the template plugin and get familiar with Sharing classes that are used in the Sharing Plugin API functions.
+
<div style="border: 2px solid rgb(255, 215, 0); background-color: rgb(252, 233, 79); margin-left: 25px; margin-right: 25px; padding: 2px"> N.B: Note that this template plug-in does not send any data before you write the implementation for it.</div>
-
===Sharing Internals===
+
=Editing The Template Plug-in=
 +
In this section, we peek under the hood by opening the files in the template plug-in and get familiar with the Sharing classes that are used in the Sharing plug-in API.
-
Figure 3 shows the general overview of how Sharing Plug-in connects to Sharing Application using the Sharing Plugin API. The basic plug-in components are the service definition file and the plugin library. The Application Sharing-Dialog is used to create <code>SharingEntries</code> that are shared by a <code>SharingManager</code>. Sharing Account Manager implements the Sharing Accounts. Libsharing is a library for all common Sharing functionality.
+
==Sharing Internals==
 +
Figure 3 shows the general overview of how a Sharing plug-in connects to the Sharing application using the Sharing plug-in API. The basic plug-in components are the service definition file and the plug-in library. The Sharing Application dialog is used to create ''SharingEntries'' that are shared by ''SharingManager''. Sharing Account Manager implements the Sharing Accounts. Libsharing is a library for all common Sharing functionality.
[[Image:SharingPluginAPI.jpg]]
[[Image:SharingPluginAPI.jpg]]
Line 161: Line 56:
-
Figure 4 shows the common ''Sharing'' classes found in ''libsharing'' that you would use while creating the plug-in:
+
Figure 4 shows the common ''Sharing'' classes found in ''libsharing'' that you would use when creating the plug-in.
-
* <code>SharingTransfer</code> is the object that contains all the data of a sharing task, overall status of the transfer process for one set of shared files.  
+
''SharingTransfer'' is the object that contains the data of a sharing task (a ''SharingEntry''), including the overall status of the transfer process for a set of shared files.  
-
* <code>SharingEntry</code> contains the <code>SharingEntryMedia</code> that are the selected files. It also knows the <code>SharingAccount</code> that is the target of sharing.
+
''SharingEntry'' contains the ''SharingEntryMedia'', which are the individual files to be shared. It also knows the ''SharingAccount'' that is the target of sharing.  
-
* <code>SharingAccount</code> contains the username and password along with other parameters that you have to save for your service's accounts. It also has the information about <code>SharingService</code> which is registered with the <code>SharingAccount</code>.
+
''SharingAccount'' contains the username and password along with other parameters that you have to save for your service's account. It also has the information about ''SharingService'' which is registered to the ''SharingAccount''.
[[Image:LibSharingClasses.jpg]]
[[Image:LibSharingClasses.jpg]]
Line 170: Line 65:
''Figure 4: Libsharing classes''
''Figure 4: Libsharing classes''
-
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]
+
To see the sharing classes in more detail you can browse to the [https://vcs.maemo.org/svn/maemoexamples/trunk/data-sharing-plugin/ Sharing plug-in example]
-
===Service XML File===
+
==Service XML File==<!-- This needs a link to some reference documentation -->
 +
The service definition file, located in the example at data/template.service.xml.in, is the starting point for plug-in loading. It defines the library that implements the Sharing plug-in API functions, the sign-up URL for new account creation with a web browser, the service name, icon file names and some basic information about the plug-in.
-
The service definition file, <code>data/template.service.xml.in</code> is the starting point for plugin loading. It defines the library that implements Sharing Plugin API functions, the sign up URL for totally new account creation using a web browser, the service name, icon file names and some basic information from plug-in.
+
<?xml version="1.0" encoding="UTF-8"?>  
-
 
+
<service plugin="libtemplate.so" provider="Me">  
-
<source lang="xml">
+
-
<?xml version="1.0" encoding="UTF-8"?>  
+
    <accounts plugInSetup="0" plugInEdit="0">
-
<service plugin="libtemplate.so" provider="Me">  
+
      <signup>www.maemo.org</signup>  
-
 
+
      <password maxlen="32"/>  
-
  <accounts plugInSetup="0" plugInEdit="0">
+
    </accounts>  
-
    <signup>www.maemo.org</signup>  
+
-
    <password maxlen="32"/>  
+
    <ui>  
-
  </accounts>  
+
        <name>Template</name>   
-
 
+
        <icon type="post">@servicesdir@/template-post.png</icon>  
-
  <ui>  
+
        <icon type="setup">@servicesdir@/template-setup.png</icon>  
-
      <name>Template</name>   
+
        <options>  
-
      <icon type="post">@servicesdir@/template-post.png</icon>  
+
        <option id="privacy" type="enumeration" default="private">  
-
      <icon type="setup">@servicesdir@/template-setup.png</icon>  
+
                <caption domain="osso-sharing-ui" key="share_bd_options_privacy"/>  
-
      <options>  
+
                <value id="private" domain="osso-sharing-ui" key="share_fi_options_privacy_private"/>  
-
          <option id="privacy" type="enumeration" default="private">  
+
                <value id="public" domain="osso-sharing-ui" key="share_fi_options_privacy_public"/>
-
              <caption domain="osso-sharing-ui" key="share_bd_options_privacy"/>  
+
                </option>
-
              <value id="private" domain="osso-sharing-ui" key="share_fi_options_privacy_private"/>  
+
        </option>
-
              <value id="public" domain="osso-sharing-ui" key="share_fi_options_privacy_public"/>
+
    </ui>
-
              </option>
+
</service>
-
      </options>
+
-
    </ui>
+
-
</service>
+
-
</source>
+
''File 1: Example service definition XML file''
''File 1: Example service definition XML file''
-
==== How to read the xml file ====
+
The root of the service XML file name "template.service.xml.in", excluding any extensions , "template" in this case, defines the id of the plugin. The "plugin" value in the service definition defines the library that implements the Sharing plug-in API. In this example file the library is libtemplate.so. "Provider" is the developer name, nick, etc. In "accounts", you define the plug-in account setup and edit flows described more in detail in the coming sections. Signup is the URL that is opened in the browser when a new account is created for a service.
-
The prefix of the xml file name defines the used service id of the plugin. In our example the id is "template".
+
==Account Setup User Interface Flow==
 +
Sharing accounts can either create a default UI flow where "username" and "password" parameters are set for the account in a standard dialog, or an optional custom flow. In File 1, the "accounts" tag has a parameter "plugInSetup". If it is set to "1", Sharing Accounts will call the Sharing plug-in API function "sharing_plugin_interface_account_setup" to create UI flow. The example in File 1 will use the default flow.
 +
You can see the difference between UI flows when creating a Flickr and an Ovi account. Ovi uses the default flow and Flickr uses its own UI flow.
-
Service element:
+
  SharingPluginInterfaceAccountSetupResult sharing_plugin_interface_account_setup (GtkWindow* parent, SharingService* service, SharingAccount** worked_on, osso_context_t* osso)
-
<source lang="xml">
+
-
<service plugin="" provider="">
+
-
...
+
-
</service>
+
-
</source>
+
-
* Service is the root node of each service xml and must be named exactly <code>service</code>.
+
-
* Property <code>plugin</code> defines the library name that Sharing will look for in <code>/usr/lib/sharing</code>.
+
-
* Property <code>provider</code> defines the plugin provider.
+
-
 
+
-
Accounts element:
+
-
<source lang="xml">
+
-
<accounts plugInSetup="0" plugInEdit="0">
+
-
  <signup>www.myservicepage.com</signup>
+
-
</accounts>
+
-
</source>
+
-
* Accounts element defines the account setup options.
+
-
* Property <code>plugInSetup</code> defines if sharing should use internal default flow or flow implemented in the plugin itself. Set to "1" in case using own flow.
+
-
* Property <code>plugInEdit</code> defines if sharing should use internal default flow or flow implemented in the plugin itself. Set to "1" in case using own flow.
+
-
* Element <code>signup</code> defines the URL where browser is opened in case default flow used when user press button "Register new account" in account setup dialog.
+
-
 
+
-
Ui element:
+
-
<source lang="xml">
+
-
<ui>
+
-
  <name>...</name>  
+
-
  <icon type="post">@servicesdir@/...</icon>
+
-
  <icon type="setup">@servicesdir@/...</icon>
+
-
  <options>
+
-
    ...
+
-
  </option>
+
-
</ui>
+
-
</source>
+
-
* UI element defines Name, icons and options that can be modified through XML file.
+
-
* Element <code>name</code> defines the name that is shown for the service in all the UI.
+
-
* Element <code>icon</code> defines the used icons. Property <code>post</code> or <code>setup</code> can be used. Property <code>setup</code> defines the icon shown in account setup dialogs.
+
-
* Element <code>options</code> defines the different changeable options for selected service. See more below.
+
-
 
+
-
Options element:
+
-
<source lang="xml">
+
-
<options>
+
-
  <option id="..." type="enumeration || updatable" default="...">
+
-
    <caption domain="osso-sharing-ui" key="..."/>
+
-
    <value id="..." domain="osso-sharing-ui" key="..."/>
+
-
  </option>
+
-
  <option>
+
-
  ...
+
-
  </option>
+
-
</options>
+
-
</source>
+
-
 
+
-
* Options element defines all the options that a user can change through "Options" for the selected service. Each individual option is an element <code>option</code>.
+
-
* Property <code>id</code> defines the internal id for this option. User selected choice for this option is asked with the id, see [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/libsharing-plugin-SharingEntry.html#sharing-entry-get-option here].
+
-
* Property <code>type</code> defines the type of option. You can select <code>enumeration</code> or <code>updatable</code>. For the enumeration you need to specify the shown values with values elements. Updatable option can contain default values and the remaining values can be updated from service.
+
-
* Property <code>default</code> defines the default value to select if user haven't made any selections yet. The value of the default property must mach one of the value element ids.
+
-
* Properties <code>domain</code> and <code>key</code> under <code>caption</code> element defines the actual text to be displayed. If you want to use some localization package then define <code>domain</code> and desired logical id to <code>key</code>. For free text the <code>domain</code> is not mandatory.
+
-
* Element <code>value</code> defines one value in the selection. If option is updatable new values with id/key pair can be added in code, see [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/libsharing-plugin-SharingAccount.html#sharing_account_set_option_values here]. Otherwise you need to specify the shown values.
+
-
 
+
-
===Account Setup User Interface Flow===
+
-
 
+
-
Sharing accounts can either create a default flow where <code>username</code> and <code>password</code> parameters are set to the account or an optional custom flow. In File 1, the <code>accounts</code> tag has a parameter <code>plugInSetup</code>. If it is set to "1", Sharing Accounts will call the Sharing Plugin API function <code>sharing_plugin_interface_account_setup</code> to create UI flow; it will use the default flow. You can see the difference between UI flows when creating Flickr and Ovi account. Ovi uses the default flow and Flickr uses it's own UI flow.
+
-
 
+
-
<source lang="c">
+
-
SharingPluginInterfaceAccountSetupResult sharing_plugin_interface_account_setup (GtkWindow* parent, SharingService* service, SharingAccount** worked_on, osso_context_t* osso)
+
-
</source>
+
If you decide to create your own account setup flow, please try to keep the same UI look as in other Sharing dialogs.
If you decide to create your own account setup flow, please try to keep the same UI look as in other Sharing dialogs.
-
===Account Validation===
+
==Account Validation==
-
 
+
Account validation is recommended so that errors due to incorrect login details are reduced. It is possible to use the dummy function of the template plug-in<!-- link? -->, but for a better user experience this function should be implemented so that Sharing Account information is validated against the service when a new account is created, not when a Sharing request is initiated.
-
Account validation is needed to reduce error cases in the sending process. Of course you can use the dummy function at template plug-in, but for better user experience this function is recommended to be implemented so that Sharing Account account information is really validated against the service when new account is created.
+
-
Next function is called after <code>sharing_plugin_interface_account_setup</code> call ends or when default account setup flow is done (when the "Validate" button is pressed).
+
The next function is called after the "sharing_plugin_interface_account_setup" call ends, or when the default account setup flow is complete (when the "Validate" button is pressed).
-
<source lang="c">
+
SharingPluginInterfaceAccountValidateResult sharing_plugin_interface_account_validate (SharingAccount* account, ConIcConnection* con, gboolean *cont, gboolean* dead_mans_switch)
-
SharingPluginInterfaceAccountValidateResult sharing_plugin_interface_account_validate (SharingAccount* account, ConIcConnection* con, gboolean *cont, gboolean* dead_mans_switch)
+
-
</source>
+
-
In the last phase of account creation, the account must be validated. Sharing Plug-in API <code>sharing_plugin_interface_test_account</code> is the function called in the validation phase of the account creation flow. Usually web services have a phase in account creation where you have put the needed information from your account, only then you get the actual credentials to upload images if your account information is valid. This is the phase that is implemented in the Sharing Plug-in API function.
+
In the last phase of account creation, the account must be validated. Sharing plug-in API ''sharing_plugin_interface_test_account'' is the function called in the validation phase of the account creation flow.
 +
Usually web services have a phase in account creation where you have input the needed information from your account, and only then do you get the actual credentials to upload images if your account information is valid. This is the phase that is implemented in the Sharing plug-in API function.
-
===Account Editing User Interface Flow===
+
==Account Editing User Interface Flow==
-
Sharing Accounts support here too either default flow where <code>username</code> and <code>password</code> parameters are edited or optional custom edit UI flow. The desired flow can be set by setting the parameter <code>plugInEdit</code> from the service definition file either to "0" or to "1" where "0" means the default flow and "1" plug-in flow.
+
Sharing Accounts support here too either default flow where “username” and “password” parameters are edited or optional custom edit UI flow. The wanted flow can be set by setting the parameter "plugInEdit" from the service definition file either to "0" or to "1" where "0" means the default flow and "1" plug-in flow.
The default flow can be used when you need only username and password to get needed information for sending. The plug-in flow is used when you need more than this or customised account validation flow. You can see the difference between UI flows here too when editing Flickr and Ovi accounts.
The default flow can be used when you need only username and password to get needed information for sending. The plug-in flow is used when you need more than this or customised account validation flow. You can see the difference between UI flows here too when editing Flickr and Ovi accounts.
-
Next function must be implemented only when plug-in account setup is used (when <code>plugInSetup</code> is set to "1"):
+
Next function must be implemented only when plug-in account setup is used (when "plugInSetup" is set to "1"):
 +
SharingPluginInterfaceEditAccountResult sharing_plugin_interface_edit_account (GtkWindow* parent, SharingAccount* account, ConIcConnection* con, gboolean* dead_mans_switch)
-
<source lang="c">
+
==Sending Functionality==
-
SharingPluginInterfaceEditAccountResult sharing_plugin_interface_edit_account (GtkWindow* parent, SharingAccount* account, ConIcConnection* con, gboolean* dead_mans_switch)
+
-
</source>
+
-
===Sending Functionality===
+
<tt>SharingPluginInterfaceSendResult sharing_plugin_interface_send (SharingTransfer* transfer, ConIcConnection* con, gboolean* dead_mans_switch)</tt>
-
<source lang="c">
+
After pressing the 'Share' button in the Sharing dialog (Figure 2.), the data is put into the Sharing outbox (can be seen under /home/user/MyDocs/.sharing/outbox/). The Sharing manager process is started and an icon is added to the status menu to process the new Sharing Entry.
-
SharingPluginInterfaceSendResult sharing_plugin_interface_send (SharingTransfer* transfer, ConIcConnection* con, gboolean* dead_mans_switch)
+
''SharingHTTP'' provides an API to create common HTTP requests.
-
</source>
+
In order to create a better user experience, the following points should be implemented after you get the basic functionality working in your plug-in:
-
 
+
*Set the progress of the transfer with [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/libsharing-plugin-SharingTransfer.html#sharing-transfer-set-progress sharing_transfer_set_progress], which accepts a gdouble argument of between 0 and 1, to estimate the current or total transfer time.
-
After pressing the 'Share' button in Sharing dialog (Figure 2.), the data is put into the Sharing Outbox (can be seen under <code>/home/user/MyDocs/.sharing/outbox/</code>). Sharing manager process is started and the status menu gets the icon to process the new Sharing Entry. <code>SharingHTTP</code> provides an API to create common HTTP requests. In order to create a better user experience following things are good to be implemented after you get the basic functionality working in your plug-in:
+
*Mark each ''SharingEntryMedia'' (file) as sent  with [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/libsharing-plugin-SharingEntryMedia.html#sharing-entry-media-set-sent sharing_entry_media_set_sent] when file sending is complete. Check the sent value with [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/libsharing-plugin-SharingEntryMedia.html#sharing-entry-media-get-sent sharing_entry_media_get_sent] to prevent sending the same file multiple times, for example in reboot scenarios.
-
 
+
*Poll the cancel flag from time to time, for example in the  ''libcurl'' or ''SharingHTTP'' progress function to end transferring when needed. Use [http://maemo.org/api_refs/5.0/5.0-final/libsharing-plugin/libsharing-plugin-SharingTransfer.html#sharing-transfer-continue sharing_transfer_continue] to get the continue flag bit.
-
* Set progress of sending with <code>sharing_transfer_set_progress</code> between 0 and 1 to estimate the current transfer time / total transfer time.
+
*If you are using ''libcurl'' instead of ''SharingHTTP'', please listen to ''conic'' events to disconnect transfer when no connection available. It returns with 'no connection' return value in this case.
-
* Set sent to <code>SharingEntryMedia</code> with <code>sharing_entry_media_set_sent</code> when file sending is done and check the send value with <code>sharing_entry_media_get_sent</code> to prevent sending same files multiple times for example in reboot scenarios.
+
-
* Poll cancel flag time to time, for example in curl or <code>SharingHTTP</code> progress function to end transferring when needed. Use <code>sharing_transfer_continue</code> to get the continue flag bit.
+
-
* If you are using ''libcurl'' instead of <code>SharingHTTP</code>, please listen to ''conic'' events to disconnect transfer when no connection available. It returns with 'no connection' return value in this case.
+
Next some example source for common tasks found in usual sending functionality:
Next some example source for common tasks found in usual sending functionality:
-
 
==== Example sending loop ====
==== Example sending loop ====
-
When you process <code>SharingEntryMedia</code>s from the <code>SharingEntry</code> you propably end up with loop where you go the list of SharingEntryMedias through. Here is a raw example, where some example lines commented out with "//".
+
When you process ''SharingEntryMedia'' from the ''SharingEntry'' you propably end up with a loop where you iterate over the list of ''SharingEntryMedia''. Here is a bare example, where some example lines commented out with "//".
 +
<tt>
-
<source lang="c">
+
for (GSList* p = sharing_entry_get_media (entry); p != NULL; p = g_slist_next(p)) {
-
for (GSList* p = sharing_entry_get_media (entry); p != NULL; p = g_slist_next(p)) {
+
    SharingEntryMedia* media = p->data;
-
  SharingEntryMedia* media = p->data;
+
    /* Process media */
-
  /* Process media */
+
    if (!sharing_entry_media_get_sent (media)) {
-
  if (!sharing_entry_media_get_sent (media)) {
+
        /* Post media */
-
      /* Post media */
+
        //guint result = my_send_task_post_function (my_send_task, media);
-
      //guint result = my_send_task_post_function (my_send_task, media);
+
        /* Process post result */
-
      /* Process post result */
+
        if (result == 0 /* EXAMPLE: MY_SEND_RESULT_SUCCESS */) {
-
      if (result == 0 /* EXAMPLE: MY_SEND_RESULT_SUCCESS */) {
+
            /* If success mark media as sent */
-
          /* If success mark media as sent */
+
            sharing_entry_media_set_sent (media, TRUE);
-
          sharing_entry_media_set_sent (media, TRUE);
+
            /* And mark process to your internal data structure */
-
          /* And mark process to your internal data structure */
+
            //my_send_task->upload_done += sharing_entry_media_get_size (media);  
-
          //my_send_task->upload_done += sharing_entry_media_get_size (media);  
+
        } else {
-
      } else {
+
            /* We have sent the file in last sharing-manager call */
-
          /* We have sent the file in last sharing-manager call */
+
            //my_send_task->upload_done += sharing_entry_media_get_size (media);
-
          //my_send_task->upload_done += sharing_entry_media_get_size (media);
+
        }
-
      }
+
    }
-
  }
+
}
-
}
+
 
-
</source>
+
</tt>
==== Example tags string ====
==== Example tags string ====
 +
Usually, services provide API for adding tags to images. Here is example source code to create a string containing tag information, with ", " string used as a separator. If the service supports also geotagging you could develop this source further by checking the tag type also.
 +
<tt>
-
Usually services accept the tags in their API to be added to images. Here is example source to create nice string about tag information to be put where ", " string used as separator. If service supports also geo tagging you should develop this source further by checking the tag type also.
+
  static gchar* create_tags_str (const GSList* tags)
-
 
+
{
-
<source lang="c">
+
    gchar* ret = NULL;
-
static gchar* create_tags_str (const GSList* tags)
+
    for (const GSList* p = tags; p != NULL; p = g_slist_next (p)) {
-
{
+
        SharingTag* tag = (SharingTag*)(p->data);
-
  gchar* ret = NULL;
+
        const gchar* tmp = sharing_tag_get_word (tag);
-
  for (const GSList* p = tags; p != NULL; p = g_slist_next (p)) {
+
        if (tmp != NULL) {
-
      SharingTag* tag = (SharingTag*)(p->data);
+
            gchar* new_ret = NULL;
-
      const gchar* tmp = sharing_tag_get_word (tag);
+
            if (ret != NULL) {
-
      if (tmp != NULL) {
+
                new_ret = g_strdup_printf ("%s, %s", ret, tmp);
-
          gchar* new_ret = NULL;
+
                g_free (ret); /* old return is freed */
-
          if (ret != NULL) {
+
            } else {
-
              new_ret = g_strdup_printf ("%s, %s", ret, tmp);
+
                new_ret = g_strdup (tmp);
-
              g_free (ret); /* old return is freed */
+
            }
-
          } else {
+
            ret = new_ret;
-
              new_ret = g_strdup (tmp);
+
        }
-
          }
+
    }
-
          ret = new_ret;
+
    return ret;
-
      }
+
}
-
  }
+
gchar* tags = create_tags_str (sharing_entry_media_get_tags (media));
-
  return ret;
+
</tt>
-
}
+
-
gchar* tags = create_tags_str (sharing_entry_media_get_tags (media));
+
-
</source>
+
==== SharingHTTP example ====
==== SharingHTTP example ====
 +
SharingHTTP is intended for HTTP transfers. It is probably easier to use this than libcurl and libconic directly in most cases. Give it a try, at least if you are not familiar with libcurl!
-
<code>SharingHTTP</code> is meant to be used for HTTP transfers. It is probably easier to use this than libcurl and libconic directly in common cases. Give it a try at least if you are not familiar with libcurl!
+
<tt>
 +
SharingHTTP * http = sharing_http_new ();
 +
SharingHTTPRunResponse res;
 +
res = sharing_http_run (http, "http://example.com/post");
 +
if (res == SHARING_HTTP_RUNRES_SUCCESS) {
 +
  g_print ("Got response (%d): %s\n", sharing_http_get_res_code (http),
 +
    sharing_http_get_res_body (http, NULL));
 +
} else {
 +
    g_printerr ("Couldn't get stuff from service\n");
 +
}
 +
sharing_http_unref (http);
 +
</tt>
-
<source lang="c">
+
==Uninstallation==
-
SharingHTTP * http = sharing_http_new ();
+
Libsharing provides ''sharing-account-remover'' binary that can be used to clean Sharing Accounts created for your plug-in. This binary is run by the Debian package's prerm script. Prerm scripts are run just before the package is uninstalled. Change the plug-in id from sharingplugintemplate to match your plug-in id in the script. Your plug-in's id is the service definitions files prefix. For template.service.xml, the prefix is "template".
-
SharingHTTPRunResponse res;
+
-
res = sharing_http_run (http, "http://example.com/post");
+
-
if (res == SHARING_HTTP_RUNRES_SUCCESS) {
+
-
g_print ("Got response (%d): %s\n", sharing_http_get_res_code (http),
+
-
    sharing_http_get_res_body (http, NULL));
+
-
} else {
+
-
    g_printerr ("Couldn't get stuff from service\n");
+
-
}
+
-
sharing_http_unref (http);
+
-
</source>
+
-
 
+
-
===Update options===
+
-
 
+
-
<code>sharing_plugin_interface_update_options</code> is used to update account specific
+
-
options in Sharing Dialog's Options menu. This is pretty handy when you want to have
+
-
changing options in your plug-in for example albums.
+
-
 
+
-
You are defining these options in your plug-in's service definion .xml file. For
+
-
example next lines can add updatable option "album" to the plug-in's accounts:
+
-
<source lang="xml">
+
-
<option id="album" type="updatable" default="default_photoset">
+
-
    <caption domain="osso-sharing-ui" key="share_ti_select_album"/>
+
-
    <value id="default_photoset" domain="osso-sharing-ui" key="Default"/>
+
-
</option>
+
-
</source>
+
-
 
+
-
When update options is pressed <code>sharing_plugin_interface_update_options</code> is called. After you have got the newest options from service's server you can add them to currently selected account by creating a <code>GSList*</code> of <code>SharingServiceOptionValues</code>. After having a nice list of new options you can then set them to account with <code>sharing_account_set_option_values (self->account, "album", option_values)</code>.
+
-
 
+
-
When setting the options to account is done you have to call the function that was given to you as parameter passing the <code>SharingPluginInterfaceUpdateOptionsResult</code> with value of your choise and the already before got <code>cb_data</code> as parameter. This tells to the caller that your part from the update flow is succesfully done. Next source can be used to create this function call (self->result is containing the result in you opinion):
+
-
 
+
-
<source lang="c">
+
-
/* Callback */
+
-
if (self->cb_func != NULL) {
+
-
    void (*fp) (SharingPluginInterfaceUpdateOptionsResult, gpointer);
+
-
    fp = self->cb_func;
+
-
    fp (self->result, self->cb_data);
+
-
} else {
+
-
    ; /* Fail */
+
-
}
+
-
</source>
+
-
 
+
-
You can have the callback function and it's parameter stored for example in
+
-
next form:
+
-
 
+
-
<source lang="c">
+
-
void (*cb_func)(UpdateOptionsCallback result, gpointer data);
+
-
gpointer cb_data;
+
-
</source>
+
-
 
+
-
===Uninstallation===
+
-
 
+
-
Libsharing provides the <code>sharing-account-remover</code> binary that can be used to clean Sharing Accounts created for your plugin. This binary is run by debian/ dir's prerm script. Prerm scripts are run just before the package is uninstalled. Change the plugin id from <code>sharingplugintemplate</code> to match your plug-in id in the script. Your plug-in's id is the service definitions files prefix. For template.service.xml, the prefix is "template".
+
Example prerm script:
Example prerm script:
-
<source lang="bash">
+
<tt>
-
#!/bin/sh
+
#!/bin/sh
-
# You can use sharing-account-remover to remove the accounts at plugin
+
# You can use sharing-account-remover to remove the accounts at plugin
-
# uninstallation
+
# uninstallation
-
if [ "$1" = "remove" ]; then
+
if [ "$1" = "remove" ]; then
-
/usr/bin/sharing-account-remover <service name>
+
/usr/bin/sharing-account-remover template
-
fi
+
fi
-
</source>
+
</tt>
-
 
+
-
==Testing your plugin==
+
-
After setting up your Scratchbox environment you can start using and testing your own plugin.  
+
=Testing your plugin=
 +
After setting up your scratchbox environment you can start using and testing your own plug-in.  
-
Sharing framework consists following packages:
+
The Sharing framework consists of the following packages:
  libsharing-plugin-dev
  libsharing-plugin-dev
Line 447: Line 230:
  sharing-service-flickr
  sharing-service-flickr
-
All the needed packages should be installed along with nokia-binaries.
+
All the required packages should be installed with the nokia-binaries metapackage.
-
'''Important:''' When testing inside scratchbox  remember to start the signond daemon after the desktop is started. Signond is used for storing the account information and it's needed in order to get Sharing framework working properly
+
'''Important:''' When testing inside scratchbox  remember to start the ''signond'' daemon after the desktop is started. Signond is used for storing the account information and it is needed in order for the Sharing framework to function correctly
  [sbox] > signond &
  [sbox] > signond &
-
Also remember to install the debian .deb package build from your sources.
+
Also remember to install the Debian .deb package built from your sources.
-
Creating sharing account is started from setting.
+
To create a sharing account, open the Settings application:
   
   
-
  settings -> Sharing accounts -> New
+
  Settings -> Sharing accounts -> New
-
Select your service and create new account. After one account is created you can use ImageViewer for sharing images and MediaPlayer for sharing video files.
+
Select your service and create a new account. After an account is created you can use ImageViewer for sharing images and MediaPlayer for sharing video files.
-
==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.
+
Also make sure that the section is set to [[Documentation/Maemo 5 Developer Guide/Packaging, Deploying and Distributing#Sections | one of the valid sections listed in the packaging guide]]. For data sharing, use "user/multimedia". This way the package will be installable by application manager. Below example version of debian control file.
-
 
+
-
Also make sure that the section is set to [[Documentation/Maemo 5 Developer Guide/Packaging, Deploying and Distributing#Sections|one of the valid sections listed in the packaging guide]]. For data sharing, use <code>user/multimedia</code>. This way the package will be installable by application manager. Below example version of debian control file.
+
  Source: sharing-plugin-template
  Source: sharing-plugin-template
Line 478: Line 260:
     libsharing-plugin-dev
     libsharing-plugin-dev
  Standards-Version: 3.8.0
  Standards-Version: 3.8.0
-
 
-
[[Category:Development]]
 
-
[[Category:Documentation]]
 
-
[[Category:Fremantle]]
 

Learn more about Contributing to the wiki.


Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!


Cancel | Editing help (opens in new window)

Templates used on this page: