接口 YmxCore

Core

interface YmxCore {
    inApp: boolean;
    isAndroid: boolean;
    isHarmony: boolean;
    isIos: boolean;
    isWeb: boolean;
    sdkVersionCode: number;
    sdkVersionName: string;
    versionCode: number;
    versionName: string;
    requirePlugin(pluginId: string): object;
}

层级 (查看层级一览)

YmxCore
- Ymx

索引

属性

inApp isAndroid isHarmony isIos isWeb sdkVersionCode sdkVersionName versionCode versionName

方法

属性

`只读`inApp

inApp: boolean

是否运行在 APP 环境中

`只读`isAndroid

isAndroid: boolean

是否运行在 Android APP 环境中

`只读`isHarmony

isHarmony: boolean

是否运行在 HarmonyOS APP 环境中

`只读`isIos

isIos: boolean

是否运行在 iOS APP 环境中

`只读`isWeb

isWeb: boolean

是否运行在浏览器环境中

`只读`sdkVersionCode

sdkVersionCode: number

基础库版本号，如 260520

`只读`sdkVersionName

sdkVersionName: string

基础库版本名，如 1.2605.20

`只读`versionCode

versionCode: number

APP 版本号，如 123

`只读`versionName

versionName: string

APP 版本名，如 1.2.3

方法

requirePlugin

requirePlugin(pluginId: string): object
构建插件 js API 接口实例

此接口返回 object 类型，为获得接口类型验证和智能提示，请按如下操作：
- 安装插件的 TypeScript 接口类型定义包，以 ymx-wechat 插件为例
```
npm install --save-dev @ymxjs/ymx-wechat
```
- 将 requirePlugin 返回值强制转换为插件的对应类型 YmxWechat
```
const wechat = ymx.requirePlugin('ymx-wechat') as YmxWechat;
// 至此，调用 wechat 下的接口即可获得开发环境类型验证和智能提示
// wechat.login...
```
参数
- pluginId: string
  插件 ID
返回 object
- 定义于 core.d.ts:1890