Customize settings view

The super app can customize the appearance of the settings view of mini programs to ensure a consistent user experience. The settings view appears when a mini program invokes the my.openSetting JSAPI, allowing users to view and manage permissions that have been granted to the mini program, even if those permissions have been revoked later.

Default user interface

By default, the settings view is full-screen and displays permissions along with toggle switches for managing them. The following figure shows an example of the default UI:

Before you begin

To customize the user interface for the settings view, ensure that the integrated Android IAPMiniProgram SDK is version 2.67.0 or later. For more information, see SDK release notes.

Procedure

To customize the settings view, take the following two steps:

Step 1: Implement GriverOpenSettingViewExtension

Create a class that implements the GriverOpenSettingViewExtension interface. Within the class, override the getView method to customize the settings view. Refer to the following code for a sample implementation. For more information about the interface and its method, refer to GriverOpenSettingViewExtension.

class CustomOpenSettingImpl : GriverOpenSettingViewExtension {

    override fun getView(
        param: GriverOpenSettingViewParam,
        callback: GriverOpenSettingViewCallback
    ): View {
        // Implement the logic to build a custom settings view
         val rootView = ...
        return rootView
    }
}

Step 2: Register the implementation class

After initializing the SDK, call the registerExtension API to register the implementation class (for example, CustomOpenSettingImpl in the sample) with the SDK. Refer to the following sample registration code:

Griver.registerExtension(GriverExtensionManifest(
    GriverOpenSettingViewExtension::class.java,
    CustomOpenSettingImpl()
)

Interface

GriverOpenSettingViewExtension

The GriverOpenSettingViewExtension interface defines a method for the super app to customize the settings view, which the SDK then calls to render the custom view. Refer to the following code for the interface definition:

interface GriverOpenSettingViewExtension : GriverExtension {

    fun getView(
        param: GriverOpenSettingViewParam,
        callback: GriverOpenSettingViewCallback
    ): View
}

The following table lists the details of the defined method:

getView

The getView method has the following input parameters whose values are passed by the SDK:

GriverOpenSettingViewParam

The GriverOpenSettingViewParam class is defined as follows:

data class GriverOpenSettingViewParam(
    val activityWeakReference: WeakReference<Activity>,
    val appId: String,
    val appName: String,
    val items: List<GriverOpenSettingViewItem>
) : Serializable

The following table lists the parameter details of this class:

GriverOpenSettingViewItem

The GriverOpenSettingViewItem class is defined as follows:

data class GriverOpenSettingViewItem(
    val permissionName: String,
    val scope: String,
    val enabled: Boolean
) : Serializable

The following table lists the parameter details of this class:

GriverOpenSettingViewCallback

onChange