tencent cloud

Feedback

API Description

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;
    }
    }
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support