AccountSetupClient

public interface AccountSetupClient

Ứng dụng để quản lý quá trình thiết lập tài khoản được quản lý trên thiết bị.

Yêu cầu về việc tích hợp vòng đời: Để xử lý chính xác các lệnh gọi lại kết quả mà các thao tác như launchAuthenticationActivity yêu cầu, ứng dụng này dựa vào AndroidX Activity Result API. Phương thức gọi phải tích hợp ứng dụng này với vòng đời thành phần Android (Hoạt động hoặc Mảnh) bằng cách:

  1. Truy xuất đối tượng theo dõi bằng getLifecycleObserver.

  2. Đăng ký đối tượng tiếp nhận dữ liệu này bằng Lifecycle của Hoạt động hoặc Mảnh lưu trữ, thường là trong onCreate (ví dụ: lifecycle.addObserver(client.lifecycleObserver)).

Thông tin cập nhật về trạng thái: Để nhận thông báo về những thay đổi đối với trạng thái thiết lập tài khoản không đồng bộ, ứng dụng gọi cần:

  1. Triển khai giao diện AccountSetupListener.

  2. Cung cấp một quy trình triển khai để xử lý thông tin cập nhật trạng thái đã nhận.

  3. Mở rộng NotificationReceiverService và cung cấp một thực thể AccountSetupListener.

  4. Thêm lớp NotificationReceiverService mở rộng vào AndroidManifest.xml và đảm bảo lớp này được xuất.

Hãy dùng AccountSetupClientFactory để tạo một thực thể của ứng dụng khách này.

Tóm tắt

Phương thức công khai
abstract @NonNull AccountSetupAttempt
cancelAccountSetupAttempt(
    @NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest
)

Huỷ bỏ lần thiết lập tài khoản được chỉ định.
abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt>

Huỷ bỏ lần thiết lập tài khoản được chỉ định.
abstract @NonNull LifecycleObserver

LifecycleObserver xử lý chế độ thiết lập phụ thuộc vào vòng đời cho ứng dụng này.
abstract @NonNull AccountSetupAttempt
launchAuthenticationActivity(
    @NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest
)

Khởi chạy hoạt động minute maid để xác thực người dùng hoặc bộ chọn tài khoản nếu tài khoản đã có trên thiết bị.
abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt>

Khởi chạy hoạt động minute maid để xác thực người dùng hoặc bộ chọn tài khoản nếu tài khoản đã có trên thiết bị.
abstract @NonNull List<@NonNull AccountSetupAttempt>

Liệt kê tất cả các lần thiết lập tài khoản.
abstract @NonNull ListenableFuture<@NonNull List<@NonNull AccountSetupAttempt>>

Liệt kê tất cả các lần thiết lập tài khoản.
abstract @NonNull AccountSetupAttempt
startAccountSetup(
    @NonNull StartAccountSetupRequest startAccountSetupRequest
)

Bắt đầu thiết lập tài khoản.
abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt>
startAccountSetupFuture(
    @NonNull StartAccountSetupRequest startAccountSetupRequest
)

Bắt đầu thiết lập tài khoản.

Phương thức công khai

cancelAccountSetupAttempt

abstract @NonNull AccountSetupAttempt cancelAccountSetupAttempt(
    @NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest
)

Huỷ bỏ lần thiết lập tài khoản được chỉ định.

Thông số
@NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest

Yêu cầu huỷ nỗ lực thiết lập tài khoản.
Giá trị trả về
@NonNull AccountSetupAttempt

Nỗ lực thiết lập tài khoản đã cập nhật.

cancelAccountSetupAttemptFuture

abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt> cancelAccountSetupAttemptFuture(
    @NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest
)

Huỷ bỏ lần thiết lập tài khoản được chỉ định.

Thông số
@NonNull CancelAccountSetupAttemptRequest cancelAccountSetupAttemptRequest

Yêu cầu huỷ nỗ lực thiết lập tài khoản.
Giá trị trả về
@NonNull ListenableFuture<@NonNull AccountSetupAttempt>

Một ListenableFuture bao bọc kết quả. Đây có thể là

  • Một tương lai thành công bao gồm nỗ lực cập nhật chế độ thiết lập tài khoản.

  • Một future không thành công nếu không tìm thấy nỗ lực thiết lập tài khoản hoặc nỗ lực đó đã ở trạng thái cuối cùng (lỗi hoặc thành công).

getLifecycleObserver

abstract @NonNull LifecycleObserver getLifecycleObserver()

LifecycleObserver xử lý chế độ thiết lập phụ thuộc vào vòng đời cho ứng dụng này.

Đối tượng tiếp nhận dữ liệu này phải được đăng ký bằng Lifecycle của Hoạt động hoặc Mảnh đang lưu trữ phiên bản ứng dụng này (ví dụ: lifecycle.addObserver(...) thường được gọi trong onCreate của máy chủ lưu trữ).

Việc đăng ký trình theo dõi này cho phép ứng dụng khởi động chính xác các thành phần nội bộ, đặc biệt là androidx.activity.result.ActivityResultLauncher cần thiết để xử lý kết quả của launchAuthenticationActivity. Nếu không đăng ký đối tượng theo dõi này, bạn sẽ gặp lỗi khi cố gắng chạy hoạt động xác thực.

launchAuthenticationActivity

abstract @NonNull AccountSetupAttempt launchAuthenticationActivity(
    @NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest
)

Khởi chạy hoạt động minute maid để xác thực người dùng hoặc bộ chọn tài khoản nếu tài khoản đã có trên thiết bị.

Thông số
@NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest

Yêu cầu khởi chạy hoạt động xác thực. Yêu cầu phải chứa một lần thiết lập tài khoản ở trạng thái AUTHENTICATION_ACTIVITY_LAUNCH_REQUIRED_INFORMATION.
Gửi
java.lang.SecurityException

Nếu người gọi không phải là Chủ sở hữu thiết bị hoặc Chủ sở hữu hồ sơ.
com.google.android.managementapi.accountsetup.AccountSetupInvalidStateException

Nếu quá trình thiết lập tài khoản không ở trạng thái AUTHENTICATION_ACTIVITY_LAUNCH_REQUIRED_INFORMATION.

launchAuthenticationActivityFuture

abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt> launchAuthenticationActivityFuture(
    @NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest
)

Khởi chạy hoạt động minute maid để xác thực người dùng hoặc bộ chọn tài khoản nếu tài khoản đã có trên thiết bị.

Thông số
@NonNull LaunchAuthenticationActivityRequest launchAuthenticationActivityRequest

Yêu cầu khởi chạy hoạt động xác thực. Yêu cầu phải chứa một lần thiết lập tài khoản ở trạng thái AUTHENTICATION_ACTIVITY_LAUNCH_REQUIRED_INFORMATION.
Giá trị trả về
@NonNull ListenableFuture<@NonNull AccountSetupAttempt>

Một ListenableFuture bao bọc kết quả. Đây có thể là

  • Một future thành công bao bọc một lần thiết lập tài khoản ở trạng thái IN_PROGRESS, trong trường hợp thành công.

  • Một thất bại trong tương lai bao bọc một SecurityException, nếu người gọi không phải là Chủ sở hữu thiết bị hoặc Chủ sở hữu hồ sơ.

  • Một future không thành công bao bọc AccountSetupInvalidStateException, nếu nỗ lực thiết lập tài khoản không ở trạng thái AUTHENTICATION_ACTIVITY_LAUNCH_REQUIRED_INFORMATION.

listAccountSetupAttempts

abstract @NonNull List<@NonNull AccountSetupAttempt> listAccountSetupAttempts()

Liệt kê tất cả các lần thiết lập tài khoản. Hệ thống chỉ trả về 20 lần thiết lập tài khoản gần đây nhất.

Giá trị trả về
@NonNull List<@NonNull AccountSetupAttempt>

Danh sách tất cả các lần thiết lập tài khoản.

listAccountSetupAttemptsFuture

abstract @NonNull ListenableFuture<@NonNull List<@NonNull AccountSetupAttempt>> listAccountSetupAttemptsFuture()

Liệt kê tất cả các lần thiết lập tài khoản. Hệ thống chỉ trả về 20 lần thiết lập tài khoản gần đây nhất.

Giá trị trả về
@NonNull ListenableFuture<@NonNull List<@NonNull AccountSetupAttempt>>

Một ListenableFuture bao bọc kết quả.

startAccountSetup

abstract @NonNull AccountSetupAttempt startAccountSetup(
    @NonNull StartAccountSetupRequest startAccountSetupRequest
)

Bắt đầu thiết lập tài khoản.

LƯU Ý: Phương thức này uỷ quyền phạm vi android.app.admin.DevicePolicyManager.DELEGATION_APP_RESTRICTIONS cho ứng dụng Android Device Policy, cho phép ứng dụng này quản lý các hạn chế đối với ứng dụng thay cho quản trị viên gọi. Sau khi hoàn tất quá trình thiết lập tài khoản, phạm vi uỷ quyền này cho Android Device Policy sẽ bị xoá.

Thông số
@NonNull StartAccountSetupRequest startAccountSetupRequest

Yêu cầu bắt đầu thiết lập tài khoản.
Giá trị trả về
@NonNull AccountSetupAttempt

Nỗ lực thiết lập tài khoản.
Gửi
com.google.android.managementapi.environment.exception.EnvironmentNotReadyException

nếu môi trường chưa được chuẩn bị.
com.google.android.managementapi.accountsetup.AccountSetupUnknownException

nếu xảy ra lỗi không xác định trong quá trình thiết lập tài khoản.
com.google.android.managementapi.accountsetup.AccountSetupInvalidEnrollmentTokenException

nếu mã thông báo đăng ký bị trống hoặc chưa được đặt trong yêu cầu.
com.google.android.managementapi.accountsetup.AccountSetupInvalidAdminComponentException

nếu thành phần DeviceAdminReceiver của quản trị viên không phải là quản trị viên đang hoạt động trên thiết bị.
com.google.android.managementapi.accountsetup.AccountSetupInvalidNotificationReceiverComponentException

nếu thành phần của trình nhận thông báo không có trên thiết bị.

startAccountSetupFuture

abstract @NonNull ListenableFuture<@NonNull AccountSetupAttempt> startAccountSetupFuture(
    @NonNull StartAccountSetupRequest startAccountSetupRequest
)

Bắt đầu thiết lập tài khoản.

LƯU Ý: Phương thức này uỷ quyền phạm vi android.app.admin.DevicePolicyManager.DELEGATION_APP_RESTRICTIONS cho ứng dụng Android Device Policy, cho phép ứng dụng này quản lý các hạn chế đối với ứng dụng thay cho quản trị viên gọi. Sau khi hoàn tất quá trình thiết lập tài khoản, phạm vi uỷ quyền này cho Android Device Policy sẽ bị xoá.

Thông số
@NonNull StartAccountSetupRequest startAccountSetupRequest

Yêu cầu bắt đầu thiết lập tài khoản.
Giá trị trả về
@NonNull ListenableFuture<@NonNull AccountSetupAttempt>

Một ListenableFuture bao bọc kết quả. Đây có thể là