Cho phép người dùng định cấu hình tiện ích ứng dụng

Bạn có thể định cấu hình tiện ích ứng dụng. Ví dụ: tiện ích đồng hồ có thể cho phép người dùng định cấu hình múi giờ để hiển thị.

Nếu bạn muốn cho phép người dùng định cấu hình chế độ cài đặt tiện ích, hãy tạo một cấu hình tiện ích Activity. Hoạt động này được máy chủ tiện ích ứng dụng tự động khởi chạy khi tiện ích được tạo hoặc sau đó, tuỳ thuộc vào các tuỳ chọn cấu hình mà bạn chỉ định.

Khai báo hoạt động định cấu hình

Khai báo hoạt động định cấu hình dưới dạng một hoạt động thông thường trong tệp kê khai Android. Máy chủ tiện ích ứng dụng khởi chạy ứng dụng bằng ACTION_APPWIDGET_CONFIGURE nên hoạt động cần chấp nhận ý định này. Ví dụ:

<activity android:name=".ExampleAppWidgetConfigurationActivity">
    <intent-filter>
        <action android:name="android.appwidget.action.APPWIDGET_CONFIGURE"/>
    </intent-filter>
</activity>

Khai báo hoạt động trong tệp AppWidgetProviderInfo.xml bằng thuộc tính android:configure. Xem thêm thông tin về cách khai báo tệp này. Sau đây là ví dụ về cách khai báo hoạt động cấu hình:

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    ...
    android:configure="com.example.android.ExampleAppWidgetConfigurationActivity"
    ... >
</appwidget-provider>

Hoạt động được khai báo bằng một không gian tên đủ điều kiện, vì trình chạy tham chiếu hoạt động đó từ bên ngoài phạm vi gói của bạn.

Đó là tất cả những gì bạn cần để bắt đầu một hoạt động định cấu hình. Tiếp theo, bạn cần triển khai hoạt động thực tế.

Triển khai hoạt động cấu hình

Có 2 điểm quan trọng cần nhớ khi bạn triển khai hoạt động:

• Máy chủ tiện ích ứng dụng gọi hoạt động định cấu hình và cấu hình phải luôn trả về một kết quả. Kết quả phải bao gồm Tiện ích ứng dụng Mã nhận dạng được truyền bởi ý định chạy hoạt động (được lưu trong ý định) phần bổ sung dưới dạng EXTRA_APPWIDGET_ID.
• Hệ thống sẽ không gửi ACTION_APPWIDGET_UPDATE truyền tin khi một hoạt động cấu hình được chạy, nghĩa là hoạt động này sẽ không gọi phương thức onUpdate() khi tạo tiện ích. Hoạt động định cấu hình có trách nhiệm yêu cầu cập nhật từ AppWidgetManager khi tạo tiện ích lần đầu tiên. Tuy nhiên, onUpdate() được gọi cho các bản cập nhật tiếp theo – chỉ bị bỏ qua lần đầu tiên.

Hãy xem các đoạn mã trong phần sau để biết ví dụ về cách trả về một kết quả từ cấu hình và cập nhật tiện ích.

Cập nhật tiện ích trong hoạt động định cấu hình

Khi một tiện ích sử dụng hoạt động cấu hình, hoạt động đó có trách nhiệm cập nhật tiện ích khi cấu hình hoàn tất. Bạn có thể làm như vậy bằng cách yêu cầu cập nhật trực tiếp từ AppWidgetManager.

Sau đây là phần tóm tắt về quy trình để cập nhật tiện ích đúng cách và đóng hoạt động định cấu hình:

1. Lấy mã tiện ích ứng dụng từ ý định đã khởi chạy hoạt động:

   Kotlin

   val appWidgetId = intent?.extras?.getInt(
           AppWidgetManager.EXTRA_APPWIDGET_ID,
           AppWidgetManager.INVALID_APPWIDGET_ID
   ) ?: AppWidgetManager.INVALID_APPWIDGET_ID
   

   Java

   Intent intent = getIntent();
   Bundle extras = intent.getExtras();
   int appWidgetId = AppWidgetManager.INVALID_APPWIDGET_ID;
   if (extras != null) {
       appWidgetId = extras.getInt(
               AppWidgetManager.EXTRA_APPWIDGET_ID,
               AppWidgetManager.INVALID_APPWIDGET_ID);
   }
   

2. Đặt kết quả hoạt động thành RESULT_CANCELED.

   Bằng cách này, nếu người dùng thoát khỏi hoạt động trước khi kết thúc, hệ thống sẽ thông báo cho máy chủ tiện ích ứng dụng rằng cấu hình đã bị huỷ và máy chủ sẽ không thêm tiện ích:

   Kotlin

   val resultValue = Intent().putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
   setResult(Activity.RESULT_CANCELED, resultValue)
   

   Java

   int resultValue = new Intent().putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId);
   setResult(Activity.RESULT_CANCELED, resultValue);
   

3. Định cấu hình tiện ích theo các lựa chọn ưu tiên của người dùng.

4. Khi quá trình định cấu hình hoàn tất, hãy lấy một phiên bản của AppWidgetManager bằng cách gọi getInstance(Context):

   Kotlin

   val appWidgetManager = AppWidgetManager.getInstance(context)
   

   Java

   AppWidgetManager appWidgetManager = AppWidgetManager.getInstance(context);
   

5. Cập nhật tiện ích bằng một Bố cục RemoteViews bằng cách gọi updateAppWidget(int,RemoteViews):

   Kotlin

   val views = RemoteViews(context.packageName, R.layout.example_appwidget)
   appWidgetManager.updateAppWidget(appWidgetId, views)
   

   Java

   RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.example_appwidget);
   appWidgetManager.updateAppWidget(appWidgetId, views);
   

6. Tạo ý định trả về, đặt ý định này cùng với kết quả hoạt động và hoàn tất hoạt động này:

   Kotlin

   val resultValue = Intent().putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
   setResult(Activity.RESULT_OK, resultValue)
   finish()
   

   Java

   Intent resultValue = new Intent().putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId);
   setResult(RESULT_OK, resultValue);
   finish();
   

Xem ListWidgetConfigureActivity.kt lớp mẫu trên GitHub để làm ví dụ.

Các tuỳ chọn cấu hình tiện ích

Theo mặc định, máy chủ tiện ích ứng dụng chỉ chạy hoạt động cấu hình một lần, ngay sau khi người dùng thêm tiện ích vào màn hình chính. Tuy nhiên, bạn có thể chỉ định các tuỳ chọn cho phép người dùng định cấu hình lại các tiện ích hiện có hoặc bỏ qua cấu hình tiện ích ban đầu bằng cách cung cấp một cấu hình tiện ích mặc định.

Lưu ý: Các tuỳ chọn này chỉ có trên Android 12 (API cấp 31). Bạn có thể chỉ định các giá trị này cho các phiên bản Android trước, nhưng hệ thống sẽ bỏ qua các giá trị này và tuân theo hành vi mặc định.

Cho phép người dùng định cấu hình lại các tiện ích đã đặt

Để cho phép người dùng định cấu hình lại các tiện ích hiện có, hãy chỉ định reconfigurable gắn cờ trong widgetFeatures của appwidget-provider. Hãy xem hướng dẫn khai báo tệp AppWidgetProviderInfo.xml để biết thêm thông tin. Ví dụ:

<appwidget-provider
    android:configure="com.myapp.ExampleAppWidgetConfigurationActivity"
    android:widgetFeatures="reconfigurable">
</appwidget-provider>

Người dùng có thể định cấu hình lại tiện ích bằng cách nhấn và giữ tiện ích rồi nhấn vào nút Reconfigure (Định cấu hình lại) có nhãn 1 trong hình 1.

Hình 1. Nút Định cấu hình lại tiện ích.

Lưu ý: Cờ reconfigurable đã được ra mắt trong Android 9 (API cấp 28), nhưng nó chỉ được hỗ trợ rộng rãi cho đến Android 12.

Sử dụng cấu hình mặc định của tiện ích

Bạn có thể mang đến trải nghiệm tiện ích liền mạch hơn bằng cách cho phép người dùng bỏ qua bước định cấu hình ban đầu. Để thực hiện việc này, hãy chỉ định cả cờ configuration_optional và reconfigurable trong trường widgetFeatures. Thao tác này sẽ bỏ qua việc chạy hoạt động định cấu hình sau khi người dùng thêm tiện ích. Như đã đề cập trước đó, người dùng vẫn có thể định cấu hình lại tiện ích sau đó. Ví dụ: tiện ích đồng hồ có thể bỏ qua cấu hình ban đầu và hiển thị múi giờ của thiết bị theo mặc định.

Dưới đây là ví dụ về cách đánh dấu hoạt động cấu hình của bạn là có thể định cấu hình lại và không bắt buộc:

<appwidget-provider
    android:configure="com.myapp.ExampleAppWidgetConfigurationActivity"
    android:widgetFeatures="reconfigurable|configuration_optional">
</appwidget-provider>