tencent cloud

文档反馈

API 说明

最后更新时间:2024-07-29 16:56:21

    MiniStartOptions

    小程序启动参数配置
    /** * 打开小程序时是否强制检查更新(APP每次启动第一次打开小程序有效),false:优先使用本地缓存,同时异步获取最新数据;true:待网络返回后才打开小程序 */ public boolean isForceUpdate = false; /** * 入口地址,支持添加参数:path?key=value&key1=value1 */ public String entryPath; /** * 接收小程序启动过程中错误信息 */ public ResultReceiver resultReceiver; /** * 小程序启动参数 */ public String params; /** * 设置打开小程序时使用的任务模式 * * false: 多任务模式,true: 为单任务模式 */ public boolean isSingleTask;

    MiniCode

    返回错误码描述。
    /**
    * 成功
    */
    public static final int CODE_OK = 0;
    
    //////////////////////////////服务端错误//////////////////////////////////
    public static final int C_SERVER = -11000;
    /**
    * shark网络错误
    */
    public static final int C_SERVER_SHARK_ERROR = -11001;
    /**
    * 服务端返回code错误
    */
    public static final int C_SERVER_RET_CODE_ERROR = -11002;
    /**
    * 服务端返回response为空
    */
    public static final int C_SERVER_RESPONSE_NULL = -11003;
    /**
    * 服务端返回小程序更新类型有问题
    */
    public static final int C_SERVER_UPDATE_TYPE_ERROR = -11004;
    /**
    * 服务端返回数据解析异常
    */
    public static final int C_SERVER_PARSE_DATA_ERROR = -11005;
    /**
    * 小程序不存在或已下架
    */
    public static final int C_SERVER_TAKE_OFF = -11006;
    /** * 达到月活上限 */ public static final int C_SERVER_MAU_LIMIT = -11007; /** * 资源限额 */ public static final int C_SERVER_RES_LIMIT = -11008; /** * 单个接口请求频率过高 */ public static final int C_SERVER_FREQ_LIMIT_API = -11011;
    
    //////////////////////////////客户端错误//////////////////////////////////
    public static final int C_CLIENT = -12000;
    /**
    * shark实例空
    */
    public static final int C_CLIENT_SHARK_IS_NULL = -12001;
    /**
    * 预览小程序需要先登录
    */
    public static final int C_CLIENT_NEED_LOGIN_PREVIEW_APP = -12002;
    /**
    * 数据解析异常
    */
    public static final int C_CLIENT_JSON_EXCEPTION = -12003;
    /**
    * 扫码异常
    */
    public static final int C_CLIENT_SCAN_ERROR = -12004;
    /**
    * 小程序信息缺失
    */
    public static final int C_CLIENT_MINI_APP_INFO_ERROR = -12005;
    /**
    * 扫码错误
    */
    public static final int C_CLIENT_QRCODE_ERROR = -12006;
    /**
    * 非tmf小程序二维码
    */
    public static final int C_CLIENT_QRCODE_INVALIDATE = -12007;
    /**
    * appId空
    */
    public static final int C_CLIENT_APPID_EMPTY = -12008;
    /**
    * businessId null
    */
    public static final int C_CLIENT_QRCODE_BUSINESSID_NULL = -12009;
    /**
    * 小程序启动异常
    */
    public static final int C_CLIENT_START_MINI_APP_THROWABLE = -12010;
    /**
    * json解析异常
    */
    public static final int C_CLIENT_JSON_ERROR = -12011;
    /**
    * 小程序下载失败
    */
    public static final int C_CLIENT_MINI_APP_DOWNLOAD_FAIL = -12012;
    /**
    * 小程序解析失败
    */
    public static final int C_CLIENT_MINI_APP_PARSE_FAIL = -12013;

    MiniApp

    小程序信息描述类。
    
    /**
    * 正式小程序
    */
    public static final int TYPE_ONLINE = MiniSDKConst.ONLINE;
    /**
    * 调试小程序
    */
    public static final int TYPE_DEVELOP = MiniSDKConst.DEVELOP;
    /**
    * 预览小程序
    */
    public static final int TYPE_PREVIEW = MiniSDKConst.PREVIEW;
    /**
    * 体验小程序
    */
    public static final int TYPE_EXPERIENCE = MiniSDKConst.EXPERIENCE;
    /**
    * 小程序id
    */
    public String appId;
    /**
    * 小程序版本类型(正式、预览、开发版)
    */
    public int appVerType;
    /**
    * 小程序版本
    */
    public String version;
    /**
    * 小程序名
    */
    public String name;
    /**
    * 小程序图标
    */
    public String iconUrl;
    /**
    * 小程序简介
    */
    public String appIntro;
    /**
    * 开发者企业名称
    */
    public String appDeveloper;
    /**
    * 时间戳
    */
    public long time;

    MiniScene

    小程序打开的场景。
    /**
    * 小程序主入口,「最近使用」列表
    */
    public static final int LAUNCH_SCENE_MAIN_ENTRY = 1001;
    /**
    * 扫码打开
    */
    public static final int LAUNCH_SCENE_QR_CODE_FROM_SCAN = 1011;
    /**
    * 搜索打开
    */
    public static final int LAUNCH_SCENE_SEARCH = 2005;

    SearchOptions

    /**
    * 搜索关键字,为空时搜索全部小程序
    */
    public String keyWord = "";
    /** * 指定一级分类 */ public String firstLevelCate; /** * 指定二级分类 */ public String secondaryLevelCate;

    ShareData

    /**
    * 分享来源,ShareSource中的值
    */
    public int shareSource;
    /**
    * 分享目标, ShareTarget中的值
    */
    public int shareTarget;
    /**
    * 分享面板设置的ID,用于区分分享渠道
    */
    public int shareItemId;
    /**
    * 分享标题
    */
    public String title;
    /**
    * 分享摘要
    */
    public String summary;
    /**
    * 分享图片的路径。为本地图片路径或者网络图片路径
    */
    public String sharePicPath;
    /**
    * 是否为本地图片。如果为True,则sharePicPath为本地图片的路径;否则,sharePicPath为网络图片的路径
    */
    public boolean isLocalPic;
    /**
    * 从服务端获取的字段:分享链接
    */
    public String targetUrl;
    /**
    * 小程序包信息
    */
    protected MiniAppInfo miniAppInfo;

    ShareSource

    public static class ShareSource {
    
    public static final int INNER_BUTTON = 11; // 来自小程序|小游戏的内部按钮
    public static final int MORE_BUTTON = 12; // 来自胶囊按钮的更多选项
    }

    ShareTarget

    public static class ShareTarget {
    public static final int QQ = 0;// 转发到QQ通讯录
    public static final int QZONE = 1;// 转发到QQ空间
    public static final int WECHAT_FRIEND = 3;//转发到微信好友
    public static final int WECHAT_MOMENTS = 4;//转发到微信朋友圈
    }

    ShareResult

    public static class ShareResult {
    public static final int SUCCESS = 0;// 分享成功
    public static final int FAIL = 1;// 分享失败
    public static final int CANCEL = 2;// 分享取消
    }

    MiniStartLinkOptions

    public class MiniStartLinkOptions {
    /**
    * 打开小程序时是否强制检查更新(APP每次启动第一次打开小程序有效),false:优先使用本地缓存,同时异步获取最新数据;true:待网络返回后才打开小程序
    */
    public boolean isForceUpdate = false;
    /**
    * 入口地址
    */
    public String entryPath;
    /**
    * 接收小程序启动过程中错误信息
    */
    public ResultReceiver resultReceiver;
    
    /**
    * 小程序启动参数
    */
    public String params;
    }

    MiniInitConfig

    /**
    * assets中配置文件名称
    */
    private String configAssetName;
    /**
    * 自定义配置文件路径
    */
    private String configFilePath;
    /** * 配置文件内容 */ private String configJsonStr;
    /**
    * imei,用于后台小程序推送配置
    */
    private String imei;
    /**
    * sdk日志开关
    */
    private boolean debug;
    /**
    * 设置外部shark实例
    */
    private IShark shark;
    /**
    * 加载配置文件时,是否校验配置文件中的包名
    */
    private boolean verifyPkg;
    /**
    * 是否使用x5内核
    */
    private boolean isUserX5Core = true;
    /** * 是否强制使用内核基础库 */ private boolean forceUseBaseLibInAsset;
    /** * 预置离线包assets路径 */ private String assetPathOfPresets;

    IMiniAppContext

    /**
    * 返回小程序信息
    */
    MiniAppInfo getMiniAppInfo();

    MiniAppInfo

    public String appId;//小程序对应APPID
    public String name;//小程序的名称
    public String iconUrl;//小程序图标url
    public String version;//小程序版本号
    public int verType;//小程序类型:开发、预览、正式版

    IpcCallback

    public interface IpcCallback {
    /**
    * 进程通信回调
    * @param isSucc 是否成功调用
    * @param response 返回数据
    */
    void result(boolean isSucc, Bundle response);
    }

    IpcRequestEvent

    public Context context;
    //数据
    public Bundle data;
    //返回回调
    public IpcCallback callback;

    RequestEvent

    //小程序activity
    public WeakReference<Activity> activityRef;
    //事件名
    public String event;
    //事件参数
    public String jsonParams;

    AppState

    /** * 小程序启动 */ int STATE_START = 1; /** * 小程序切换到前台 */ int STATE_FOREGROUND = 2; /** * 胶囊关闭小程序 */ int STATE_CLOSE = 3; /** * 小程序切换到后台 */ int STATE_BACKGROUND = 4; /** * 小程序销毁 */ int STATE_DESTROY = 5;

    MiniAppEvent

    /** * 小程序信息 */ public MiniApp miniApp; /** * 是否热启动 */ public boolean isHotStart;

    PreDownloadInfo

    /** * 小程序appId */ public String appId;
    /** * 是否下载小程序包 */ public boolean isDownload;

    IDownloadCallback

    /** * 下载成功回调 * * @param downloadInfo */ void onFinish(DownloadInfo downloadInfo); /** * 回调失败 * * @param downloadInfo */ void onError(DownloadInfo downloadInfo);

    DownloadInfo

    //下载IOEXCEPTION和IllegalAccessException异常 public static final int CODE_DOWNLOAD_IOEXCEPTION = -100001; //下载EXCEPTION异常 public static final int CODE_DOWNLOAD_EXCEPTION = -100002; //没有网 public static final int CODE_NO_NETWORK = -100003; //下载参数错误 public static final int CODE_PARAM_ERROR = -100004; //下载目录创建失败 public static final int CODE_DOWNLOAD_DIR_CREATE_FAIL = -100005; //下载目录创建失败 public static final int CODE_MINI_APP_PARSE_FAIL = -12013;
    
    /** * 小程序 id */ private String appId; /** * 错误 code */ private int errCode; /** * 错误msg */ private String message;

    IMiniAppFileManager

    /** * 获取wxfile绝对路径 * @param wxFilePath * @return */ String getAbsolutePath(String wxFilePath); /** * 将绝对路径转为 wxfile * @param path * @return */ String getWxFilePath(String path); /** * 获取临时目录 * @param suffix * @return */ String getTmpPath(String suffix);

    BaseJsPlugin

    /**
    * 小程序上下文
    */
    protected IMiniAppContext mMiniAppContext;
    /**
    * 小程序信息
    */
    protected MiniAppInfo mMiniAppInfo;
    /**
    * 小程序包信息
    */
    protected ApkgInfo mApkgInfo;
    
    联系我们

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

    技术支持

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

    7x24 电话支持