tencent cloud

文档反馈

小程序管理 API

最后更新时间:2024-03-04 22:43:53

    打开小程序

    打开普通小程序

    打开小程序时,会先判断本地是否有缓存的小程序。
    如果没有,则会自动从远程服务器上下载小程序,然后打开。
    如果有缓存的小程序,则会先打开本地小程序,同时后台校验服务器端是否有新版本。
    说明:
    如果有新版本,则下载新版小程序,下次打开时,就会使用新版小程序
    /// 通过小程序id打开小程序
    /// @param appID 小程序ID
    /// @param scene 场景值
    /// @param firstPage 打开页面
    /// @param paramsStr 带入参数
    /// @param parentVC 从哪个vc呼起
    /// /// @param completion 错误回调
    - (void)startUpMiniAppWithAppID:(NSString *)appID
    scene:(TMAEntryScene)scene
    firstPage:(NSString * _Nullable)firstPage
    paramsStr:(NSString * _Nullable)paramsStr
    parentVC:(UIViewController *)parentVC
    completion:(void (^)(NSError * _Nullable))completion;
    options 支持的参数列表:
    名称
    必须
    类型
    作用
    appID
    YES
    NSString
    打开指定小程序的小程序 id
    scene
    YES
    TMAEntryScene
    打开小程序使用的场景值
    firstPage
    NO
    NSString
    打开页面
    paramsStr
    NO
    NSString
    打开传递参数
    parentVC
    YES
    UIViewController
    从哪个 VC 呼起
    completion
    YES
    block
    错误回调

    打开二维码小程序

    TCMPP 支持识别二维码的内容打开小程序。
    /// 通过二维码呼起小程序
    /// @param qrData 二维码内容
    /// @param parentVC 从哪个vc呼起
    /// @param completion 错误回调
    - (void)startUpMiniAppWithQrData:(NSString *)qrData
    parentVC:(UIViewController *)parentVC
    completion:(void (^)(NSError * _Nullable error))completion;

    关闭小程序

    ///关闭所有内存中正在运行的小程序
    
    - (void)closeAllApplications;

    清理缓存

    由于小程序的运行,会将小程序包和小程序信息缓存在本地,以便下次更快速的打开。如果想要将小程序的所有信息都删除,可以调用以下 API 删除某个小程序或者删除所有小程序。
    /// 移除小程序所有相关缓存 包含资源包、基础库、小程序/小游戏沙箱数据
    - (void)clearMiniAppCache;

    获取小程序信息

    获取当前正在运行的小程序信息

    /// 获取当前正在运行的小程序对象
    /// @return TMFAppletInfo 小程序信息
    - (TMFMiniAppInfo *)currentApplet;

    获取最近打开过的所有小程序信息

    //获取最近打开的所有小程序信息
    ///@return 小程序数组<TMFMiniAppInfo>
    - (NSArray *)loadAppletsFromCache;

    搜索小程序

    可以根据关键词,搜索目前小程序平台上已经发布的小程序列表。
    /// 搜索小程序
    /// @param name 搜索名称关键词
    /// @param completion 搜索结果
    - (void)searchAppletsWithName:(NSString *)name
    completion:(void (^)(NSArray<TMFAppletSearchInfo *> * _Nullable, NSError * _Nullable))completion;
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持