tencent cloud

Tencent Cloud Super App as a Service

Release Notes and Announcements
Announcement: Tencent Cloud Mini Program Platform Renamed to Tencent Cloud Super App as a Service on January 2, 2025
Console Updates
Android SDK Updates
iOS SDK Updates
Flutter SDK Updates
IDE Updates
Base Library Updates
Product Introduction
Overview
Strengths
Use Cases
Purchase Guide
Billing Overview
Pay-As-You-Go Billing
Renewal Guide
Service Suspension Instructions
Getting Started
Plan Management
Overview
Console Account Management
Storage Configuration
Acceleration Configuration
Branding Configurations
Platform Features
Console Login
Users and Permission System
Mini Program Management
Mini Game Management
Superapp Management
Commercialization
Platform Management
User Management
Team Management
Operations Management
Security Center
Code Integration Guide
Getting Demo and SDK
Android
iOS
Flutter
Superapp Server
GUID Generation Rules
Mini Program Development Guide
Mini Program Introduction and Development Environment
Mini Program Code Composition
Guide
Framework
Components
API
Server Backend
JS SDK
Base Library
IDE Operation Instructions
Mini Game Development Guide
Guide
API
Server Backend
Practice Tutorial
Mini Program Login Practical Tutorial
Mini Program Subscription Message Practical Tutorial
Payment Practical Tutorial
Ad Integration Practical Tutorial
Mini Game Subscription Message Practical Tutorial
API Documentation
History
Introduction
API Category
Making API Requests
Operation Management APIs
User Management APIs
Team Management APIs
Sensitive API-Related APIs
Role Management APIs
Platform Management APIs
Other Console APIs
Mini Program or Mini Game APIs
Management-Sensitive APIs
Global Domain Management APIs
Superapp APIs
Data Types
Agreements
Service Level Agreement
Data Processing and Security Agreement
SDK Privacy Policy Module
SDK Data Processing and Security Agreement Module

API Description

PDF
Focus Mode
Font Size
Last updated: 2024-08-06 15:17:13

MiniStartOptions

class MiniStartOptions {
/// Entry path to the mini program.
String? entryPath;

/// Always update the mini program on startup.
bool? isForceUpdate;

/// String parameters to pass to the mini program on
String? params;
}

ScanResult

class ScanResult {
/// The result string for a qrcode or barcode contains
String? result;

/// code type
String? scanType;

/// Character encoding of the result string
String? charset;
}

AppInfo

class AppInfo {
/// Mini program id.
String appId;

/// The mini program package type (distribution, development, etc.). See [AppVerType].
int appVerType;

/// The mini program version.
String version;

/// Name of the mini program.
String? name;

/// The mini program icon link.
String? iconUrl;

/// Description of the mini program.
String? appIntro;

/// Mini program developer.
String? appDeveloper;

/// Mini program release time.
int time;
}

AppVerType

/// Constants for mini program package types, see [AppInfo].
class AppVerType {
static const int online = 0;
static const int develop = 1;
static const int preview = 2;
static const int experience = 3;
}

AccountInfo

class AccountInfo {
/// Unique ID of the current account
String? uid;

/// Link to the avatar
String? avatarUrl;

/// Current account name
String? accountName;
}

OpenApiHandler

abstract class OpenApiHandler {
// Called when the mini program calls wx.requestPayment to request a third-party payment operation.
Future<Map<String, dynamic>> requestPayment(
AppInfo appInfo, Map<Object?, Object?> params);

//// Called when the mini program calls wx.getUserProfile to request user information from the host application.
///
Future<Map<String, dynamic>> getUserProfile(
AppInfo appInfo, Map<Object?, Object?> params);

/// Called when the mini program calls wx.login, requesting the host application's login credentials.
///
Future<Map<String, dynamic>> login(
AppInfo appInfo, Map<Object?, Object?> params);

/// Called when the mini program calls wx.checkSession, requesting the host application's login status.
/// Checks if the login has expired
///
Future<Map<String, dynamic>> checkSession(
AppInfo appInfo, Map<Object?, Object?> params);

/// Called when the mini program calls wx.getUserInfo, which has been outdated by wx.getUserProfile.
/// Compatible with earlier mini program api.
///
Future<Map<String, dynamic>> getUserInfo(
AppInfo appInfo, Map<Object?, Object?> params);

/// Called when the mini program calls wx.getPhoneNumber to get the current user's phone number.
///
Future<Map<String, dynamic>> getPhoneNumber(
AppInfo appInfo, Map<Object?, Object?> params);
}

TcmppPlatformEventHandler

abstract class TcmppPlatformEventHandler {


Future<String> getAppName() async {
return "";
}

Future<String> getAppVersion() async {
return "";
}

Future<List<CustomMenu>> getCustomMenus() async {
return [];
}


Future<void> customMenuClick(String menuId, ShareData? shareMenu) async {}
Future<void> onMiniProgramStateChange(
String appId, MiniProgramState state) async {}


Future<bool> reportEvent(int eventId, String eventName, AppInfo appInfo,
Map<Object?, Object?> params) async {
return false;
}
}


Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback