La clase LauncherProvider proporciona los datos de la pantalla principal de Android, que extiende ContentProvider, lo que permite importar y exportar datos del espacio de trabajo de Launcher con XML.
Interactúa con el proveedor de contenido
Para interactuar con la clase LaunchProvider, que extiende ContentProvider, usa el método call:
class LauncherProvider : ContentProvider {
public Bundle call(String method, String arg, Bundle extras);
}
Invoca la clase LaunchProvider
Para invocar la clase LauncherProvider desde tu app, usa lo siguiente:
class YourClass {
/**
* This method imports Launcher workspace data as a XML string. Calling this method clears the old
* data model within Launcher and replaces it with the imported data. It should be noted
* that it doesn't need to clear all the Launcher's data, just what is similar to what is being imported.
*/
fun importLauncherData(xmlRepresentation: String, ctx: Context): Boolean {
val uri = try {
getLauncherProviderUri(ctx)
} catch (e: IllegalStateException) {
Log.e(TAG, "Failed to get launcher provider URI", e)
return false
}
val bundle = ctx.contentResolver.call(
uri,
LauncherProviderConstants.METHOD_IMPORT_LAYOUT_XML,
xmlRepresentation,
null,
)
return LauncherProviderConstants.SUCCESS
.equals(bundle.getBoolean(LauncherProviderConstants.KEY_RESULT))
}
/**
* Use this function to retrieve an XML string representation of the Launcher's Workspace.
* This method doesn't return what the user sees on their home screen,
* but rather what is in their data model at the moment it's called.
*/
fun exportLauncherData(xmlRepresentation: String, ctx: Context): String {
val uri = try {
getLauncherProviderUri(ctx)
} catch (e: IllegalStateException) {
Log.e(TAG, "Failed to get launcher provider URI", e)
return ""
}
val bundle = ctx.contentResolver.call(
uri,
LauncherProviderConstants.METHOD_EXPORT_LAYOUT_XML,
null,
null,
)
if (LauncherProviderConstants.FAILURE
.equals(bundle.getBoolean(LauncherProviderConstants.KEY_RESULT))) {
Log.e(TAG, "failed to export launcher data; review previous logs for the cause.")
}
return bundle.getString(LauncherProviderConstants.KEY_LAYOUT, "")
}
/**
* Returns a Uri for interacting with Launcher's ContentProvider.
*
* Not all Launchers implement this api. This method throws an IllegalStateException
* if the Launcher doesn't support it.
*/
private fun getLauncherProviderUri(ctx: Context): Uri {
val homeIntent = Intent(Intent.ACTION_MAIN).addCategory(Intent.CATEGORY_HOME)
val launcherPackage: String =
ctx.packageManager
.resolveActivity(homeIntent, PackageManager.MATCH_DEFAULT_ONLY)
?.activityInfo
?.packageName ?: throw IllegalStateException("No launcher package found")
val authority = "${launcherPackage}.settings"
ctx.packageManager.resolveContentProvider(authority, 0)
?: throw IllegalStateException(
"Launcher package '$launcherPackage' does not support LauncherProvider",
)
return "content://$authority".toUri()
}
}
Parámetros
Estas constantes se usan en el método de llamada:
object LauncherProviderConstants {
// Valid arg parameters for export and import operations
private static final String METHOD_EXPORT_LAYOUT_XML = "EXPORT_LAYOUT_XML";
private static final String METHOD_IMPORT_LAYOUT_XML = "IMPORT_LAYOUT_XML";
// Bundle key and value set for determining if operation completed successfully or not
private static final String KEY_RESULT = "KEY_RESULT";
private static final String SUCCESS = "success";
private static final String FAILURE = "failure";
// Bundle key used to store exported XML-string representation of Launcher's workspace layout
// and item metadata
private static final String KEY_LAYOUT = "KEY_LAYOUT";
}
Usa las constantes LauncherProvider con las siguientes restricciones:
- Usa el método
contentResolver.callconEXPORT_LAYOUT_XMLcomo parámetro del método para exportar una representación XML del espacio de trabajo del selector. - Durante la exportación, se puede acceder a la representación XML en el paquete devuelto con la clave
KEY_LAYOUT. - Usa el método
contentResolver.callconIMPORT_LAYOUT_XMLcomo parámetro del método para importar una representación en XML del espacio de trabajo del selector. - Durante la importación, la representación XML se proporciona como el parámetro
argdel método de llamada. - En el caso de las llamadas a la API de importación y exportación, la finalización correcta de la operación elegida devuelve
success, y las operaciones interrumpidas o fallidas devuelvenfailure. - El valor de
successofailurese puede recuperar en el paquete devuelto con la claveKEY_RESULT.
Para ver un ejemplo, consulta Cómo invocar la clase LaunchProvider.
Representación en XML
Usa las siguientes guías para la estructura XML durante la importación y la exportación.
App de Workspace:
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <workspace rows="4" columns="5"> <autoinstall container="desktop" x="1" y="1" screen="0" className="com.android.launcher3.tests.Activity2" packageName="com.google.android.apps.nexuslauncher" /> </workspace>App de Hotseat:
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <workspace> <autoinstall container="hotseat" rank="0" className="com.android.launcher3.tests.Activity2" packageName="com.google.android.apps.nexuslauncher" /> </workspace>Widget:
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <workspace> <appwidget container="desktop" spanX="2" spanY="2" x="0" y="1" screen="0" className="PlaceholderWidget" packageName="com.test.pending" /> </workspace>Carpeta:
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <workspace> <folder container="desktop" x="1" y="1" screen="1" titleText="CustomFolder"> <autoinstall className="com.android.launcher3.tests.Activity1" packageName="com.google.android.apps.nexuslauncher" /> <autoinstall className="com.android.launcher3.tests.Activity2" packageName="com.google.android.apps.nexuslauncher" /> <autoinstall className="com.android.launcher3.tests.Activity3" packageName="com.google.android.apps.nexuslauncher" /> </folder> </workspace>Atajo profundo:
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <workspace> <shortcut shortcutId="shortcut2" packageName="com.google.android.apps.nexuslauncher.tests" /> </workspace>Vinculación de apps:
<?xml version='1.0' encoding='UTF-8' standalone='yes' ?> <workspace> <apppair container="desktop" x="1" y="1" screen="1" titleText="CustomFolder"> <autoinstall className="com.android.launcher3.tests.Activity1" packageName="com.google.android.apps.nexuslauncher" /> <autoinstall className="com.android.launcher3.tests.Activity2" packageName="com.google.android.apps.nexuslauncher" /> </apppair> </workspace>
Suposiciones de comportamiento
A continuación, se indican las suposiciones de comportamiento para la clase LaunchProvider.
- Los métodos son atómicos y bloqueantes.
- Los datos análogos del selector se sobrescriben durante la importación, por lo que solo quedan los datos importados recientemente.
- Se puede acceder a los datos importados de inmediato. Si los exportas justo después de importarlos, se devolverán los datos nuevos.