ShareProvider QML Type

• List of all members, including inherited members

Properties

• capabilities : list
• method : string
• registerName : bool

Signals

• triggered(list resources)

Detailed Description

Accepts shared files and signals ShareProvider::triggered when another application shares with this application.

Use this item to implement sharing in your application. You need to define the sharing method in desktop entry file. See the example below.

 [Desktop Entry]
 Type=Application
 Name=My application
 Icon=my-application
 Exec=my-application
 X-Share-Methods=images;

 [X-Sailjail]
 ApplicationName=MyApplication
 OrganizationName=org.example
 Permissions=Internet;UserDirs;RemovableMedia

 [X-Share Method images]
 Description=Send to friends
 Capabilities=image/png;image/jpeg
 SupportsMultipleFiles=yes

The changes you need to make to the application are addition of share methods list and definitions of those share methods.

Depending on the locations of files you expect to receive, you should define appropriate permissions for your application in X-Sailjail section. Files common to all applications are stored on device in directories allowed by UserDirs permission or one of the more specific directory permissions. Similarly files stored on memory card can be accessed with RemovableMedia permission. It is possible that an application tries to share a file private to that application and that may fail as your application may not have access to it.

Each share method must be listed in X-Share-Methods key and have its own section. You may supply a short description of the sharing method to be displayed on sharing dialog. It can be localised with desktop entry style localisation keys, e.g. Description[fi] would define Finnish version of Description which is loaded when device language is set to Finnish. If a suitable translated version can not be found, it defaults to non-localised version.

You need to handle registering D-Bus name on session bus in your application. Do not use DBusInterface for that purpose to avoid race conditions with registering objects on D-Bus. Use C++ to do it race-free instead.

Example:

 int main(int argc, char *argv[])
 {
     QScopedPointer<QGuiApplication> app(SailfishApp::application(argc, argv));
     QScopedPointer<QQuickView> view(SailfishApp::createView());

     // ...

     view->setSource(SailfishApp::pathToMainQml());

     // Registering the service after QML is loaded
     QDBusConnection::sessionBus().registerService("org.example.MyApplication");

     return app->exec();
 }

Place ShareProvider directly under your ApplicationWindow and define the same method name value there. In case of the example above, this would be appropriate:

 ApplicationWindow {
     id: root

     // ...

     ShareProvider {
         method: "images"
         capabilities: ["image/png", "image/jpeg"]

         onTriggered: {
             root.activate() // Show window
             // Pass resources to handling code. A dialog allows to
             // query more information from user before acting on the data.
             var dialog = pageStack.push("SendPicturesDialog.qml", { 'resources': resources })
         }
     }
 }

You may register multiple share methods by defining multiple X-Share Method sections and ShareProvider items. Use a different method name for each section and use the same name in corresponding item on QML code.

To make your application robust, don't trust that the resources contain what you expect. Validating them before use is a good idea.

Property Documentation

Signal Documentation