DpcMigrationClient

Kotlin |Java

interface DpcMigrationClient

---

Permet au client d'envoyer des requêtes liées à la migration DPC.

Résumé

Fonctions publiques
ListenableFuture<DpcMigrationAttempt?>	getMigrationAttempt(     getMigrationAttemptRequest: GetDpcMigrationAttemptRequest ) Récupère une tentative de migration.
suspend DpcMigrationAttempt?	getMigrationAttemptAwait(     getMigrationAttemptRequest: GetDpcMigrationAttemptRequest ) Récupère une tentative de migration.
ListenableFuture<List<DpcMigrationAttempt>>	listMigrationAttempts() Renvoie la liste de toutes les tentatives de migration.
suspend List<DpcMigrationAttempt>	listMigrationAttemptsAwait() Renvoie la liste de toutes les tentatives de migration.
ListenableFuture<DpcMigrationAttempt>	migrateDeviceManagementToAndroidManagementApi(     notificationServiceComponentName: ComponentName,     adminComponentName: ComponentName,     migrationRequest: DpcMigrationRequest ) Faites migrer cet appareil pour qu'il soit géré par l'API Android Management.
suspend DpcMigrationAttempt	migrateDeviceManagementToAndroidManagementApiAwait(     notificationServiceComponentName: ComponentName,     adminComponentName: ComponentName,     migrationRequest: DpcMigrationRequest ) Faites migrer cet appareil pour qu'il soit géré par l'API Android Management.

Fonctions publiques

getMigrationAttempt

fun getMigrationAttempt(
    getMigrationAttemptRequest: GetDpcMigrationAttemptRequest
): ListenableFuture<DpcMigrationAttempt?>

Récupère une tentative de migration.

Si aucun nom n'est spécifié dans GetDpcMigrationAttemptRequest, le DpcMigrationAttempt le plus récent est renvoyé.

Cette méthode ne peut être appelée que par un propriétaire d'appareil ou un propriétaire de profil, ou par un propriétaire d'appareil ou de profil précédent ayant migré vers l'API Android Management.

Renvoie

ListenableFuture<DpcMigrationAttempt?>

Un ListenableFuture encapsulant le résultat. Il peut s'agir Un avenir réussi encapsulant une DpcMigrationAttempt en cas de réussite. Encapsulation réussie pour l'avenir, si DpcMigrationAttempt est introuvable. Échec de l'encapsulation d'un SecurityException si l'appelant n'est pas un propriétaire d'appareil ni un propriétaire de profil, ou un ancien propriétaire d'appareil ou de profil ayant migré vers l'API Android Management. Échec de l'encapsulation future de DpcMigrationException Si l'appel lié à la migration DPC a échoué. Le message et le sous-type de l'exception contiennent plus de détails sur l'échec.

getMigrationAttemptAwait

suspend fun getMigrationAttemptAwait(
    getMigrationAttemptRequest: GetDpcMigrationAttemptRequest
): DpcMigrationAttempt?

Récupère une tentative de migration.

Si aucun nom n'est spécifié dans GetDpcMigrationAttemptRequest, le DpcMigrationAttempt le plus récent est renvoyé.

Cette méthode ne peut être appelée que par un propriétaire d'appareil ou un propriétaire de profil, ou par un propriétaire d'appareil ou de profil précédent ayant migré vers l'API Android Management.

Renvoie
DpcMigrationAttempt?	Valeur DpcMigrationAttempt demandée ou valeur nulle, si elle est introuvable

Génère
java.lang.SecurityException	Si l'appelant n'est pas un propriétaire d'appareil ni un propriétaire de profil, ou un ancien propriétaire d'appareil ou de profil ayant migré vers l'API Android Management.
com.google.android.managementapi.dpcmigration.DpcMigrationException	Si l'appel lié à la migration DPC a échoué. Le message et le sous-type de l'exception contiennent plus de détails sur l'échec.

listMigrationAttempts

fun listMigrationAttempts(): ListenableFuture<List<DpcMigrationAttempt>>

Renvoie la liste de toutes les tentatives de migration.

Cette méthode ne peut être appelée que par un propriétaire d'appareil ou un propriétaire de profil, ou par un propriétaire d'appareil ou de profil précédent ayant migré vers l'API Android Management. Remarque: Les tentatives de migration plus anciennes sont automatiquement supprimées et ne sont pas renvoyées.

Renvoie

ListenableFuture<List<DpcMigrationAttempt>>

Un ListenableFuture encapsulant le résultat. Il peut s'agir Un avenir réussi encapsulant une liste de DpcMigrationAttempt en cas de réussite. Échec de l'encapsulation d'un SecurityException si l'appelant n'est pas un propriétaire d'appareil ni un propriétaire de profil, ou un ancien propriétaire d'appareil ou de profil ayant migré vers l'API Android Management. Échec de l'encapsulation future de DpcMigrationException Si l'appel lié à la migration DPC a échoué. Le message et le sous-type de l'exception contiennent plus de détails sur l'échec.

listMigrationAttemptsAwait

suspend fun listMigrationAttemptsAwait(): List<DpcMigrationAttempt>

Renvoie la liste de toutes les tentatives de migration.

Cette méthode ne peut être appelée que par un propriétaire d'appareil ou un propriétaire de profil, ou par un propriétaire d'appareil ou de profil précédent ayant migré vers l'API Android Management. Remarque: Les tentatives de migration plus anciennes sont automatiquement supprimées et ne sont pas renvoyées.

Renvoie
List<DpcMigrationAttempt>	Liste de DpcMigrationAttempt

Génère
java.lang.SecurityException	Si l'appelant n'est pas un propriétaire d'appareil ni un propriétaire de profil, ou un ancien propriétaire d'appareil ou de profil ayant migré vers l'API Android Management.
com.google.android.managementapi.dpcmigration.DpcMigrationException	Si l'appel lié à la migration DPC a échoué. Le message et le sous-type de l'exception contiennent plus de détails sur l'échec.

migrateDeviceManagementToAndroidManagementApi

fun migrateDeviceManagementToAndroidManagementApi(
    notificationServiceComponentName: ComponentName,
    adminComponentName: ComponentName,
    migrationRequest: DpcMigrationRequest
): ListenableFuture<DpcMigrationAttempt>

Faites migrer cet appareil pour qu'il soit géré par l'API Android Management.

Une fois la migration terminée, l'application appelante perd ses droits de propriétaire de l'appareil ou de propriétaire de profil, car ces droits sont transférés vers Android Device Policy.

Avertissement: Cette action est irréversible. L'élément ListenableFuture renvoyé se termine une fois qu'Android Device Policy a reçu la requête et effectué des vérifications préliminaires sur le jeton de migration. En cas d'échec, ListenableFuture encapsule une Exception.

Cette méthode ne peut être appelée que par un propriétaire d'appareil ou un propriétaire de profil. Sur Android 10 et versions antérieures, cette méthode ne doit pas être appelée sur un appareil ayant à la fois un propriétaire d'appareil et un propriétaire de profil.

Les réseaux Wi-Fi configurés doivent être transmis dans DpcMigrationRequest par le propriétaire du profil (sauf sur Android 12) sur un appareil personnel si des réseaux Wi-Fi sont configurés. Elles ne doivent pas être transmises sur un appareil détenu par l'entreprise. Notez que ces réseaux Wi-Fi seront supprimés juste avant le transfert de la gestion des appareils vers Android Device Policy. En cas d'échec de la suppression d'un réseau, la migration échoue également. Étant donné que la suppression des réseaux n'est pas une opération atomique, il est possible que certains réseaux aient déjà été supprimés.

Sur les appareils personnels dotés d'un profil professionnel sous Android 12, tous les réseaux Wi-Fi configurés par le DPC appelant seront supprimés juste avant que la gestion des appareils ne soit migrée vers Android Device Policy, quels que soient les réseaux Wi-Fi transmis dans migrationRequest.

Paramètres
notificationServiceComponentName: ComponentName	Le ComponentName du service qui étend NotificationReceiverService. Il doit s'agir d'un composant valide appartenant à l'application appelante et exporté dans le fichier manifeste. Sinon, une IllegalArgumentException sera générée.
adminComponentName: ComponentName	Le ComponentName de l'administrateur DeviceAdminReceiver du DPC appelant.
migrationRequest: DpcMigrationRequest	Le DpcMigrationRequest contenant le jeton de migration et les réseaux Wi-Fi configurés. Ces derniers ne sont requis que si l'appelant est le propriétaire de profil d'un appareil personnel et a configuré des réseaux.

Renvoie

ListenableFuture<DpcMigrationAttempt>

Un ListenableFuture encapsulant le résultat. Il peut s'agir Un avenir réussi encapsulant une DpcMigrationAttempt en cas de réussite. Échec de l'encapsulation d'un SecurityException si l'appelant n'est pas un propriétaire d'appareil ni un propriétaire de profil. Échec de l'encapsulation ultérieure d'un IllegalArgumentException, si le jeton de migration est vide, ou si notificationServiceComponentName ne fait pas référence à un composant valide qui étend NotificationReceiverService et qui est exporté dans le fichier manifeste, ou si adminComponentName n'est pas un administrateur actif appartenant au package actuel. Échec de l'encapsulation de DpcMigrationException si l'appel lié à la migration DPC a échoué. Le message et le sous-type de l'exception contiennent plus de détails sur l'échec.

migrateDeviceManagementToAndroidManagementApiAwait

suspend fun migrateDeviceManagementToAndroidManagementApiAwait(
    notificationServiceComponentName: ComponentName,
    adminComponentName: ComponentName,
    migrationRequest: DpcMigrationRequest
): DpcMigrationAttempt

Faites migrer cet appareil pour qu'il soit géré par l'API Android Management.

Une fois la migration terminée, l'application appelante perd ses droits de propriétaire de l'appareil ou de propriétaire de profil, car ces droits sont transférés vers Android Device Policy.

Avertissement: Cette action est irréversible. Cette fonctionnalité de suspension est renvoyée lorsqu'Android Device Policy a reçu la requête et effectué des vérifications préliminaires sur le jeton de migration. En cas d'échec, une Exception est générée.

Cette méthode ne peut être appelée que par un propriétaire d'appareil ou un propriétaire de profil. Sur Android 10 et versions antérieures, cette méthode ne doit pas être appelée sur un appareil ayant à la fois un propriétaire d'appareil et un propriétaire de profil.

Les réseaux Wi-Fi configurés doivent être transmis dans DpcMigrationRequest par le propriétaire du profil (sauf sur Android 12) sur un appareil personnel si des réseaux Wi-Fi sont configurés. Elles ne doivent pas être transmises sur un appareil détenu par l'entreprise. Notez que ces réseaux Wi-Fi seront supprimés juste avant le transfert de la gestion des appareils vers Android Device Policy. En cas d'échec de la suppression d'un réseau, la migration échoue également. Étant donné que la suppression des réseaux n'est pas une opération atomique, il est possible que certains réseaux aient déjà été supprimés.

Sur les appareils personnels dotés d'un profil professionnel sous Android 12, tous les réseaux Wi-Fi configurés par le DPC appelant seront supprimés juste avant que la gestion des appareils ne soit migrée vers Android Device Policy, quels que soient les réseaux Wi-Fi transmis dans migrationRequest.

Paramètres
notificationServiceComponentName: ComponentName	Le ComponentName du service qui étend NotificationReceiverService. Il doit s'agir d'un composant valide appartenant à l'application appelante et exporté dans le fichier manifeste. Sinon, une IllegalArgumentException sera générée.
adminComponentName: ComponentName	Le ComponentName de l'administrateur DeviceAdminReceiver du DPC appelant.
migrationRequest: DpcMigrationRequest	Le DpcMigrationRequest contenant le jeton de migration et les réseaux Wi-Fi configurés. Ces derniers ne sont requis que si l'appelant est le propriétaire de profil d'un appareil personnel et a configuré des réseaux.

Renvoie
DpcMigrationAttempt	DpcMigrationException indiquant l'état actuel de la migration en cas de réussite.

Génère
java.lang.SecurityException	Si l'appelant n'est pas un propriétaire de l'appareil ni un propriétaire de profil.
java.lang.IllegalArgumentException	Si le jeton de migration est vide, ou si notificationServiceComponentName ne fait pas référence à un composant valide qui étend NotificationReceiverService et qui est exporté dans le fichier manifeste, ou si adminComponentName n'est pas un administrateur actif appartenant au package actuel.
com.google.android.managementapi.dpcmigration.DpcMigrationException	Si l'appel lié à la migration DPC a échoué. Le message et le sous-type de l'exception contiennent plus de détails sur l'échec.