This class implements helper functions for android platforms. More...

#include <Utilities.h>

Static Public Member Functions
static std::string	toAString (JNIEnv *env, jstring javaString)
	Converts a Java native string to a std string.

static jstring	toJavaString (JNIEnv *env, const std::string &stdString)
	Converts a std string to a Java native string.

static jobjectArray	toJavaStringArray (JNIEnv *env, const std::vector< std::string > &strings)
	Converts a vector of std strings to a Java array with native strings.

static bool	toVector (JNIEnv *env, jobject javaStringList, std::vector< std::string > &strings)
	Converts a Java native list with string to a vector of strings.

static bool	toVector (JNIEnv *env, jobject javaIntegerList, std::vector< int > &values)
	Converts a Java native list with integer to a vector of integers.

static bool	className (JNIEnv *env, jobject object, std::string &name)
	Returns the class name of an object.

static bool	manifestVersion (JavaVM *javaVM, jobject activity, int &versionCode, std::string &versionName)
	Returns the version code stored in the application manifest.

static bool	manifestVersionCode (JavaVM *javaVM, jobject activity, int &versionCode)
	Deprecated.

static bool	manifestSdkVersions (JNIEnv *env, jobject activity, unsigned int &minSdkVersion, unsigned int &targetSdkVersion)
	Returns the minimum and target SDK versions stored in the application manifest.

static bool	androidReleaseVersion (JNIEnv *env, std::string &version)
	Return the Android release version of the system (android.os.Build.VERSION.RELEASE).

static bool	androidSdkVersion (JNIEnv *env, unsigned int &version)
	Return the Android SDK version of the system (android.os.Build.VERSION.SDK).

static bool	systemPropertyValue (const std::string &name, std::string &value)
	Returns the value of a specific system property.

static bool	deviceBrand (JNIEnv *env, std::string &brand)
	Returns the brand string of the device.

static bool	deviceModel (JNIEnv *env, std::string &model)
	Returns the model string of the device.

static bool	determinePackageName (std::string &packageName)
	Returns the name of the package.

static bool	sendIntentToComponent (JNIEnv *env, jobject activity, const std::string &packageName, const std::string &className, const std::string &extraText)
	Sends an explicit intent to another component or application.

static bool	startActivity (JNIEnv *env, jobject rootActivity, const std::string &activityClassName)
	Starts an new activity from a root activity.

static bool	connectToWifi (JNIEnv *env, jobject activity, const std::string &ssid, const std::string &password)
	Joins a Wi-Fi network (WPA2-PSK).

static bool	sendIntentToConnectToWifi (JNIEnv *env, jobject activity, const std::string &ssid, const std::string &password)
	Sends an intent to the OS to request it to join a Wi-Fi network (WPA2-PSK).

static bool	currentWifiSsid (JNIEnv *env, jobject activity, std::string &ssid)
	Returns current Wi-Fi network name (SSID).

static bool	triggerVibration (JNIEnv *env, jobject activity, unsigned int intensity=1u, const unsigned int duration=50u)
	Triggers a vibration.

Detailed Description

This class implements helper functions for android platforms.

Member Function Documentation

◆ androidReleaseVersion()

static bool Ocean::Platform::Android::Utilities::androidReleaseVersion	(	JNIEnv *	env,
		std::string &	version
	)

static

Return the Android release version of the system (android.os.Build.VERSION.RELEASE).

Parameters

env	The Java environment, must be valid
version	The resulting Android release version, only valid if this function returns 'true'

Returns: True, if succeeded, otherwise false

◆ androidSdkVersion()

static bool Ocean::Platform::Android::Utilities::androidSdkVersion	(	JNIEnv *	env,
		unsigned int &	version
	)

static

Return the Android SDK version of the system (android.os.Build.VERSION.SDK).

Parameters

env	The Java environment, must be valid
version	The resulting Android SDK version, only valid if this function returns 'true'

Returns: True, if succeeded, otherwise false

◆ className()

static bool Ocean::Platform::Android::Utilities::className	(	JNIEnv *	env,
		jobject	object,
		std::string &	name
	)

static

Returns the class name of an object.

Parameters

env	The Java environment, must be valid
object	The object for which the class name will be returned, must be valid
name	The resulting class name

Returns: True, if succeeded

◆ connectToWifi()

static bool Ocean::Platform::Android::Utilities::connectToWifi	(	JNIEnv *	env,
		jobject	activity,
		const std::string &	ssid,
		const std::string &	password
	)

static

Joins a Wi-Fi network (WPA2-PSK).

This only works with Android SDK version 28 or below.

Parameters

env	The Java environment, must be valid
activity	The root activity from which the new activity will be started, must be valid
ssid	The Wi-Fi network name (SSID), the network must be using WPA2, must be valid
password	The Wi-Fi network password, must be valid

Returns: True, if joined successfully, otherwise false

◆ currentWifiSsid()

static bool Ocean::Platform::Android::Utilities::currentWifiSsid	(	JNIEnv *	env,
		jobject	activity,
		std::string &	ssid
	)

static

Returns current Wi-Fi network name (SSID).

Parameters

env	The Java environment, must be valid
activity	The root activity from which the new activity will be started, must be valid
ssid	The resulting Wi-Fi network name (SSID), will be empty if there is no Wi-Fi connection

Returns: True, if succeeded

◆ determinePackageName()

static bool Ocean::Platform::Android::Utilities::determinePackageName ( std::string & packageName )

static

Returns the name of the package.

Parameters

packageName The resulting package name

Returns: True, if succeeded

◆ deviceBrand()

static bool Ocean::Platform::Android::Utilities::deviceBrand	(	JNIEnv *	env,
		std::string &	brand
	)

static

Returns the brand string of the device.

Parameters

env	The Java environment, must be valid
brand	The resulting model string

Returns: True, if succeeded

◆ deviceModel()

static bool Ocean::Platform::Android::Utilities::deviceModel	(	JNIEnv *	env,
		std::string &	model
	)

static

Returns the model string of the device.

Parameters

env	The Java environment, must be valid
model	The resulting model string

Returns: True, if succeeded

◆ manifestSdkVersions()

static bool Ocean::Platform::Android::Utilities::manifestSdkVersions	(	JNIEnv *	env,
		jobject	activity,
		unsigned int &	minSdkVersion,
		unsigned int &	targetSdkVersion
	)

static

Returns the minimum and target SDK versions stored in the application manifest.

Parameters

env	The Java environment, must be valid
activity	The Android main activity, must be valid
minSdkVersion	The resulting minimum SDK version of the application as defined in its manifest
targetSdkVersion	The resulting target SDK version of the application as defined in its manifest

Returns: True, if succeeded

◆ manifestVersion()

static bool Ocean::Platform::Android::Utilities::manifestVersion	(	JavaVM *	javaVM,
		jobject	activity,
		int &	versionCode,
		std::string &	versionName
	)

static

Returns the version code stored in the application manifest.

Parameters

javaVM	The Java virtual machine, must be valid
activity	The Android main activity, must be valid
versionCode	The resulting version code of the application
versionName	The resulting version name of the application

Returns: True, if succeeded

◆ manifestVersionCode()

static bool Ocean::Platform::Android::Utilities::manifestVersionCode	(	JavaVM *	javaVM,
		jobject	activity,
		int &	versionCode
	)

static

Deprecated.

Returns the version code stored in the application manifest.

Parameters

javaVM	The Java virtual machine, must be valid
activity	The Android main activity, must be valid
versionCode	The version code of the application

Returns: True, if succeeded

◆ sendIntentToComponent()

static bool Ocean::Platform::Android::Utilities::sendIntentToComponent	(	JNIEnv *	env,
		jobject	activity,
		const std::string &	packageName,
		const std::string &	className,
		const std::string &	extraText
	)

static

Sends an explicit intent to another component or application.

Parameters

env	The Java environment, must be valid
activity	The Android main activity, must be valid
packageName	The name of the package to which the intent will be sent, must be valid
className	The name of the class or activity to which the intent will be sent, must be valid
extraText	The data that will be sent with the intent, must be valid

Returns: True, if the intent was sent successfully, otherwise false

◆ sendIntentToConnectToWifi()

static bool Ocean::Platform::Android::Utilities::sendIntentToConnectToWifi	(	JNIEnv *	env,
		jobject	activity,
		const std::string &	ssid,
		const std::string &	password
	)

static

Sends an intent to the OS to request it to join a Wi-Fi network (WPA2-PSK).

The intent is send to the system settings app to save and connect to a new Wi-Fi network. This will display a notification to user to accept or reject the new Wi-Fi network. Additional notes:

The Wi-Fi network must use the security protocol WPA2-PSK.
This function requires Android SDK version 29 or higher.
This function requires the permissions android.permission.CHANGE_NETWORK_STATE and android.permission.WRITE_SETTINGS to be set in the app manifest to work.
Rejecting a new network does NOT revoke the permission android.permission.CHANGE_NETWORK_STATE again. Re-tries are possible.
The newly added networks do NOT have to reachable at the time of adding them (they will be stored for when they become available).

The system app receiving the intent sent here must implement a handler for the action type Settings.ACTION_WIFI_ADD_NETWORKS. Otherwise this function will have no effect (and still return true).

Parameters

env	The Java environment, must be valid
activity	The root activity from which the new activity will be started, must be valid
ssid	The Wi-Fi network name (SSID), the network must be using WPA2, must be valid
password	The Wi-Fi network password, must be valid

Returns: True, if the intent was sent successfully, otherwise false

◆ startActivity()

static bool Ocean::Platform::Android::Utilities::startActivity	(	JNIEnv *	env,
		jobject	rootActivity,
		const std::string &	activityClassName
	)

static

Starts an new activity from a root activity.

Parameters

env	The Java environment, must be valid
rootActivity	The root activity from which the new activity will be started, must be valid
activityClassName	The name of the class of the activity to start, must be valid

Returns: True, if succeeded

◆ systemPropertyValue()

static bool Ocean::Platform::Android::Utilities::systemPropertyValue	(	const std::string &	name,
		std::string &	value
	)

static

Returns the value of a specific system property.

Parameters

name	The name of the system property, must be valid
value	The resulting value

Returns: True, if succeeded

◆ toAString()

static std::string Ocean::Platform::Android::Utilities::toAString	(	JNIEnv *	env,
		jstring	javaString
	)

static

Converts a Java native string to a std string.

Parameters

env	The Java environment, must be valid
javaString	Java string to be converted, may be nullptr

Returns: Resulting std string

◆ toJavaString()

static jstring Ocean::Platform::Android::Utilities::toJavaString	(	JNIEnv *	env,
		const std::string &	stdString
	)

static

Converts a std string to a Java native string.

Parameters

env	The Java environment, must be valid
stdString	Std string to be converted

Returns: Resulting Java native string

◆ toJavaStringArray()

static jobjectArray Ocean::Platform::Android::Utilities::toJavaStringArray	(	JNIEnv *	env,
		const std::vector< std::string > &	strings
	)

static

Converts a vector of std strings to a Java array with native strings.

Parameters

env	The Java environment, must be valid
strings	Std strings to be converted, can be empty

Returns: Resulting Java native string

◆ toVector() [1/2]

static bool Ocean::Platform::Android::Utilities::toVector	(	JNIEnv *	env,
		jobject	javaIntegerList,
		std::vector< int > &	values
	)

static

Converts a Java native list with integer to a vector of integers.

Parameters

env	The Java environment, must be valid
javaIntegerList	Java list with integers to be converted, must be valid
values	The resulting vector of integers

Returns: True, if succeeded

◆ toVector() [2/2]

static bool Ocean::Platform::Android::Utilities::toVector	(	JNIEnv *	env,
		jobject	javaStringList,
		std::vector< std::string > &	strings
	)

static

Converts a Java native list with string to a vector of strings.

Parameters

env	The Java environment, must be valid
javaStringList	Java list with strings to be converted, must be valid
strings	The resulting vector of strings

Returns: True, if succeeded

◆ triggerVibration()

static bool Ocean::Platform::Android::Utilities::triggerVibration	(	JNIEnv *	env,
		jobject	activity,
		unsigned int	intensity = `1u`,
		const unsigned int	duration = `50u`
	)

static

Triggers a vibration.

This function needs permission 'android.permission.VIBRATE'.

Parameters

env	The Java environment, must be valid
activity	The root activity from which the new activity will be started, must be valid
intensity	The intensity of the vibration, the higher the stronger, with range [0, 2]
duration	The duration of the vibration in milliseconds, with range [1, infinity)

Returns: True, if succeeded

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

platform/android/Utilities.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ androidReleaseVersion()

◆ androidSdkVersion()

◆ className()

◆ connectToWifi()

◆ currentWifiSsid()

◆ determinePackageName()

◆ deviceBrand()

◆ deviceModel()

◆ manifestSdkVersions()

◆ manifestVersion()

◆ manifestVersionCode()

◆ sendIntentToComponent()

◆ sendIntentToConnectToWifi()

◆ startActivity()

◆ systemPropertyValue()

◆ toAString()

◆ toJavaString()

◆ toJavaStringArray()

◆ toVector() [1/2]

◆ toVector() [2/2]

◆ triggerVibration()