Importare ed esportare i dati della schermata Home

I dati della schermata Home di Android sono forniti dalla classe LauncherProvider, che estende ContentProvider, consentendo l'importazione e l'esportazione dei dati dello spazio di lavoro di Launcher utilizzando XML.

Interagire con il fornitore di contenuti

Per interagire con la classe LaunchProvider, che estende ContentProvider, utilizza il metodo call:

class LauncherProvider : ContentProvider {
    public Bundle call(String method, String arg, Bundle extras);
}

Richiamare la classe LaunchProvider

Per richiamare la classe LauncherProvider dalla tua app, utilizza quanto segue:

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()
    }
}

Parametri

Queste costanti vengono utilizzate nel metodo di chiamata:

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";
}

Utilizza le costanti LauncherProvider con i seguenti vincoli:

• Utilizza il metodo contentResolver.call con EXPORT_LAYOUT_XML come parametro del metodo per esportare una rappresentazione XML dello spazio di lavoro del launcher.
• Durante l'esportazione, la rappresentazione XML è accessibile nel bundle restituito utilizzando la chiave KEY_LAYOUT.
• Utilizza il metodo contentResolver.call con IMPORT_LAYOUT_XML come parametro del metodo per importare una rappresentazione XML dello spazio di lavoro dell'app di avvio.
• Durante l'importazione, la rappresentazione XML viene fornita come parametro arg del metodo di chiamata.
• Per le chiamate API di esportazione e importazione, il completamento corretto dell'operazione scelta restituisce success, mentre le operazioni interrotte o non riuscite restituiscono failure.
• Il valore success o failure è recuperabile nel bundle restituito utilizzando la chiave KEY_RESULT.

Per un esempio, consulta Richiamare la classe LaunchProvider.

Rappresentazione XML

Utilizza le seguenti guide per la struttura XML durante l'importazione e l'esportazione.

• App 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 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>
  

• Cartella:

  <?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>
  

• Scorciatoia avanzata:

  <?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
  <workspace>
    <shortcut shortcutId="shortcut2" packageName="com.google.android.apps.nexuslauncher.tests" />
  </workspace>
  

• Coppia di app:

  <?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>
  

Ipotesi comportamentali

Di seguito sono riportate le ipotesi comportamentali per la classe LaunchProvider.

• I metodi sono atomici e bloccanti.
• I dati analoghi nel launcher vengono sovrascritti durante l'importazione, lasciando solo i dati appena importati.
• I dati importati sono immediatamente accessibili; l'esportazione subito dopo l'importazione restituisce i nuovi dati.