Quick Start

This topic describes how to quickly get started using the MiniApp SDK with a HarmonyOS project.

Initialize the SDK

SDK initialization code is located in entry/src/main/ets/app/AppAbilityStage.ets. Initialization is automatically completed when the app starts. For a complete initialization code example, refer to the entry/src/main/ets/app/AppAbilityStage.ets file in the sample project.

Open miniapp

The APIs used to manage a miniapp include but are not limited to the following:

• Open a miniapp
• Open a device panel

Dedicated APIs are provided to open a miniapp in different scenarios. The HarmonyOS version uses ThingRouter to open miniapp and panel.

Open miniapp

Use ThingRouter to open a miniapp:

import { ThingRouter } from "@thingsmart/thingrouter";

// Open miniapp
ThingRouter.getInstance()
  .setParam({
    // Miniapp URL, format: godzilla://miniprogramId/pagePath?queryA=a
    'url': 'godzilla://miniprogramId/pagePath'  
  })
  .push("miniApp")

Open device panel

Use ThingRouter to open a device panel:

import { ThingRouter } from "@thingsmart/thingrouter";

// Open device panel
ThingRouter.getInstance()
  .setParam({
    'devId': 'deviceId',  // Device ID
    'groupId': 'groupId',  // Device group ID (optional)
    /**
     * Passed through to initialProps and contextProps
     */
    // 'propsData': {} as Record<string, Object>  // Custom parameters (optional)
  })
  .push("panel")

Supported parameters

The miniapp initialization supports multiple parameter formats. The following table lists all supported parameters:

Query related information

During miniapp runtime, some basic information is required to help Tuya better locate issues. Therefore, Tuya provides APIs to query some runtime information.

First, you need to get the MiniAppContainerInfoService service instance:

import { MiniAppContainerInfoService } from "@thingsmart/godzillainterface";
import { ThingRouter } from "@thingsmart/thingrouter";

// Get miniapp container information service
const miniappService = await ThingRouter.getServiceMgr()
  .getServiceAsync<MiniAppContainerInfoService>('MiniAppContainerInfoService');

API description

/**
 * Returns the latest base library version
 */
abstract jsSdkVersion(): string;

/**
 * Returns the miniapp container version corresponding to the current SDK
 */
abstract containerVersion(): string;

/**
 * Returns the TTT-Kits version information that the current App depends on
 */
abstract tttKitsInfo(): Record<string, string>;

/**
 * Returns the list of recently opened miniapps
 */
abstract recentlyOpenedMiniPrograms(): RecentlyOpenedMiniProgram[];

/**
 * Actively clears miniapp cache
 */
abstract cleanCache(): void;