终端能力
获取设备信息
AsyncStorage
- 方法
BackAndroid
- 方法
callNative/callNativeWithPromise
Clipboard
- 方法
  - getString()
  - setString(content)
Cookie
- 方法
  - getAll(url)
  - set(url, keyValue, expireDate)
ImageLoaderModule
- 方法
  - ImageLoaderModule.getSize
  - ImageLoaderModule.prefetch
measureInWindow
measureInAppWindow
NetInfo
- 网络状态
- 方法
parseColor

终端能力

hippy-vue 通过在 Vue 上绑定了一个 Native 属性，实现获取终端设备信息、以及调用终端模块。也可以用来监测是否在 Hippy 环境下运行。

对应 Demo: demo-vue-native.vue

获取设备信息

它无需任何方法，直接取值即可。

示例

console.log(Vue.Native.version); // => 2.0.0

Device

获取设备名称，iPhone 可以拿到具体的 iPhone 型号，Android 设备暂时只能拿到 Android device的文本。

示例

console.log(Vue.Native.Platform); // => android

示例

const { window, screen } = Vue.Native.Dimensions;
console.log(`屏幕尺寸：${screen.height}x${screen.width}`); // => 640x480
console.log(`带状态栏的窗口尺寸：${window.height}x${window.width}`); // => 640x460

示例

console.log(Vue.Native.PixelRatio); // => 3

AsyncStorage

最低支持版本 2.7.0
AsyncStorage 能力与挂载在全局变量下的 localStorage 模块一致，localStorage 可以在所有版本使用

[AsyncStorage 范例（与Hippy-React AsyncStorage 一致）]

AsyncStorage 是一个简单的、异步的、持久化的 Key-Value 存储系统。

示例：

Vue.Native.AsyncStorage.setItem('itemKey', 'itemValue');
Vue.Native.AsyncStorage.getItem('itemKey');

方法

AsyncStorage.getAllKeys

() => Promise<string[]> 获取 AsyncStorage 所有的key。

AsyncStorage.getItem

(key: string) => Promise<string> 根据 key 值获取对应数据。

key: string - 需要获取值的目标 key

AsyncStorage.multiGet

(key: string[]) => Promise<[key: string, value: value][]> 一次性用多个 key 值的数组去批量请求缓存数据，返回值将在回调函数以键值对的二维数组形式返回。

key: string[] - 需要获取值的目标 key 数组

AsyncStorage.multiRemove

(key: string[]) => void 调用此函数批量删除 AsyncStorage 里面在传入的 keys 数组存在的 key 值。

key: string[] - 需要删除的目标 key 数组

AsyncStorage.multiSet

(keyValuePairs: [key: string, value: value][]) => void 调用这个函数可以批量存储键值对对象。

keyValuePairs: [key: string, value: value][] - 需要设置的储键值二维数组

AsyncStorage.removeItem

(key: string) => void 根据 key 值删除对应数据。

key: string - 需要删除的目标 key

AsyncStorage.setItem

(key: string, value: string) => void 根据 key 和 value 设置保存键值对。

key: string - 需要获取值的目标 key
value: string - 需要获取值的目标值

BackAndroid

[BackAndroid 范例]

可以监听 Android 实体键的回退，在退出前做操作或拦截实体键的回退。

最低支持版本 2.7.0
注意：该方法需要终端拦截实体返回按钮的事件，可以参考 android-demo 的 onBackPressed 方法

(handler: () => boolean) => { remove: Function } 监听Android实体健回退，触发时执行 handler 回调函数。回调函数返回 true 时，拦截终端的回退操作；回调函数返回 false 时, 就不会拦截回退。该方法会返回包含 remove() 方法的对象，可通过调用 remove() 方法移除监听，同 BackAndroid.removeListener。

handler: Function - 实体键回退时触发的回调函数

BackAndroid.exitApp

() => void直接执行终端的退出 App 逻辑。

BackAndroid.removeListener

(handler: () => boolean) => void 移除 BackAndroid 关于Android实体健回退事件的监听器。

handler: Function - 建议使用 addListener 返回的包含 remove() 方法的对象，也可以是之前 BackAndroid 的回调函数。

callNative/callNativeWithPromise

调用终端模块的方法，callNative 一般用于无返回的模块方法调用，callNativeWithPromise 一般用于有返回的模块方法调用，它会返回一个带着结果的 Promise。

Clipboard

剪贴板读写模块，但是目前只支持纯文本。

方法

getString()

返回值：

string

setString(content)

参数	类型	必需	参数意义
content	string	是	保存进入剪贴板的内容

Cookie

Hippy 中通过 fetch 服务返回的 set-cookie Header 会自动将 Cookie 保存起来，下次再发出请求的时候就会带上，然后终端提供了这个界面让业务可以获取或者修改保存好的 Cookie。

方法

getAll(url)

参数	类型	必需	参数意义
url	string	是	获取指定 URL 下设置的 cookie

返回值：

Prmoise<string>，类似 name=someone;gender=female 的字符串，需要业务自己手工解析一下。

set(url, keyValue, expireDate)

参数：

参数	类型	必需	参数意义
url	string	是	设置指定 URL 下设置的 cookie
keyValue	string	是	需要设置成 Cookie 的完整字符串，例如`name=someone;gender=female`
expireDate	Date	否	Date 类型的过期时间，不填不过期

ImageLoaderModule

通过该模块可以对远程图片进行相应操作

最低支持版本 2.7.0

方法

ImageLoaderModule.getSize

(url: string) => Promise<{width, height}> 获取图片大小（会同时预加载图片）。

url - 图片地址

ImageLoaderModule.prefetch

(url: string) => void 用于预加载图片。

url - 图片地址

measureInWindow

Deprecated.
iOS 仅可以获取 Hippy 容器的布局, 所以建议统一采用 measureInAppWindow 方法。

测量可视范围内某个组件的尺寸和位置，如果出错会都是 -1。

measureInAppWindow

测量在 App 可视范围内某个组件的尺寸和位置，如果出错 callback 参数可能为字符串或者 -1

NetInfo

通过该接口可以获得当前设备的网络状态，也可以注册一个监听器，当系统网络切换的时候，得到一个通知。

最低支持版本 2.7.0

安卓的开发者，在请求网络状态之前，你需要在app的 AndroidManifest.xml 加入以下配置 :

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

网络状态

以异步的方式判断设备是否联网，以及是否使用了移动数据网络。

NONE - 设备处于离线状态。
WIFI - 设备通过wifi联网
CELL - 设备通过移动网络联网
UNKNOWN - 出现异常或联网状态不可知

方法

NetInfo.addEventListener

(eventName: string, handler: Function) => NetInfoRevoker 添加一个网络变化监听器。

eventName: ‘change’ - 事件名称
handler: ({ network_info:string }) => any - 网络发生变化时触发的回调函数

NetInfo.fetch

() => Promise<NetInfo> 用于获取当前的网络状态。

NetInfo.removeEventListener

(eventName: string, handler: NetInfoRevoker | Function) => void 移除事件监听器

eventName: ‘change’ - 事件名称
handler: Function - 需要删除的对应事件监听。

parseColor

色值类型转换，通过该 API 获取终端可识别的 int32 类型色值。可应用于与终端直接通讯（如 callNative) 时的接口传参。

参数	类型	必需	参数意义
color	`string` `number`	是	转换的色值，支持类型：`rgb`,`rgba`, `hex`

返回值：

number: 返回值为终端可识别的 int32Color

示例：

const int32Color = Vue.Native.parseColor('#40b883') // int32Color: 4282431619