Permissions API trên Android

Trước khi sử dụng bất kỳ API Home nào cho Android, ứng dụng phải có quyền truy cập vào các thiết bị trong nhà của người dùng, được gọi là cấu trúc trong API. Với API Quyền, người dùng có thể dùng Tài khoản Google của mình để cấp cho các ứng dụng API Home quyền truy cập vào các thiết bị trong nhà của họ.

Quy trình cấp quyền cho phép người dùng tạo cấu trúc nếu chưa thiết lập cấu trúc, mà không cần dùng Google Home app (GHA).

Tích hợp API Quyền

Trước khi tiếp tục, hãy đảm bảo bạn đã làm theo hướng dẫn trong bài viết Khởi chạy Home trên Android. Phiên bản homeManager từ bước đó được dùng trong tất cả các ví dụ về Quyền ở đây.

Trước tiên, hãy đăng ký một ActivityResultCaller bằng SDK. Ví dụ: đây là cách Ứng dụng mẫu xử lý vấn đề này:

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    homeManager.registerActivityResultCallerForPermissions(this)
  }

Kiểm tra quyền

Trước khi yêu cầu cấp quyền, bạn nên kiểm tra để xem người dùng ứng dụng đã đồng ý cấp quyền truy cập vào cấu trúc hay chưa. Để thực hiện việc này, hãy gọi phương thức hasPermissions() của thực thể Home để lấy Flow của PermissionsState các giá trị:

val permissionsReadyState =
homeManager.hasPermissions().collect { state ->
    when (state) {
      PermissionsState.GRANTED -> println("Permissions granted, no need to request permissions")
      PermissionsState.PERMISSIONS_STATE_UNAVAILABLE ->
          println("Permissions state unavailable, request permissions")

      PermissionsState.NOT_GRANTED ->
          println("OAuth permission is enabled but not granted yet, request permissions")

      PermissionsState.PERMISSIONS_STATE_UNINITIALIZED -> println(
          "Permissions state is not initialized yet. Clients should wait for another status update"
      )
      else ->
          throw IllegalStateException("""
            HomeClient.hasPermissions state should be PermissionsState.GRANTED,
            PermissionState.PERMISSIONS_STATE_UNINITIALIZED, or
            PermissionsState.PERMISSIONS_STATE_UNAVAILABLE. Actual state: $state
          """.trimIndent())
    }
}

Nếu quy trình kiểm tra trả về PermissionsState là NOT_GRANTED hoặc PERMISSIONS_STATE_UNAVAILABLE, thì có nghĩa là người dùng hoặc ứng dụng không có quyền truy cập vào cấu trúc. Nếu quy trình kiểm tra trả về PermissionsState là GRANTED nhưng lệnh gọi tiếp theo đến structures() không trả về cấu trúc nào, thì có nghĩa là người dùng đã thu hồi quyền truy cập vào ứng dụng thông qua trang cài đặt GHA hoặc người dùng không có quyền truy cập cần thiết.

Yêu cầu cấp quyền

Bạn phải cấp quyền cho ứng dụng để truy cập vào các cấu trúc và thiết bị trong một cấu trúc nhất định.

Nếu người dùng chưa cấp quyền, hãy sử dụng phương thức requestPermissions() của thực thể Home để khởi chạy Giao diện người dùng cấp quyền và xử lý kết quả:

fun requestPermissions(scope: CoroutineScope, onShowSnackbar: (String) -> Unit) {
  scope.launch {
    val result =
      try {
        homeManager.requestPermissions()
      } catch (e: HomeException) {
        PermissionsResult(
          PermissionsResultStatus.ERROR,
          "Got HomeException with error: ${e.message}",
        )
      }
    when (result.status) {
      PermissionsResultStatus.SUCCESS -> {
        Log.i(TAG, "Permissions successfully granted.")
      }
      PermissionsResultStatus.CANCELLED -> {
        Log.i(TAG, "User cancelled Permissions flow.")
        onShowSnackbar("User cancelled Permissions flow")
      }
      else -> {
        Log.e(
          TAG,
          "Failed to grant permissions with error: ${result.status}, ${result.errorMessage}",
        )
        onShowSnackbar("Failed to grant permissions with error: ${result.errorMessage}")
      }
    }
  }
}

Để Giao diện người dùng cấp quyền khởi chạy đúng cách, bạn phải thiết lập OAuth cho ứng dụng.

• Chỉ những người dùng đã đăng ký làm người dùng thử nghiệm trong bảng điều khiển OAuth mới có thể cấp quyền cho ứng dụng. Có giới hạn 100 người dùng thử nghiệm cho một ứng dụng chưa xác minh.

• Ứng dụng chưa xác minh sẽ có quyền truy cập vào các thiết bị thuộc mọi loại thiết bị được OAuth hỗ trợ cho API Home (danh sách các loại thiết bị trong Developer Console). Tất cả các thiết bị trong một cấu trúc sẽ được cấp quyền.

Nếu ứng dụng được đăng ký trong Developer Console và đã được phê duyệt để truy cập vào một hoặc nhiều loại thiết bị, đồng thời quá trình xác minh thương hiệu đã hoàn tất cho OAuth, thì ứng dụng sẽ ở trạng thái đã xác minh. Bạn phải ở trạng thái này để chạy ứng dụng trong môi trường thực tế:

• Không còn áp dụng giới hạn người dùng thử nghiệm. Bất kỳ người dùng nào cũng có thể cấp quyền cho ứng dụng.
• Người dùng chỉ có thể cấp quyền cho các loại thiết bị đã được phê duyệt trong Developer Console.

Sau khi thiết lập OAuth, lệnh gọi của ứng dụng đến requestPermissions() sẽ kích hoạt các hộp thoại sau:

1. Người dùng sẽ được nhắc chọn Tài khoản Google mà họ muốn sử dụng.
2. Người dùng sẽ được nhắc chọn cấu trúc mà họ muốn cấp quyền truy cập cho ứng dụng.
   1. Đối với ứng dụng chưa xác minh, tất cả các loại thiết bị được API Home hỗ trợ đều có sẵn cho ứng dụng.
   2. Đối với ứng dụng đã xác minh, người dùng chỉ có thể cấp quyền cho các loại thiết bị đã được phê duyệt trong Developer Console.
   3. Đối với các loại thiết bị nhạy cảm mà ứng dụng có quyền quản lý, người dùng có thể hạn chế quyền truy cập theo từng thiết bị. Ví dụ: nếu có 3 ổ khoá, người dùng chỉ có thể cấp quyền truy cập vào một trong số đó.

Sau khi được cấp quyền, ứng dụng có thể sử dụng API Home để đọc trạng thái và điều khiển các thiết bị trong cấu trúc. Nếu người dùng không cấp quyền cho ứng dụng đối với một loại thiết bị cụ thể hoặc thiết bị nhạy cảm, thì ứng dụng sẽ không thể sử dụng API Home để truy cập, điều khiển hoặc tự động hoá thiết bị đó.

Thay đổi quyền

Để cấp quyền truy cập vào các thiết bị trong một cấu trúc khác, bạn có thể khởi chạy trình chọn tài khoản để cho phép người dùng chọn Tài khoản Google và cấu trúc để chuyển sang. Trong quá trình này, người dùng sẽ thấy lại màn hình xin phép, ngay cả khi trước đó họ đã đồng ý.

Bạn có thể thực hiện việc này bằng cách gọi lại requestPermissions() với cờ forceLaunch được đặt thành true:

homeManager.requestPermissions(forceLaunch=true)

Thu hồi quyền

Người dùng có thể thu hồi quyền truy cập đã cấp trước đó:

1. Thông qua trang Google MyAccounts > Dữ liệu và quyền riêng tư > Ứng dụng và dịch vụ của bên thứ ba. Thao tác này sẽ thu hồi mã thông báo OAuth được cấp khi người dùng đồng ý lần đầu và thu hồi quyền truy cập vào mọi thực thể của ứng dụng mà người dùng đang sử dụng trên tất cả các nền tảng (điện thoại) và cấu trúc.

   Người dùng có thể được chuyển hướng bằng một đường liên kết sâu đến trang con Ứng dụng và dịch vụ của bên thứ ba bằng cách sử dụng lược đồ URL sau:

   https://myaccount.google.com/connections/link?project_number=Cloud project_number
   

2. Thông qua trang GHA > Cài đặt > Ứng dụng được liên kết. Khi nhấp vào settings trong GHA, bạn sẽ được chuyển đến trang Cài đặt. Từ đó, hãy nhấp vào ô Ứng dụng được liên kết để chuyển đến một trang có giao diện tương tự như màn hình xin phép. Trên trang này, người dùng có thể xoá quyền truy cập vào ứng dụng. Người dùng có thể sử dụng cùng một trang này để thay đổi loại thiết bị hoặc thiết bị nhạy cảm cụ thể mà ứng dụng có thể truy cập.

Xem các loại thiết bị mà người dùng đã cấp quyền

Trong hệ sinh thái Google Home, đối với hầu hết các loại thiết bị, người dùng có thể cấp quyền cho tất cả các thiết bị thuộc loại đó cùng một lúc. Đối với các loại thiết bị nhạy cảm hoặc bị hạn chế, chẳng hạn như ổ khoá, camera hoặc chuông cửa, người dùng phải cấp quyền cho từng thiết bị.

Để xác định xem người dùng đã cấp quyền truy cập vào một loại thiết bị nhạy cảm hoặc bị hạn chế hay chưa, hãy sử dụng hàm consentedDeviceTypes() ở cấp Cấu trúc:

import com.google.home.Structure
import com.google.home.DeviceType
import com.google.home.DeviceTypeFactory
import com.google.home.consentedDeviceTypes // Extension function from the SDK
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.collect
import kotlinx.coroutines.launch

/**
 * Example of how an app may monitor which device types have been granted access by a user.
 */
fun monitorDeviceConsent(structure: Structure, myScope: CoroutineScope) {
    // Obtain the flow of consented device type factories
    val consentedTypesFlow: Flow<Set<DeviceTypeFactory<out DeviceType>>> =
        structure.consentedDeviceTypes()

    myScope.launch {
        consentedTypesFlow.collect { consentedSet ->
            // Check if the user has consented to share a specific restricted
            // type, such as a Doorbell or Camera.
            val hasCameraAccess = consentedSet.any {
                it.toString() == "matter.google.type.GoogleDoorbellDevice"
            }

            if (hasCameraAccess) {
                // Enable features that require camera access
            } else {
                // Inform the user or disable camera-specific features
            }
        }
    }
}

Quyền OkGoogle

Lệnh okGoogle là một lệnh ở cấp thiết bị và có thể dùng để tự động hoá mọi thiết bị trong cấu trúc. Tuy nhiên, ứng dụng API Home có thể không có quyền truy cập vào mọi thiết bị. Bảng sau đây mô tả cách thực thi quyền trong những trường hợp như vậy.

Hướng dẫn nếu người dùng thu hồi toàn bộ quyền

Nếu người dùng thu hồi toàn bộ quyền, tất cả các quy trình tự động hoá hiện có sẽ ngừng hoạt động. Ngoài ra, nếu người dùng thu hồi quyền truy cập vào các thiết bị cụ thể, thì các trình kích hoạt, điều kiện và hành động được liên kết với các thiết bị đó sẽ ngừng hoạt động.

Mỗi khi ứng dụng bắt đầu, hãy nhớ kiểm tra để đảm bảo rằng các quyền vẫn còn hiệu lực. Nếu các quyền đó đã bị thu hồi, hãy đảm bảo rằng tất cả dữ liệu trước đó đều bị xoá, bao gồm cả mọi dữ liệu được lưu vào bộ nhớ đệm trong ứng dụng.