Share Class Reference

The Share class provides synchronous and asynchronous communication between the android native share and the Qt application. More...

#include <Share.h>

Signals
void	shareNoAppAvailable ()
	emits when a share fails because an app could not be found
void	fileReceived (const QString &fname)
	emits when a file is received

Public Member Functions
Q_INVOKABLE void	sendContent (const QString &content, const QString &mimeType, const QString &suffix)
	share text content with other app.
Q_INVOKABLE void	viewContent (const QString &content, const QString &mimeType, const QString &suffix)
	open content in other app
Q_INVOKABLE void	saveContent (const QString &content, const QString &mimeType, const QString &suffix)
	save content to file system
Q_INVOKABLE void	importFile (const QString &mimeType=nullptr)
	import file
Q_INVOKABLE void	checkPendingIntents ()
	fired if the main window becomes active, triggered from main.qml.
void	setFileReceived (const QString &fname)
	called from the JNI "callback" setFileReceived() to receive the received file name and to emit fileReceived() to connected slots.

Static Public Member Functions
static Share *	getInstance ()
	get single instance of the Share. used from the JNI "callback" setFileReceived()

Detailed Description

The Share class provides synchronous and asynchronous communication between the android native share and the Qt application.

Copyright (C) 2020 by Johannes Zellner, johan.nosp@m.nes@.nosp@m.zelln.nosp@m.er.o.nosp@m.rg

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Sending is done via IntentLauncher.java. Receiving is via setFileReceived() from ShareActivity.java.

Send content

sendContent - android "share" with other apps (email, messenger, ...) viewContent - open content in other android app saveContent - save to file

all three methods call static methods in IntentLauncher.java to create correspoding intents and call startActivity(). This works asynchronously for send and view which means that enroute doesn't block after the receiving app has received the content. It works synchronously for save thus save returns only if the file has been saved or the operation has been cancelled.

Receive content

importFile - to import file from file system. This calls a static method in IntentLauncher.java to create correspoding intents and call the "blocking" startActivityForResult(). This works synchronously, therefore enroute will block until either a new file URL will be sent back from ShareActivity or the activity has been cancelled.

furthermore, SEND and VIEW intents from other apps will trigger the setFileReceived() methods too.

Technically, all content is received in the class de.akaflieg_freiburg.enroute.ShareActivity from share intents by the two methods

• onActivityResult()
• onNewIntent()

The file URL which is passed in these intents is then sent back from java to Qt in the following order:

java (de.akaflieg_freiburg.enroute.ShareActivity from share intents) ->Java_de_akaflieg_1freiburg_enroute_ShareActivity_setFileReceived() ->setFileReceived() ->emit fileReceived() ->to connected slots like FlightRoute::fromGpx()

Definition at line 74 of file Share.h.

Member Function Documentation

checkPendingIntents()

Q_INVOKABLE void Share::checkPendingIntents

(

)

fired if the main window becomes active, triggered from main.qml.

This method checks if there are pending intents which should be processed in the java activity de.akaflieg_freiburg.enroute.ShareActivity.

This is usually necessary if the app has been launched by an incoming intent and the java ShareActivity postponed processing of the intent until enroute has been fully initialized.

fileReceived

void Share::fileReceived ( const QString & fname )

signal

emits when a file is received

Parameters

fname

absolute file path in cache directory

getInstance()

static Share * Share::getInstance ( )

static

get single instance of the Share. used from the JNI "callback" setFileReceived()

Returns

the single instance of the Share class.

importFile()

Q_INVOKABLE void Share::importFile

(

const QString &

mimeType = nullptr

)

import file

This method will call java static method where an OPEN intent is created and startActivityForResult() is called.

Parameters

mimeType

the mimeType of the content

saveContent()

Q_INVOKABLE void Share::saveContent	(	const QString &	content,
		const QString &	mimeType,
		const QString &	suffix )

save content to file system

This method will

• save content to temporary file in the app's private cache
• call the corresponding java static method where a CREATE_DOCUMENT intent is created and startActivity is called

Parameters

content	content text
mimeType	the mimeType of the content
suffix	the suffix for the file

sendContent()

Q_INVOKABLE void Share::sendContent	(	const QString &	content,
		const QString &	mimeType,
		const QString &	suffix )

share text content with other app.

This method will

• save content to temporary file in the app's private cache
• call the corresponding java static method where a SEND intent is created and startActivity is called

Parameters

content	content text
mimeType	the mimeType of the content
suffix	the suffix for a temporary file

setFileReceived()

void Share::setFileReceived

(

const QString &

fname

)

called from the JNI "callback" setFileReceived() to receive the received file name and to emit fileReceived() to connected slots.

Parameters

fname

absolute file path in cache directory

viewContent()

Q_INVOKABLE void Share::viewContent	(	const QString &	content,
		const QString &	mimeType,
		const QString &	suffix )

open content in other app

This method will

• save content to temporary file in the app's private cache
• call the corresponding java static method where a VIEW intent is created and startActivity is called

Parameters

content	content text
mimeType	the mimeType of the content
suffix	the suffix for a temporary file

---

The documentation for this class was generated from the following file:

• /home/runner/work/enroute/enroute/src/Share.h