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 iOS 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 GRVAppSettingsDelegate

Define a class that implements the GRVAppSettingsDelegate protocol. Within the class, implement the openAppSettings method to customize a settings view. Refer to the following code for a sample implementation. For more information about the protocol and its defined method, refer to GRVAppSettingsDelegate.

class DemoAppSettingsImpl: NSObject, GRVAppSettingsDelegate {

    func openAppSettings(with param: GRVAppSettingsParam, proxy: any GRVAppSettingsProxy) {
        // Implement the logic to build a custom settings view
    }
}

Step 2: Configure appSettingsDelegate

After initializing the SDK, create an instance of GRVExtensionDelegate and assign the implementation (for example, DemoAppSettingsImpl in the sample) to the appSettingsDelegate property of the delegate's uiProvider. Refer to the following sample configuration code:

let extensionDelegate = GRVExtensionDelegate()
extensionDelegate.uiProvider.appSettingsDelegate = DemoAppSettingsImpl()

Protocol

GRVAppSettingsDelegate

The GRVAppSettingsDelegate protocol 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 protocol definition:

@protocol GRVAppSettingsDelegate <NSObject>

- (void)openAppSettingsWithParam:(GRVAppSettingsParam *)param
                           proxy:(id<GRVAppSettingsProxy>)proxy;

@end

The following table lists the details of the defined method:

openAppSettingsWithParam:proxy:

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

GRVAppSettingsParam

The GRVAppSettingsParam object is defined as follows:

@class GRVAppSettingsItem;
@interface GRVAppSettingsParam : NSObject

@property (nonatomic, weak) UIViewController *currentViewController;
@property (nonatomic, copy) NSString *appId;
@property (nonatomic, copy) NSString *appName;
@property (nonatomic, copy) NSArray<GRVAppSettingsItem *> *items;

@end

#pragma mark - GRVAppSettingsItem

@interface GRVAppSettingsItem : NSObject
@property (nonatomic, assign) GRVAuthItemType authType;
@property (nonatomic, copy) NSString *permissionName;
@property (nonatomic, assign, getter=isEnabled) BOOL enabled;

@end

The following table lists the parameter details of this object:

GRVAppSettingsItem

GRVAppSettingsProxy

The GRVAppSettingsProxy protocol is defined as follows:

@protocol GRVAppSettingsProxy <NSObject>

- (void)updateAuthItemForType:(GRVAuthItemType)authType
                    isEnabled:(BOOL)isEnabled
                        appId:(NSString *)appId;

@end

The following table lists the parameter details of this protocol: