DpcMigrationClient

interface DpcMigrationClient


Клиент для выполнения запросов, связанных с миграцией ЦОД.

Краткое содержание

Общественные функции

ListenableFuture < DpcMigrationAttempt ?>
getMigrationAttempt (
getMigrationAttemptRequest: GetDpcMigrationAttemptRequest
)

Получает попытку миграции.

suspend DpcMigrationAttempt ?

Получает попытку миграции.

ListenableFuture < List < DpcMigrationAttempt >>

Возвращает список всех попыток миграции.

suspend List < DpcMigrationAttempt >

Возвращает список всех попыток миграции.

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

Перенесите это устройство под управление с помощью Android Management API.

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

Перенесите это устройство под управление с помощью Android Management API.

Общественные функции

GetMigrationAttempt

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

Получает попытку миграции.

Если в GetDpcMigrationAttemptRequest не указано имя, возвращается самый последний DpcMigrationAttempt .

Этот метод может вызвать только владелец устройства или владелец профиля, а также предыдущий владелец устройства или владелец профиля, который перешел на Android Management API.

Возврат
ListenableFuture < DpcMigrationAttempt ?>

ListenableFuture , обертывающий результат. Это может быть

  • Успешное будущее с оберткой DpcMigrationAttempt в случае успеха.

  • Успешная будущая нулевая упаковка, если DpcMigrationAttempt не найден.

  • Неудачная будущая упаковка SecurityException , если вызывающий абонент не является владельцем устройства или владельцем профиля или предыдущим владельцем устройства или владельцем профиля, который перешел на Android Management API.

  • Неудачная будущая упаковка DpcMigrationException Если вызов, связанный с миграцией dpc, не удался. Сообщение и подтип исключения содержат более подробную информацию об ошибке.

getMigrationAttemptAwait

suspend fun getMigrationAttemptAwait(
    getMigrationAttemptRequest: GetDpcMigrationAttemptRequest
): DpcMigrationAttempt?

Получает попытку миграции.

Если в GetDpcMigrationAttemptRequest не указано имя, возвращается самый последний DpcMigrationAttempt .

Этот метод может вызвать только владелец устройства или владелец профиля, а также предыдущий владелец устройства или владелец профиля, который перешел на Android Management API.

Возврат
DpcMigrationAttempt ?

Запрошенный DpcMigrationAttempt или значение NULL, если его невозможно найти.

Броски
java.lang.SecurityException

Если вызывающий абонент не является владельцем устройства или владельцем профиля, а также предыдущим владельцем устройства или владельцем профиля, который перешел на Android Management API.

com.google.android.managementapi.dpcmigration.DpcMigrationException

Если вызов, связанный с миграцией dpc, не удался. Сообщение и подтип исключения содержат более подробную информацию об ошибке.

списокПопытки миграции

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

Возвращает список всех попыток миграции.

Этот метод может вызвать только владелец устройства или владелец профиля, а также предыдущий владелец устройства или владелец профиля, который перешел на Android Management API. Примечание. Более старые попытки миграции автоматически удаляются и не возвращаются.

Возврат
ListenableFuture < List < DpcMigrationAttempt >>

ListenableFuture , обертывающий результат. Это может быть

  • Успешное будущее, оборачивающее список DpcMigrationAttempt в случае успеха.

  • Неудачная будущая упаковка SecurityException , если вызывающий абонент не является владельцем устройства или владельцем профиля или предыдущим владельцем устройства или владельцем профиля, который перешел на Android Management API.

  • Неудачная будущая упаковка DpcMigrationException Если вызов, связанный с миграцией dpc, не удался. Сообщение и подтип исключения содержат более подробную информацию об ошибке.

listMigrationAwait

suspend fun listMigrationAttemptsAwait(): List<DpcMigrationAttempt>

Возвращает список всех попыток миграции.

Этот метод может вызвать только владелец устройства или владелец профиля, а также предыдущий владелец устройства или владелец профиля, который перешел на Android Management API. Примечание. Более старые попытки миграции автоматически удаляются и не возвращаются.

Возврат
List < DpcMigrationAttempt >

Список DpcMigrationAttempt

Броски
java.lang.SecurityException

Если вызывающий абонент не является владельцем устройства или владельцем профиля, а также предыдущим владельцем устройства или владельцем профиля, который перешел на Android Management API.

com.google.android.managementapi.dpcmigration.DpcMigrationException

Если вызов, связанный с миграцией dpc, не удался. Сообщение и подтип исключения содержат более подробную информацию об ошибке.

МигрироватьDeviceManagementToAndroidManagementApi

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

Перенесите это устройство под управление с помощью Android Management API.

После завершения миграции вызывающее приложение теряет свои права владельца устройства или владельца профиля, поскольку они передаются в политику устройств Android.

Внимание: это действие нельзя отменить! Возвращенное ListenableFuture завершается, когда Android Device Policy получает запрос и завершает предварительную проверку токена миграции. В случае сбоя ListenableFuture обернет Exception .

Этот метод может вызвать только владелец устройства или владелец профиля. В Android 10 и более ранних версиях эту функцию нельзя вызывать на устройстве, у которого есть одновременно владелец устройства и владелец профиля.

Настроенные сети Wi-Fi должны быть переданы в DpcMigrationRequest владельцем профиля (за исключением Android 12) на личном устройстве, если оно настроило какие-либо сети Wi-Fi. Их нельзя передавать на корпоративное устройство. Обратите внимание, что эти сети Wi-Fi будут удалены непосредственно перед переносом управления устройствами в политику устройств Android. В случае неудачи при удалении сети миграция также завершится неудачей, а поскольку удаление сетей не является атомарной операцией, некоторые сети могли быть уже удалены.

На личных устройствах с рабочим профилем под управлением Android 12 все сети Wi-Fi, настроенные вызывающим центром обработки данных, будут удалены непосредственно перед переносом управления устройством в политику устройств Android, независимо от сетей Wi-Fi, переданных migrationRequest .

Параметры
notificationServiceComponentName: ComponentName

ComponentName службы, расширяющей NotificationReceiverService . Это должен быть действительный компонент, принадлежащий вызывающему приложению и экспортированный в манифест, в противном случае будет выдано исключение IllegalArgumentException .

adminComponentName: ComponentName

ComponentName администратора DeviceAdminReceiver вызывающего центра обработки данных.

migrationRequest: DpcMigrationRequest

DpcMigrationRequest , содержащий токен миграции и настроенные сети Wi-Fi. Последние требуются только в том случае, если вызывающий абонент является владельцем профиля на личном устройстве и настроил какие-либо сети.

Возврат
ListenableFuture < DpcMigrationAttempt >

ListenableFuture , обертывающий результат. Это может быть

  • Успешное будущее с оберткой DpcMigrationAttempt в случае успеха.

  • Неудачная будущая упаковка SecurityException , если вызывающий абонент не является владельцем устройства или владельцем профиля.

  • Неудачная будущая упаковка IllegalArgumentException , если токен миграции пуст, или notificationServiceComponentName не ссылается на допустимый компонент, расширяющий NotificationReceiverService , который экспортируется в манифест, или если adminComponentName не является активным администратором, принадлежащим текущему пакету.

  • Неудачная будущая оболочка DpcMigrationException , если вызов, связанный с миграцией dpc, завершился неудачно. Сообщение и подтип исключения содержат более подробную информацию об ошибке.

МигрироватьDeviceManagementToAndroidManagementApiAwait

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

Перенесите это устройство под управление с помощью Android Management API.

После завершения миграции вызывающее приложение теряет свои права владельца устройства или владельца профиля, поскольку они передаются в политику устройств Android.

Внимание: это действие нельзя отменить! Функция приостановки возвращается, когда Android Device Policy получает запрос и завершает предварительную проверку токена миграции. В случае неудачи выдается Exception .

Этот метод может вызвать только владелец устройства или владелец профиля. В Android 10 и более ранних версиях эту функцию нельзя вызывать на устройстве, у которого есть одновременно владелец устройства и владелец профиля.

Настроенные сети Wi-Fi должны быть переданы в DpcMigrationRequest владельцем профиля (за исключением Android 12) на личном устройстве, если оно настроило какие-либо сети Wi-Fi. Их нельзя передавать на корпоративное устройство. Обратите внимание, что эти сети Wi-Fi будут удалены непосредственно перед переносом управления устройствами в политику устройств Android. В случае неудачи при удалении сети миграция также завершится неудачей, а поскольку удаление сетей не является атомарной операцией, некоторые сети могли быть уже удалены.

На личных устройствах с рабочим профилем под управлением Android 12 все сети Wi-Fi, настроенные вызывающим центром обработки данных, будут удалены непосредственно перед переносом управления устройством в политику устройств Android, независимо от сетей Wi-Fi, переданных migrationRequest .

Параметры
notificationServiceComponentName: ComponentName

ComponentName службы, расширяющей NotificationReceiverService . Это должен быть действительный компонент, принадлежащий вызывающему приложению и экспортированный в манифест, в противном случае будет выдано исключение IllegalArgumentException .

adminComponentName: ComponentName

ComponentName администратора DeviceAdminReceiver вызывающего центра обработки данных.

migrationRequest: DpcMigrationRequest

DpcMigrationRequest , содержащий токен миграции и настроенные сети Wi-Fi. Последние требуются только в том случае, если вызывающий абонент является владельцем профиля на личном устройстве и настроил какие-либо сети.

Возврат
DpcMigrationAttempt

DpcMigrationException с текущим статусом миграции в случае успеха.

Броски
java.lang.SecurityException

Если вызывающий абонент не является владельцем устройства или владельцем профиля.

java.lang.IllegalArgumentException

Если токен миграции пуст, или notificationServiceComponentName не ссылается на допустимый компонент, расширяющий NotificationReceiverService , который экспортируется в манифест, или если adminComponentName не является активным администратором, принадлежащим текущему пакету.

com.google.android.managementapi.dpcmigration.DpcMigrationException

Если вызов, связанный с миграцией dpc, не удался. Сообщение и подтип исключения содержат более подробную информацию об ошибке.