QtAndroid Namespace

Function Documentation

QAndroidJniObject QtAndroid::androidActivity()

Returns a handle to this application's latest started Activity

This function was introduced in Qt 5.3.

See also QAndroidJniObject, androidService(), and androidContext().

QAndroidJniObject QtAndroid::androidContext()

Returns a handle to this application's current Context.

The nature of the returned Context object depends on the state of the application:

If the activity object is valid, meaning the application is currently running within an activity context, androidContext() will return a handle to that activity.

If the activity object is not valid, which can occur if the application is running as a service, then androidContext() will return a handle to the service.

This distinction is important because activities and services have different life-cycle methods for different purposes within an Android application. Activities are typically used for UI interactions with the user, while services run in the background to perform long-running operations.

This function was introduced in Qt 5.8.

See also QAndroidJniObject, androidActivity(), and androidService().

int QtAndroid::androidSdkVersion()

Returns the Android SDK version. This is also known as the API level.

This function was introduced in Qt 5.3.

QAndroidJniObject QtAndroid::androidService()

Returns a handle to this application's latest started service.

This function was introduced in Qt 5.7.

See also QAndroidJniObject, androidActivity(), and androidContext().

bool QtAndroid::bindService(const QAndroidIntent &serviceIntent, const QAndroidServiceConnection &serviceConnection, QtAndroid::BindFlags flags = BindFlag::None)

Binds the service given by serviceIntent, serviceConnection and flags. The serviceIntent object identifies the service to connect to. The serviceConnection is a listener that receives the information as the service is started and stopped.

Returns true on success

See Android documentation documentation for more details.

This function was introduced in Qt 5.10.

See also QAndroidIntent, QAndroidServiceConnection, and BindFlag.

QtAndroid::PermissionResult QtAndroid::checkPermission(const QString &permission)

Checks if the permission was granted or not. This function should be called every time when the application starts for needed permissions, as the users might disable them from Android Settings.

This function was introduced in Qt 5.10.

void QtAndroid::hideSplashScreen()

Hides the splash screen immediately.

This function was introduced in Qt 5.7.

void QtAndroid::hideSplashScreen(int duration)

Hides the splash screen, fading it for duration milliseconds.

This function was introduced in Qt 5.10.

void QtAndroid::requestPermissions(const QStringList &permissions, const QtAndroid::PermissionResultCallback &callbackFunc)

Asynchronously requests permissions to be granted to this application, callbackFunc will be called with the results.

This function was introduced in Qt 5.10.

QtAndroid::PermissionResultMap QtAndroid::requestPermissionsSync(const QStringList &permissions, int timeoutMs = INT_MAX)

Synchronously requests permissions to be granted to this application, waits timeoutMs to complete.

This function was introduced in Qt 5.10.

void QtAndroid::runOnAndroidThread(const QtAndroid::Runnable &runnable)

Posts the given runnable on the android thread. The runnable will be queued and executed on the Android UI thread, unless it called on the Android UI thread, in which case the runnable will be executed immediately.

This function is useful to set asynchronously properties of objects that must be set on on Android UI thread.

This function was introduced in Qt 5.7.

void QtAndroid::runOnAndroidThreadSync(const QtAndroid::Runnable &runnable, int timeoutMs = INT_MAX)

Posts the runnable on the Android UI thread and waits until the runnable is executed, or until timeoutMs has passed

This function is useful to create objects, or get properties on Android UI thread:

QAndroidJniObject javaControl;
QtAndroid::runOnAndroidThreadSync([&javaControl](){

    // create our Java control on Android UI thread.
    javaControl = QAndroidJniObject("android/webkit/WebView",
                                                "(Landroid/content/Context;)V",
                                                QtAndroid::androidActivity().object<jobject>());
    javaControl.callMethod<void>("setWebViewClient",
                                   "(Landroid/webkit/WebViewClient;)V",
                                   QAndroidJniObject("android/webkit/WebViewClient").object());
});

// Continue the execution normally
qDebug() << javaControl.isValid();

This function was introduced in Qt 5.7.

bool QtAndroid::shouldShowRequestPermissionRationale(const QString &permission)

Returns true if you should show UI with a rationale for requesting a permission.

This function was introduced in Qt 5.10.

void QtAndroid::startActivity(const QAndroidJniObject &intent, int receiverRequestCode, QAndroidActivityResultReceiver *resultReceiver = nullptr)

Starts the activity given by intent and provides the result asynchronously through the resultReceiver if this is non-null.

If resultReceiver is null, then the startActivity() method in the androidActivity() will be called. Otherwise startActivityForResult() will be called.

The receiverRequestCode is a request code unique to the resultReceiver, and will be returned along with the result, making it possible to use the same receiver for more than one intent.

This function was introduced in Qt 5.3.

void QtAndroid::startActivity(const QAndroidIntent &intent, int receiverRequestCode, QAndroidActivityResultReceiver *resultReceiver = nullptr)

Starts the activity given by intent and provides the result asynchronously through the resultReceiver if this is non-null.

If resultReceiver is null, then the startActivity() method in the androidActivity() will be called. Otherwise startActivityForResult() will be called.

The receiverRequestCode is a request code unique to the resultReceiver, and will be returned along with the result, making it possible to use the same receiver for more than one intent.

This function was introduced in Qt 5.13.

void QtAndroid::startActivity(const QAndroidJniObject &intent, int receiverRequestCode, std::function<void (int, int, const QAndroidJniObject &)> callbackFunc)

Starts the activity given by intent, using the request code receiverRequestCode, and provides the result by calling callbackFunc.

This function was introduced in Qt 5.13.

void QtAndroid::startIntentSender(const QAndroidJniObject &intentSender, int receiverRequestCode, QAndroidActivityResultReceiver *resultReceiver = nullptr)

Starts the activity given by intentSender and provides the result asynchronously through the resultReceiver if this is non-null.

If resultReceiver is null, then the startIntentSender() method in the androidActivity() will be called. Otherwise startIntentSenderForResult() will be called.

The receiverRequestCode is a request code unique to the resultReceiver, and will be returned along with the result, making it possible to use the same receiver for more than one intent.

This function was introduced in Qt 5.3.