uni Mini-Program SDK

https://nativesupport.dcloud.net.cn/
Admin
uni Mini-Program SDK is a framework designed for native apps to run mini-program frontend projects...
Tokens:257,244
Snippets:2,665
Trust Score:7.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install UniMP Mini-Program

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/UniappHost/unimpapi.html

Use the `mp.installUniMP` method to install a Uni-App mini-program into the host App using its WGT file. A callback function is provided to log the installation result.

```javascript
mp.installUniMP({
  appid: 'uni小程序的appid',
  wgtFile: 'uni小程序的wgt文件路径'
}, (ret) =>{
  console.log('installUniMP: '+JSON.stringify(ret));
});

```

--------------------------------

### Start Mini Program with Parameters (v3.3.7+)

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/android-v2.html

Starts a mini-program and passes parameters to it using the `extraData` field in `UniMPOpenConfiguration`. Mini-programs can access these parameters via the `onLaunch` method.

```APIDOC
## Start Mini Program with Parameters (v3.3.7+)

### Description
Launches a mini-program and passes custom data to it. The mini-program can access this data when it launches.

### Method Signature
`IUniMP openUniMP(Context context, String appid, UniMPOpenConfiguration uniMPOpenConfiguration)`

### Parameters
- **context** (Context) - Required - The application context.
- **appid** (String) - Required - The mini-program's app ID.
- **uniMPOpenConfiguration** (UniMPOpenConfiguration) - Required - Configuration object. Use `extraData` to pass key-value pairs.
  - `extraData` (Map<String, String>) - Custom data to pass to the mini-program. Example: `put("MSG", "Hello DCUniMPConfiguration")`, `put("darkmode", "auto")`.

### Response
#### Success Response
- **IUniMP** (IUniMP) - An interface object for the mini-program instance.

### Example Usage (Host App)
```java
UniMPOpenConfiguration uniMPOpenConfiguration = new UniMPOpenConfiguration();
uniMPOpenConfiguration.extraData.put("MSG", "Hello DCUniMPConfiguration");
uniMPOpenConfiguration.extraData.put("darkmode", "auto"); // Optional: "dark", "light", "auto"
IUniMP mallMP = DCUniMPSDK.getInstance().openUniMP(MainActivity.this, "__UNI__A922B72_minimall", uniMPOpenConfiguration);
```

### Example Usage (Mini Program - `onLaunch`)
```javascript
onLaunch: function(options) {
    console.log('MiniMall App Launch --- ' + JSON.stringify(options));
}
```
```

--------------------------------

### SDK Directory Structure Example

Source: https://nativesupport.dcloud.net.cn/AppDocs/usesdk/ios

An example illustrating the directory structure of the App offline SDK.

```plaintext
|-- HBuilder-Hello       给用户打uni-app项目的离线打包工程
    |-- Feature-iOS.xls      配置表（依赖的库、资源文件、参数配置等）
    |-- SDK                 工程需要的库文件，.h头文件，配置文件，资源文件

```

--------------------------------

### Configure Plugin Parameters with Key

Source: https://nativesupport.dcloud.net.cn/NativePlugin/course/package

Define plugin parameters like `appid_android` and `appkey_android` with descriptions and keys for `meta-data` in `AndroidManifest.xml`. This example shows a common setup for Android platform keys.

```json
"parameters": {
  "appid_android": {
    "des": "Android平台的appid",
    "key": "HelloPlugin_appid"
  },
  "appkey_android": {
    "des": "Android平台的appkey",
    "key": "HelloPlugin_appkey"
  }
}

```

--------------------------------

### Start Mini Program

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/android-v2.html

Starts a mini-program from the host application. This is the primary method for launching a mini-program and requires context, the mini-program's app ID, and optional configuration.

```APIDOC
## Start Mini Program

### Description
Starts a mini-program from the host application.

### Method Signature
`IUniMP openUniMP(Context context, String appid, UniMPOpenConfiguration uniMPOpenConfiguration)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **context** (Context) - Required - The application context.
- **appid** (String) - Required - The mini-program's app ID.
- **uniMPOpenConfiguration** (UniMPOpenConfiguration) - Optional - Configuration object for opening the mini-program, including `redirectPath`, `extraData`, and `splashClass`.

### Response
#### Success Response
- **IUniMP** (IUniMP) - An interface object for the mini-program instance, allowing control over closing and event handling.

### Example Usage
```java
IUniMP unimp = DCUniMPSDK.getInstance().openUniMP(context, appid, uniMPOpenConfiguration);
```
```

--------------------------------

### Start Mini Program with Parameters (Pre-v3.3.7)

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/android-v2.html

Starts a mini-program and passes parameters using a `JSONObject`. Mini-programs can retrieve these arguments via `plus.runtime.arguments`.

```APIDOC
## Start Mini Program with Parameters (Pre-v3.3.7)

### Description
Launches a mini-program and passes parameters as a `JSONObject`. The mini-program can access these arguments using `plus.runtime.arguments`.

### Method Signature
`IUniMP openUniMP(Context context, String appid, JSONObject arguments)`

### Parameters
- **context** (Context) - Required - The application context.
- **appid** (String) - Required - The mini-program's app ID.
- **arguments** (JSONObject) - Required - A JSON object containing parameters to pass to the mini-program. Example: `arguments.put("MSG", "Hello uni microprogram")`.

### Response
#### Success Response
- **IUniMP** (IUniMP) - An interface object for the mini-program instance.

### Example Usage (Host App)
```java
JSONObject arguments = new JSONObject();
arguments.put("MSG", "Hello uni microprogram");
IUniMP unimp = DCUniMPSDK.getInstance().openUniMP(context, "__UNI__04E3A11", arguments);
```

### Example Usage (Mini Program)
```javascript
var arguments = plus.runtime.arguments;
// arguments is a string
```
```

--------------------------------

### Install Uni-mini Program in Host App

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/UniappHost/tutorial.html

Install a uni-mini program by checking its version and then calling the installUniMP API. The wgt file can be located in the static directory or downloaded from a server.

```javascript
installMP(){
  //通过获取小程序版本API来判断是否已经安装
  mp.getUniMPVersion('小程序的appid', (ret) => {
    if(0!=ret.code){//获取失败可以认为没有安装此小程序
      //安装小程序
      mp.installUniMP({
        appid:'小程序的appid',
        wgtFile:'小程序wgt文件路径'  //放在static目录路径为'/static/{$appid}.wgt'，如果小程序wgt在服务器，需要先下载到本地再安装
      }, (r)=>{
        if(0==r.code){
          console.log('安装成功');
        }else{
          console.log('安装失败: '+JSON.stringify(r));
        }
      });
    }
  });
}
```

--------------------------------

### DCUniMPSDK.getInstance().startApp

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/android.html

Starts a Mini Program application.

```APIDOC
## DCUniMPSDK.getInstance().startApp(context, appid, splashClass, redirectPath, arguments)

### Description
Launches a specified Mini Program application.

### Parameters
#### Path Parameters
- **context** (Context) - Required - The application context.
- **appid** (String) - Required - The AppID of the Mini Program to start.
- **splashClass** (String) - Optional - The name of the splash screen class to use.
- **redirectPath** (String) - Optional - The path to redirect to within the Mini Program.
- **arguments** (String) - Optional - Arguments to pass to the Mini Program.
```

--------------------------------

### Install UniMP Resource Package

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/ios?id=%E5%90%91%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%8F%91%E9%80%81%E4%BA%8B%E4%BB%B6

Installs a wgt resource package to the running path. Supports versions 3.3.7+. Requires appid, wgt path, and optionally a password. Error information is returned.

```objectivec
/// 将wgt资源部署到运行路径中 (3.3.7+ 支持)
/// @param appid appid
/// @param wgtPath wgt资源路径
/// @param password wgt资源解压密码（没有密码传 nil）
/// @param error 解压报错对应的 Error
+ (BOOL)installUniMPResourceWithAppid:(NSString *)appid
                     resourceFilePath:(NSString *)wgtPath
                             password:(nullable NSString *)password
                                error:(NSError * *)error;
```

--------------------------------

### Full Uni App Example with Native Module and Component Interaction

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Extension/ios.html

A comprehensive uni-app example demonstrating the integration of native modules and components. It includes calling asynchronous and synchronous methods from a native module and interacting with a native component.

```vue
<template>
	<div>
		<button type="primary" @click="testAsyncFunc">testAsyncFunc</button>
		<button type="primary" @click="testSyncFunc">testSyncFunc</button>
		<testmap ref='mycomponent' style="width:200px;height:200px" showTraffic="true" @mapLoaded="onMapLoaded"></testmap>
	</div>
</template>

<script>
	// 获取 module
	var testModule = uni.requireNativePlugin("TestModule")
	export default {
		onLoad() {
			// 调用组件方法
			this.$nextTick(()=>{
				this.$refs.mycomponent.focus("Hello")
			})
		},
		methods: {
			testAsyncFunc() {
				// 调用异步方法
				testModule.testAsyncFunc({
						'name': 'unimp',
						'age': 1
					},
					(ret) => {
						console.log(ret)
					})
			},
			testSyncFunc() {
				// 调用同步方法
				var ret = testModule.testSyncFunc({
					'name': 'unimp',
					'age': 1
				})
			},
			onMapLoaded(e) {
				console.log("map loaded" + JSON.stringify(e))
			}
		}
	}
</script>

```

--------------------------------

### 删除并重新加载 CocoaPods 索引

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/FAQ/cocoapods.html

删除本地缓存的索引文件并重新加载，用于解决 'pod install' 找不到项目的问题。

```shell
rm ~/Library/Caches/CocoaPods/search_index.json

```

--------------------------------

### Check and Install UniMP Resource

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/UseSdk/ios

Implement logic to check if mini-program resources exist and install them if necessary. This method ensures that the application resources are deployed to the correct runtime directory.

```Objective-C
/// 检查运行目录是否存在应用资源，不存在将应用资源部署到运行目录
- (void)checkUniMPResource:(NSString *)appid {
#warning 注意：isExistsUniMP: 方法判断的仅是运行路径中是否有对应的应用资源，宿主还需要做好内置wgt版本的管理，如果更新了内置的wgt也应该执行 installUniMPResourceWithAppid 方法应用最新的资源
    if (![DCUniMPSDKEngine isExistsUniMP:appid]) {
        // 读取导入到工程中的wgt应用资源
        NSString *appResourcePath = [[NSBundle mainBundle] pathForResource:appid ofType:@"wgt"];
        if (!appResourcePath) {
            NSLog(@"资源路径不正确，请检查");
            return;
        }
        // 将应用资源部署到运行路径中
        NSError *error;

```

--------------------------------

### Install UniMP Resource

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/ios.html

Installs a UniMP resource package (wgt) to the running path. This method is available from version 3.3.7 onwards.

```APIDOC
## Install UniMP Resource

### Description
Installs a UniMP resource package (wgt) to the running path. This method is available from version 3.3.7 onwards.

### Method
`+ (BOOL)installUniMPResourceWithAppid:(NSString *)appid resourceFilePath:(NSString *)wgtPath password:(nullable NSString *)password error:(NSError * *)error;`

### Parameters
#### Path Parameters
- **appid** (NSString) - Description: appid
- **wgtPath** (NSString) - Description: wgt resource path
- **password** (nullable NSString) - Description: wgt resource decompression password (pass nil if no password)
- **error** (NSError * *) - Description: Error corresponding to decompression failure
```

--------------------------------

### Example: Sending Message from UniMP to Host

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/harmony.html

This example shows how a UniMP mini-program sends a message 'unimp message!!!' with event 'unimp-event' to the host app and includes a callback to display the host's response.

```typescript
// 向宿主App发送事件
uni.sendNativeEvent('unimp-event', {
	msg: 'unimp message!!!'
}, ret => {
	this.nativeMsg = '宿主App回传的数据：' + ret;
})
```

--------------------------------

### 更新 CocoaPods 索引

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/FAQ/cocoapods.html

更新本地 CocoaPods 仓库索引，以解决 'pod install' 找不到项目的问题。

```shell
pod repo update --verbose

```

--------------------------------

### Start UniMP Application

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/android.html

Launches a UniMP application. Ensure the SDK is initialized before calling this method. Supports starting with a default splash screen or a custom one, and can navigate to a specific page with query parameters.

```java
pages/component/scroll-view/scroll-view?a=1&b=2&c=3
```

```java
// 启动小程序
try {
	DCUniMPSDK.getInstance().startApp(context,"__UNI__04E3A11")
} catch (Exception e) {
	e.printStackTrace();
}
```

```java
// 启动小程序打开指定页面
try {
	DCUniMPSDK.getInstance().startApp(context,"__UNI__04E3A11",  MySplashView.class, "pages/component/scroll-view/scroll-view?a=1&b=2&c=3");
} catch (Exception e) {
	e.printStackTrace();
}
```

```java
// 启动小程序并传入参数 "Hello uni microprogram"
try {
	JSONObject arguments = new JSONObject();
	arguments.put("MSG","Hello uni microprogram");
	DCUniMPSDK.getInstance().startApp(context, "__UNI__04E3A11", arguments);
} catch (Exception e) {
	e.printStackTrace();
}
```

--------------------------------

### UniPush Account Configuration Example

Source: https://nativesupport.dcloud.net.cn/AppDocs/usemodule/iOSModuleConfig/push.html

Add the 'getui' field to your project's info.plist and fill in the required information obtained from the developer backend.

```json
{
  "getui": {
    "appid": "YOUR_APPID",
    "appkey": "YOUR_APPKEY",
    "secret": "YOUR_SECRET"
  }
}
```

--------------------------------

### Example Plugin Directory Structure

Source: https://nativesupport.dcloud.net.cn/NativePlugin/course/android

Illustrates the expected directory structure for a native plugin, including AAR files, JARs, and SO files.

```directory
|-- DCloud-RichAlert --->插件id命名的文件夹
   |-- android       --->安卓插件目录
	  |--libs
		 - xxx.jar    --->依赖的jar
		 - libxxx.so  --->依赖的so文件
	  - vendor.aar   --->依赖的aar
	  - unipluginRichAlert.aar --->插件module的aar
```

--------------------------------

### Get UniMP Version

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/UniappHost/unimpapi.html

Retrieves the version information of an installed uni mini-program. Requires the mini-program's AppID.

```javascript
mp.getUniMPVersion('uni小程序的appid', (ret) => {
  console.log('getUniMPVersion: ' + JSON.stringify(ret));
});
```

--------------------------------

### Example: Adding Camera/Gallery Module Dependencies

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/UseModule/ios/ios.html

This section details the steps to integrate the Camera and Gallery module, including system libraries, SDK libraries, resource files, and Info.plist permissions.

```text
功能模块名称 | 5+ API | Uni API | 系统库 | SDK中的库 | 资源文件 | Info.plist（添加权限描述或字段）  
---|---|---|---|---|---|---
Camera(摄像头)/Gallery(图片选择) |  plus.camera  |  image  |  AssetsLibrary.framework   
Photos.framework   
CoreMedia.framework  
MetalKit.framework  
GLKit.framework  |  liblibCamera.a  |  DCTZImagePickerController.bundle  
DCMediaEditingController.bundle  |  NSCameraUsageDescription  
NSPhotoLibraryUsageDescription  
NSPhotoLibraryAddUsageDescription   
```

```text
将 UniMPSDK/Features/Lib 中的库
  * liblibCamera.a


系统库
  * AssetsLibrary.framework
  * AssetsLibrary.framework
  * Photos.framework
  * CoreMedia.framework
  * MetalKit.framework
  * GLKit.framework

添加到工程的 `TARGETS->Build Phases-> Link Binary With Libaries` 中；
```

```text
将 UniMPSDK/Features/Resources 中的
  * DCTZImagePickerController.bundle
  * DCMediaEditingController.bundle

两个资源文件添加到工程
```

```text
在工程的 info.plist 文件中添加
  * NSCameraUsageDescription
  * NSPhotoLibraryUsageDescription
  * NSPhotoLibraryAddUsageDescription


对于的描述信息；
```

--------------------------------

### installUniMP(options, callback)

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/UniappHost/unimpapi.html

Installs a uni-mini program into the host application from a WGT file. This method requires the uni-mini program's AppID and the path to its WGT file.

```APIDOC
## installUniMP(options, callback)

### Description
Installs a uni-mini program into the host app using its WGT file. This operation requires the AppID and the WGT file path.

### Method
`mp.installUniMP(options, callback)`

### Parameters
#### Options
- **appid** (String) - Required - The AppID of the uni-mini program.
- **wgtFile** (String) - Required - The file path to the uni-mini program's WGT file.

#### Callback Parameters
- **ret** (Object)
  - **type** (String) - "success" on success, "fail" on failure.
  - **code** (Number) - 0 on success, a corresponding error code on failure.
  - **message** (String) - Description of the failure.

### Request Example
```javascript
mp.installUniMP({
  appid: 'uni_mini_program_appid',
  wgtFile: 'path/to/uni_mini_program.wgt'
}, (ret) => {
  console.log('installUniMP: ' + JSON.stringify(ret));
});
```
```

--------------------------------

### Custom UniModule Execution Thread

Source: https://nativesupport.dcloud.net.cn/NativePlugin/course/ios?id=hook%E7%B3%BB%E7%BB%9F%E4%BA%8B%E4%BB%B6

Implement `uniExecuteThread` to specify a custom thread for your module's methods. Ensure thread survival if only `uniExecuteThread` is implemented. This example creates and starts a new thread named 'TestUniModule' with a run loop.

```objectivec
    -(NSThread*)uniExecuteThread
{
    if ( nil == _uniExecuteThread) {
        _uniExecuteThread = [[NSThread alloc] initWithTarget:self selector:@selector(uniNewThread) object:nil];
        [_uniExecuteThread setName:@"TestUniModule"];
        [_uniExecuteThread start];
    }

    return _uniExecuteThread;
}

-(void)uniNewThread
{
    @autoreleasepool {
        NSRunLoop *runLoop = [NSRunLoop currentRunLoop];
        [runLoop addPort:[NSMachPort port] forMode:NSRunLoopCommonModes];
        [runLoop run];

    }
}

```

--------------------------------

### initSDKEnvironmentWihtLaunchOptions

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/ios?id=dcunimpconfiguration

Initializes the SDK global environment with launch options. It is recommended to call this method in application:didFinishLaunchingWithOptions.

```APIDOC
## + (void)initSDKEnvironmentWihtLaunchOptions:(NSDictionary *)options;

### Description
Initializes the SDK global environment and sets launch options. This method should ideally be called within the `application:didFinishLaunchingWithOptions:` method of your application delegate.

### Method
`+ (void)initSDKEnvironmentWihtLaunchOptions:(NSDictionary *)options;`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **options** (NSDictionary) - Required - Launch options for the SDK.
```

--------------------------------

### Install Pods with No Repository Update

Source: https://nativesupport.dcloud.net.cn/AppDocs/usemodule/iOSModuleConfig/common.html

After modifying the Podfile, run this command to install the pods without updating the local repository. This is useful for faster installations when the repository is already up-to-date.

```bash
pod install --no-repo-update

```

--------------------------------

### DCUniMPSDK.getInstance().startApp

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/android.html

Launches a uni-mini program. Ensure that the SDK is initialized before calling this method. Supports custom splash screens, redirect paths, and arguments.

```APIDOC
## DCUniMPSDK.getInstance().startApp(context, appid, splashClass, redirectPath, arguments)

### Description
Starts a uni-mini program. It is crucial to ensure the SDK is initialized before invoking this method, which can be checked using `DCUniMPSDK.getInstance().isInitialize()`.

### Method
`startApp`

### Parameters
#### Path Parameters
- **context** (Context) - Required - The application context.
- **appid** (String) - Required - The application ID of the uni-mini program.
- **splashClass** (IDCUniMPAppSplashView) - Optional - A custom splash view interface class. This parameter is ineffective when restarting an already launched mini-program.
- **redirectPath** (String) - Optional - The uni-mini program page direct access path. This parameter is ineffective when restarting an already launched mini-program.
- **arguments** (JSONObject) - Optional - Parameters for launching the uni-mini program. These values can be retrieved using `plus.runtime.arguments` after the application starts.

### Redirect Path Parameter Description
The `redirectPath` parameter specifies the uni-mini program page path and any associated query parameters. The host application can obtain this data through various means like QR codes or schemes. The format is `pagePath(uni-mini program page path)+?+query(page carrying parameters)`.

Example format: `pages/component/scroll-view/scroll-view?a=1&b=2&c=3`

### Return Value
None

### Examples
```java
// Launch the mini-program
try {
	DCUniMPSDK.getInstance().startApp(context, "__UNI__04E3A11");
} catch (Exception e) {
	e.printStackTrace();
}
```

```java
// Launch the mini-program to open a specific page
try {
	DCUniMPSDK.getInstance().startApp(context, "__UNI__04E3A11", MySplashView.class, "pages/component/scroll-view/scroll-view?a=1&b=2&c=3");
} catch (Exception e) {
	e.printStackTrace();
}
```

```java
// Launch the mini-program and pass arguments "Hello uni microprogram"
try {
	JSONObject arguments = new JSONObject();
	arguments.put("MSG", "Hello uni microprogram");
	DCUniMPSDK.getInstance().startApp(context, "__UNI__04E3A11", arguments);
} catch (Exception e) {
	e.printStackTrace();
}
```
```

--------------------------------

### Add Permission for App Installation

Source: https://nativesupport.dcloud.net.cn/AppDocs/FAQ/android.html

Add the REQUEST_INSTALL_PACKAGES permission to your AndroidManifest.xml to allow the app to prompt for installation.

```xml
<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES"/>
```

--------------------------------

### Initialize UniMP SDK

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/harmony.html

Instructions on how to initialize the UniMP SDK by adding logic to the entryability file.

```APIDOC
## Initialize UniMP SDK

Open the Harmony project file `entry/src/main/ets/entryability` and add the logic to initialize the uniMP SDK.

```typescript
import { init } from '@dcloudio/uni-app-runtime'

init(this, windowStage)
```
```

--------------------------------

### DCUniMPSDK.getInstance().initialize

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/android.html

Initializes the DCUniMPSDK with the provided context, configuration, and callback.

```APIDOC
## DCUniMPSDK.getInstance().initialize(context, config, callback)

### Description
Initializes the UniMP SDK. This method must be called before using other SDK functionalities.

### Parameters
#### Path Parameters
- **context** (Context) - Required - The application context.
- **config** (DCSDKInitConfig) - Required - The SDK initialization configuration.
- **callback** (Callback) - Required - A callback function to be invoked after initialization.
```

--------------------------------

### Install WGT Resource

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/ios?id=%E5%90%91%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%8F%91%E9%80%81%E4%BA%8B%E4%BB%B6

Installs a WGT resource package to the running path. This method is available from version 3.3.7 onwards.

```APIDOC
## Install WGT Resource

### Description
Installs a WGT resource package to the running path. This method is available from version 3.3.7 onwards.

### Method
`+ (BOOL)installUniMPResourceWithAppid:(NSString *)appid resourceFilePath:(NSString *)wgtPath password:(nullable NSString *)password error:(NSError * *)error;`

### Parameters
- **appid** (NSString) - The application ID.
- **wgtPath** (NSString) - The path to the WGT resource.
- **password** (NSString, nullable) - The password for unzipping the WGT resource. Pass nil if there is no password.
- **error** (NSError **) - A pointer to an NSError object that will be populated with details if an error occurs during decompression.
```

--------------------------------

### Add Provider for App Installation

Source: https://nativesupport.dcloud.net.cn/AppDocs/FAQ/android.html

Configure the DCloud_FileProvider in your AndroidManifest.xml's application node to handle file-related operations for app installation.

```xml
<provider
            android:name="io.dcloud.common.util.DCloud_FileProvider"
            android:authorities="${apk.applicationId}.dc.fileprovider"
            android:exported="false"
            android:grantUriPermissions="true">
            <meta-data
                android:name="android.support.FILE_PROVIDER_PATHS"
                android:resource="@xml/dcloud_file_provider" />
        </provider>
```

--------------------------------

### Example: Sending Data from Host to UniMP

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/harmony.html

An example demonstrating how to send a custom event named 'unimp-event' with associated data to the UniMP mini-program.

```typescript
uniMP.sendUniMPEvent("unimp-event", {
	a: 1,
	b: "2"
});
```

--------------------------------

### DCUniMPSDK.getInstance().initialize(context, config, callback)

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/android.html

Initializes the UniMP SDK. This method sets up the SDK with the provided context, configuration, and an optional callback for initialization completion.

```APIDOC
## DCUniMPSDK.getInstance().initialize(context, config, callback)

### Description
Initializes the UniMP SDK. This method sets up the SDK with the provided context, configuration, and an optional callback for initialization completion.

### Method
`initialize(Context context, DCSDKInitConfig config, IDCUNIMPPreInitCallback callback)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **context** (Context) - Required - The Android Context.
- **config** (DCSDKInitConfig) - Optional - Initialization configuration settings.
- **callback** (IDCUNIMPPreInitCallback) - Optional - Callback interface invoked when initialization is finished (available from v2.6.14+).

### Request Example
```java
MenuActionSheetItem item = new MenuActionSheetItem("关于", "gy");
List<MenuActionSheetItem> sheetItems = new ArrayList<>();
sheetItems.add(item);
DCSDKInitConfig config = new DCSDKInitConfig.Builder()
	.setCapsule(true)
	.setMenuDefFontSize("16px")
	.setMenuDefFontColor("#ff00ff")
	.setMenuDefFontWeight("normal")
	.setMenuActionSheetItems(sheetItems)
	.build();
DCUniMPSDK.getInstance().initialize(this, config, new DCUniMPSDK.IDCUNIMPPreInitCallback() {
    @Override
    public void onInitFinished(boolean isSuccess) {
        Log.e("unimp", "onInitFinished----------- "+isSuccess);
    }
});
```

### Response
#### Success Response (200)
No specific success response body is defined; initialization is confirmed via the callback.
```

--------------------------------

### Launch Mini Program with Parameters (v3.3.7+)

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/android-v2.html

Launches a mini program and passes custom data and dark mode settings. Parameters are accessible via the `onLaunch` method in the mini program.

```java
// 启动小程序并传入参数 "Hello uni microprogram"
 try {
          UniMPOpenConfiguration uniMPOpenConfiguration = new UniMPOpenConfiguration();
          uniMPOpenConfiguration.extraData.put("MSG","Hello DCUniMPConfiguration");
          // 3.7.3 版本支持暗黑模式，可选值  dark,light,auto(跟随系统)
          uniMPOpenConfiguration.extraData.put("darkmode", "auto");
          mallMP = new SoftReference<>(DCUniMPSDK.getInstance().openUniMP(MainActivity.this, "__UNI__A922B72_minimall", uniMPOpenConfiguration));
 } catch (Exception e) {
          e.printStackTrace();
 }

```

```java
// 启动小程序并传入参数 "Hello uni microprogram"
 try {
          UniMPOpenConfiguration uniMPOpenConfiguration = new UniMPOpenConfiguration();
          uniMPOpenConfiguration.extraData.put("MSG","Hello DCUniMPConfiguration");
          // 3.7.3 版本支持暗黑模式，可选值  dark,light,auto(跟随系统)
          uniMPOpenConfiguration.extraData.put("darkmode", "auto");
          mallMP = new SoftReference<>(DCUniMPSDK.getInstance().openUniMP(MainActivity.this, "__UNI__A922B72_minimall", uniMPOpenConfiguration));
 } catch (Exception e) {
          e.printStackTrace();
 }

```

```javascript
onLaunch: function(options) {
    console.log('MiniMall App Launch --- ' + JSON.stringify(options));
}
```

```javascript
onLaunch: function(options) {
    console.log('MiniMall App Launch --- ' + JSON.stringify(options));
}
```

--------------------------------

### Initialize SDK Environment

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/ios?id=dcunimpinstance

Initializes the SDK global environment with launch options. This method should ideally be called within the application:didFinishLaunchingWithOptions method.

```APIDOC
## + (void)initSDKEnvironmentWihtLaunchOptions:(NSDictionary *)options;

### Description
Initializes the SDK global environment with launch options.

### Method
`+` (Class method)

### Parameters
#### Parameters
- **options** (NSDictionary) - Launch options for the SDK.
```

--------------------------------

### Launch Mini Program

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/android-v2.html

Initiates a mini program from a host application page. Requires context, appid, and optional configuration.

```java
// 启动小程序
IUniMP unimp = DCUniMPSDK.getInstance().openUniMP(context, appid, uniMPOpenConfiguration)
```

```java
// 启动小程序
IUniMP unimp = DCUniMPSDK.getInstance().openUniMP(context, appid, uniMPOpenConfiguration)
```

--------------------------------

### Complete build.gradle Example

Source: https://nativesupport.dcloud.net.cn/AppDocs/usesdk/android.html

A comprehensive build.gradle file configuration for an Android application, including SDK versions, application ID, multiDex support, ABI filters, and dependencies. This serves as a reference for integrating the SDK.

```gradle
apply plugin: 'com.android.application'

android {
	compileSdkVersion 35
	defaultConfig {
		applicationId "com.example.myapplication"
		minSdkVersion 21
		targetSdkVersion 30
		versionCode 1
		versionName "1.0"
		multiDexEnabled true
		ndk {
			abiFilters 'x86', 'armeabi-v7a', 'arm64-v8a'
		}
	}
	compileOptions {
		sourceCompatibility JavaVersion.VERSION_1_8
		targetCompatibility JavaVersion.VERSION_1_8
	}
	buildTypes {
		release {
			minifyEnabled false
			proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
		}
	}
}

dependencies {
	implementation fileTree(dir: 'libs', include: ['*.aar', '*.jar'], exclude: [])
	implementation 'androidx.appcompat:appcompat:1.0.0'
	implementation 'androidx.legacy:legacy-support-v4:1.0.0'
	implementation 'com.alibaba:fastjson:1.2.83'
	implementation 'androidx.webkit:webkit:1.3.0'
}
```

--------------------------------

### Exclude Vue 2 Dev and Vue 3 Frameworks for Official Builds (Example)

Source: https://nativesupport.dcloud.net.cn/AppDocs/FAQ/jsframeworkdeclare.html

This is an example of the Gradle configuration used to exclude specific JavaScript frameworks for official Vue 2 builds.

```gradle
applicationVariants.all {
    variant ->
    variant.mergeAssets.doLast {
        delete(fileTree(dir: variant.mergeAssets.outputDir, includes: ['*dev.js','*vue3.js']))
    }
}
```

--------------------------------

### Configure Startup Mode

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/ios?id=%E8%BD%AC%E5%9C%BA%E5%8A%A8%E7%94%BB

Defines how the mini-program is opened within the host app. Supports `DCUniMPOpenModePresent` and `DCUniMPOpenModePush`.

```APIDOC
## Configure Startup Mode

### Description

Defines how the mini-program is opened within the host app. Supports `DCUniMPOpenModePresent` and `DCUniMPOpenModePush`.

### Modes

- `DCUniMPOpenModePresent`: Uses `presentViewController:animated:completion:` to open the mini-program.
- `DCUniMPOpenModePush`: Uses `pushViewController:animated:` to open the mini-program. Falls back to `DCUniMPOpenModePresent` if `navigationController` is not available.

### Configuration

Set the `openMode` property of `DCUniMPConfiguration`.

### Example

```objectivec
DCUniMPConfiguration *configuration = [[DCUniMPConfiguration alloc] init];
configuration.openMode = DCUniMPOpenModePush;  // Use push mode to open the mini-program
```
```

--------------------------------

### Initialize SDK Environment

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/ios?id=%E5%90%91%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%8F%91%E9%80%81%E4%BA%8B%E4%BB%B6

Initializes the SDK global environment with launch options. Recommended to be called in application:didFinishLaunchingWithOptions.

```objective-c
/// 初始化 sdk 全局环境
/// @param options 启动参数
+ (void)initSDKEnvironmentWihtLaunchOptions:(NSDictionary *)options;
```

--------------------------------

### Exclude Dev Frameworks and Vue 2 Official Framework for Vue 3 Builds (Example)

Source: https://nativesupport.dcloud.net.cn/AppDocs/FAQ/jsframeworkdeclare.html

This example demonstrates the Gradle configuration for excluding specific JavaScript frameworks when building for Vue 3 official packages.

```gradle
applicationVariants.all {
    variant ->
    variant.mergeAssets.doLast {
        delete(fileTree(dir: variant.mergeAssets.outputDir, includes: ['*dev.js','uni-jsframework.js']))
    }
}
```

--------------------------------

### DCUniMPSDK.getInstance

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/android.html

Gets the singleton instance of the DCUniMPSDK.

```APIDOC
## DCUniMPSDK.getInstance()

### Description
Retrieves the singleton instance of the DCUniMPSDK. This is the main entry point for interacting with the SDK.

### Return Value
#### Success Response
- **DCUniMPSDK** - The singleton instance of the SDK.
```

--------------------------------

### installUniMP

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/UniappHost/unimpapi.html

Loads a uni-mini program module. This API is used in the host app.

```APIDOC
## installUniMP

### Description
Loads a uni-mini program module.

### Method
(Not specified, assumed to be a function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **options** (Object) - Required - Options for loading the uni-mini program.
- **callback** (Function) - Required - Callback function to handle the result.
```

--------------------------------

### getUniMPVersion

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/UniappHost/unimpapi.html

Gets the version of a uni-mini program. This API is used in the host app.

```APIDOC
## getUniMPVersion

### Description
Gets the version of a uni-mini program.

### Method
(Not specified, assumed to be a function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **appid** (String) - Required - The App ID of the uni-mini program.
- **callback** (Function) - Required - Callback function to handle the result, which will receive the version information.
```

--------------------------------

### getCurrentPageUrl

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/ios?id=dcunimpconfiguration

Gets the direct access URL of the current page in the UniMP mini-program.

```APIDOC
## getCurrentPageUrl

### Description
Gets the direct access URL of the current page in the UniMP mini-program.

### Method
+ (NSString *)getCurrentPageUrl;
```

--------------------------------

### Initialize SDK Engine in AppDelegate

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/UseSdk/ios

Initialize the UniMP SDK engine and set launch parameters within the `application:didFinishLaunchingWithOptions:` method in `AppDelegate.m`. Ensure you import `DCUniMP.h`.

```Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.

    // 配置参数
    NSMutableDictionary *options = [NSMutableDictionary dictionaryWithDictionary:launchOptions];
    // 设置 debug YES 会在控制台输出 js log，默认不输出 log，注：需要引入 liblibLog.a 库
    [options setObject:[NSNumber numberWithBool:YES] forKey:@"debug"];
    // 初始化引擎
    [DCUniMPSDKEngine initSDKEnvironmentWithLaunchOptions:options];

    return YES;
}
```

--------------------------------

### Get Active UniMP Appid

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/ios.html

Retrieves the AppID of the currently running UniMP mini-program.

```APIDOC
## Get Active UniMP Appid

### Description
Retrieves the AppID of the currently running UniMP mini-program.

### Method
`+ (NSString *)getActiveUniMPAppid;`
```

--------------------------------

### Initialize Uni-App SDK in EntryAbility.ets

Source: https://nativesupport.dcloud.net.cn/AppDocs/usesdk/harmony.html

Add this code to your Harmony project's `/entry/src/main/ets/entryability/EntryAbility.ets` file to initialize the uni-app SDK. Ensure you have the correct version of `@dcloudio/uni-app-runtime` installed.

```typescript
import { UniEntryAbility } from "@dcloudio/uni-app-runtime";
import { initUniModules } from "../uni_modules/index.generated";
import BuildProfile from "BuildProfile";

initUniModules();

export default class EntryAbility extends UniEntryAbility {
  constructor() {
    super("HBuilder", {
      debug: BuildProfile.DEBUG,
    });
  }
}
```

--------------------------------

### Configuring Parameters in Info.plist for Native Plugins

Source: https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios.html

Demonstrates how to configure plugin-specific parameters, such as 'appid' for Getui, within the Info.plist file, using nested dictionary structures.

```xml
<key>getui</key>
<dict>
	<key>appid</key>
	<string>填写对应的appid</string>
</dict>

```

--------------------------------

### Get Active UniMP AppID

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/ios?id=%E5%90%91%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%8F%91%E9%80%81%E4%BA%8B%E4%BB%B6

Retrieves the AppID of the currently running UniMP application.

```APIDOC
## Get Active UniMP AppID

### Description
Retrieves the AppID of the currently running UniMP application.

### Method
`+ (NSString *)getActiveUniMPAppid;`
```

--------------------------------

### DCUniMPSDK.initialize(context, config, callback)

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/android-v2.html

Initializes the UniMP SDK. This method requires a Context and can optionally accept initialization configurations and a callback for completion.

```APIDOC
## DCUniMPSDK.initialize(context, config, callback)

### Description
Initializes the SDK. This is a crucial step before utilizing other SDK functionalities.

### Method
`initialize(context, config, callback)`

### Parameters
#### Path Parameters
- **context** (Context) - Required - The Android context.
- **config** (DCSDKInitConfig) - Optional - Initialization configuration settings.
- **callback** (IDCUniMPPreInitCallback) - Optional - An interface callback that is invoked once initialization is complete.

### Return Value
None

### Example
```java
MenuActionSheetItem item = new MenuActionSheetItem("关于", "gy");
List<MenuActionSheetItem> sheetItems = new ArrayList<>();
sheetItems.add(item);
DCSDKInitConfig config = new DCSDKInitConfig.Builder()
	.setCapsule(true)
	.setMenuDefFontSize("16px")
	.setMenuDefFontColor("#ff00ff")
	.setMenuDefFontWeight("normal")
	.setMenuActionSheetItems(sheetItems)
	.build();
DCUniMPSDK.getInstance().initialize(this, config, new IDCUniMPPreInitCallback() {
    @Override
    public void onInitFinished(boolean isSuccess) {
        Log.e("unimp", "onInitFinished-----------" + isSuccess);
    }
});
```
```

--------------------------------

### DCUniMPSDK.getInstance()

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/android.html

Gets the singleton instance of the DCUniMPSDK. This is the factory method to obtain the SDK object.

```APIDOC
## DCUniMPSDK.getInstance()

### Description
Gets the singleton instance of the DCUniMPSDK. This is the factory method to obtain the SDK object.

### Method
`getInstance()`

### Parameters
None

### Return Value
- **DCUniMPSDK**: The DCUniMPSDK object instance.
```

--------------------------------

### FCM Account Configuration Example

Source: https://nativesupport.dcloud.net.cn/AppDocs/usemodule/iOSModuleConfig/push.html

Download the 'GoogleService-Info.plist' file from the Firebase console and add it to your project.

```xml
<key>GoogleService-Info.plist</key>
```

--------------------------------

### Launch UniMP Application

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/harmony.html

How to navigate from a host application page to a UniMP application using the `openUniMP` API.

```APIDOC
## Launch UniMP Application

Navigate from the host application page to the UniMP application.

### API Description

```typescript
// entry/src/main/ets/pages/Index.ets
import { openUniMP } from '@dcloudio/uni-app-runtime';

@Entry
@Component
struct Index {
  @State message: string = 'Open UniMP';

  build() {
    RelativeContainer() {
      Button(this.message)
        .alignRules({
          center: { anchor: '__container__', align: VerticalAlign.Center },
          middle: { anchor: '__container__', align: HorizontalAlign.Center }
        })
        .onClick(async () => {
          const uniMP = openUniMP(appid, uniMPOpenConfiguration);
        })
    }
    .height('100%')
    .width('100%')
  }
}
```

### Parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| appid | String | Yes | The appid of the mini program |
| uniMPOpenConfiguration | UniMPOpenConfiguration | No | Parameter collection class for opening the mini program |

### Return Value

| Type | Description |
|---|---|
| uniMP | The interface object for the unimp mini program instance |
```

--------------------------------

### Objective-C: Launch UniMP Mini Program

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/ios?id=%E4%BE%A7%E6%BB%91%E6%89%8B%E5%8A%BF%E5%85%B3%E9%97%AD%E5%B0%8F%E7%A8%8B%E5%BA%8F

Use this method to launch a UniMP mini program. Provide the appid, a configuration object, and a completion block for callbacks.

```objective-c
Class DCUniMPSDKEngine
/// 启动小程序
/// @param appid appid
/// @param configuration 小程序的配置信息
/// @param completionBlock 方法执行回调
+ (void)openUniMP:(NSString *)appid
    configuration:(DCUniMPConfiguration *)configuration
        completed:(DCUniMPCompletionBlock)completionBlock;
```

--------------------------------

### Get Splash View for App (iOS)

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/API/ios?id=%E5%90%91%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%8F%91%E9%80%81%E4%BA%8B%E4%BB%B6

Returns the splash view that was displayed when the mini-program was opened.

```Objective-C
/// 返回打开小程序时的闪屏视图
/// @param appid appid
- (UIView *)splashViewForApp:(NSString *)appid;
```

--------------------------------

### Launch to Specific Page

Source: https://nativesupport.dcloud.net.cn/UniMPDocs/Sample/android-v2.html

Opens a mini program directly to a specified page using its path. Note that parameters are ignored if the target page is the homepage and a Vue page.

```string
pages/component/view/view?action=redirect

```

```string
pages/component/view/view?action=redirect

```

```java
// 启动直达页面
DCUniMPSDK.getInstance().openUniMP(context,"__UNI__04E3A11", "pages/component/view/view?action=redirect");

```

```java
// 启动直达页面
DCUniMPSDK.getInstance().openUniMP(context,"__UNI__04E3A11", "pages/component/view/view?action=redirect");

```
Tokens:
Raw