小程序API能力集成指南——设备API汇总（四）

剪切板 API

ty.setClipboardData

设置系统剪贴板的内容

需引入BaseKit，且在>=1.2.10版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
data	string		是	剪贴板的内容
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 设置系统剪贴板的内容
 */
export function setClipboardData(params: {
  /** 剪贴板的内容 */
  data: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.getClipboardData

获取系统剪贴板的内容

需引入BaseKit，且在>=1.2.10版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
data	string	剪贴板的内容

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

函数定义示例

/**
 * 获取系统剪贴板的内容
 */
export function getClipboardData(params?: {
  complete?: () => void;
  success?: (params: {
    /** 剪贴板的内容 */
    data: string;
  }) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

陀螺仪 API

ty.startGyroscope

开始监听陀螺仪数据。

需引入BaseKit，且在>=2.3.2版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
interval	GyroscopeInterval		否	监听陀螺仪数据回调函数的执行频率
complete	function		否	接口调用完成的回调函数（成功失败都会调用）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 开始监听陀螺仪数据。
 */
export function startGyroscope(params?: {
  /** 监听陀螺仪数据回调函数的执行频率 */
  interval?: GyroscopeInterval;
  complete?: () => void;
  success?: (params: null) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.stopGyroscope

停止监听陀螺仪数据。

需引入BaseKit，且在>=2.3.2版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 停止监听陀螺仪数据。
 */
export function stopGyroscope(params?: {
  complete?: () => void;
  success?: (params: null) => void;
  failure?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

 👉 立即开发。

ty.onGyroscopeChange

监听陀螺仪数据变化事件

需引入BaseKit，且在>=2.3.2版本才可使用

参数

function callback

监听陀螺仪数据变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
x	number		是	X 轴
y	number		是	Y 轴
z	number		是	Z 轴

函数定义示例

/**
 * 监听陀螺仪数据变化事件
 */
export function onGyroscopeChange(
  listener: (params: {
    /** X 轴 */
    x: number;
    /** Y 轴 */
    y: number;
    /** Z 轴 */
    z: number;
  }) => void,
): void;

ty.offGyroscopeChange

取消监听陀螺仪数据变化事件。

需引入BaseKit，且在>=2.3.2版本才可使用

参数

function callback

取消监听陀螺仪数据变化事件的回调函数。

回调参数 Object res

属性	类型	默认值	必填	说明
x	number		是	X 轴
y	number		是	Y 轴
z	number		是	Z 轴

函数定义示例

/**
 * 取消监听陀螺仪数据变化事件。
 */
export function offGyroscopeChange(
  listener: (params: {
    /** X 轴 */
    x: number;
    /** Y 轴 */
    y: number;
    /** Z 轴 */
    z: number;
  }) => void,
): void;

内存 API

ty.onMemoryWarning

监听内存不足告警事件。

当 iOS/Android 向小程序进程发出内存警告时，触发该事件。触发该事件不意味小程序被杀，大部分情况下仅仅是告警，开发者可在收到通知后回收一些不必要资源避免进一步加剧内存紧张。

需引入BaseKit，且在>=2.3.2版本才可使用

参数

function callback

监听内存不足告警事件的回调函数。

回调参数 Object res

属性	类型	默认值	必填	说明
level	number		是	内存告警等级，只有 Android 才有，对应系统宏定义

函数定义示例

/**
 * 监听内存不足告警事件。
 *当 iOS/Android 向小程序进程发出内存警告时，触发该事件。触发该事件不意味小程序被杀，大部分情况下仅仅是告警，开发者可在收到通知后回收一些不必要资源避免进一步加剧内存紧张。
 */
export function onMemoryWarning(
  listener: (params: {
    /** 内存告警等级，只有 Android 才有，对应系统宏定义 */
    level: number;
  }) => void,
): void;

ty.offMemoryWarning

取消监听内存不足告警事件。

需引入BaseKit，且在>=2.3.2版本才可使用

参数

function callback

取消监听内存不足告警事件的回调函数。

回调参数 Object res

属性	类型	默认值	必填	说明
level	number		是	内存告警等级，只有 Android 才有，对应系统宏定义

函数定义示例

/**
 * 取消监听内存不足告警事件。
 */
export function offMemoryWarning(
  listener: (params: {
    /** 内存告警等级，只有 Android 才有，对应系统宏定义 */
    level: number;
  }) => void,
): void;

 👉 立即开发。