CommonEvent模块(JS端SDK接口)

支持设备

权限列表

导入模块

import CommonEvent from '@ohos.commonevent';

CommonEvent.publish(event: string, callback: AsyncCallback)

• 接口说明

  发布公共事件（callback形式）

• publish参数描述

  名称	读写属性	类型	必填	描述
  event	只读	string	是	表示要发送的公共事件
  callback	只读	AsyncCallback	是	表示被指定的回调方法

• 返回值

  void

• 示例

//发布公共事件回调
function PublishCallBack(err) {
	console.info("==========================>PublishCallBack=======================>");
    console.info("==========================>err:=======================>", err.code);
}
//发布公共事件
CommonEvent.publish("publish_event", PublishCallBack);

CommonEvent.publish(event: string, options: CommonEventPublishData, callback: AsyncCallback)

• 接口说明

  发布公共事件指定发布信息（callback形式）

• publish参数描述

  名称	读写属性	类型	必填	描述
  event	只读	string	是	表示要发布的公共事件
  options	只读	CommonEventPublishData	是	表示发布公共事件的属性
  callback	只读	AsyncCallback	是	表示被指定的回调方法

• CommonEventPublishData类型说明

  名称	读写属性	类型	必填	描述
  bundleName	只读	string	否	表示包名称
  code	只读	int	否	表示公共事件的结果代码
  data	只读	string	否	表示公共事件的自定义结果数据
  subscriberPermissions	只读	Array	否	表示订阅者的权限
  isOrdered	只读	bool	否	表示是否是有序事件
  parameters	只读	{[key: string]: any}	否	表示公共事件的附加信息

• 返回值

  void

• 示例

//公共事件相关信息
var options = {
	code: 0;			//公共事件的初始代码
	data: "initial data";//公共事件的初始数据
	isOrdered: true;	//有序公共事件
}
//发布公共事件回调
function PublishCallBack(err) {
	console.info("==========================>PublishCallBack=======================>");
}
//发布公共事件
CommonEvent.publish("publish_event", options, PublishCallBack);

CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback)

• 接口说明

  创建订阅者（callback形式）

• createSubscriber参数描述

  名称	读写属性	类型	必填	描述
  subscribeInfo	只读	CommonEventSubscribeInfo	是	表示订阅信息
  callback	只读	AsyncCallback	是	表示创建订阅者的回调方法

• CommonEventSubscriber 类说明

  名称	参数	返回值	描述
  getCode	callback: AsyncCallback	void	获取公共事件的结果代码（callback形式）
  getCode	void	Promise	获取公共事件的结果代码（Promise形式）
  setCode	code: number, callback: AsyncCallback	void	设置公共事件的结果代码（callback形式）
  setCode	code: number	Promise	设置公共事件的结果代码（Promise形式）
  getData	callback: AsyncCallback	void	获取公共事件的结果数据（callback形式）
  getData	void	Promise	获取公共事件的结果数据（Promise形式）
  setData	data: string, callback: AsyncCallback	void	设置公共事件的结果数据（callback形式）
  setData	data: string	Promise	设置公共事件的结果数据（Promise形式）
  setCodeAndData	code: number, data: string, callback: AsyncCallback	void	设置公共事件的结果代码和结果数据（callback形式）
  setCodeAndData	code: number, data: string	Promise	设置公共事件的结果代码和结果数据（Promise形式）
  isOrderedCommonEvent	callback: AsyncCallback	void	查询当前公共事件的是否为有序公共事件，返回true代表是有序公共事件，false代表不是有序公共事件（callback形式）
  isOrderedCommonEvent	void	Promise	查询当前公共事件的是否为有序公共事件，返回true代表是有序公共事件，false代表不是有序公共事件（Promise形式）
  abortCommonEvent	callback: AsyncCallback	void	取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（callback形式）
  abortCommonEvent	void	Promise	取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（Promise形式）
  clearAbortCommonEvent	callback: AsyncCallback	void	清除当前有序公共事件abort状态（callback形式）
  clearAbortCommonEvent	void	Promise	清除当前有序公共事件abort状态（Promise形式）
  getAbortCommonEvent	callback: AsyncCallback	void	获取当前有序公共事件是否取消的状态（callback形式）
  getAbortCommonEvent	void	Promise	获取当前有序公共事件是否取消的状态Promise形式）
  getSubscribeInfo	callback: AsyncCallback	void	获取订阅者的订阅信息（callback形式）
  getSubscribeInfo	void	Promise	获取订阅者的订阅信息（Promise形式）

• CommonEventSubscribeInfo类型说明

  名称	读写属性	类型	必填	描述
  events	只读	Array	是	表示要订阅的公共事件
  publisherPermission	只读	string	否	表示发布者的权限
  publisherDeviceId	只读	int	否	表示设备ID，该值必须是同一ohos网络上的现有设备ID
  userId	只读	int	否	表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。
  priority	只读	int	否	表示订阅者的优先级，范围为-100~1000。

• 返回值

  void

• 示例

var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
    console.info("==========================>CreateSubscriberCallBack=======================>");
    subscriber = data;
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);

CommonEvent.createSubscriber(subscribeInfo: CommonEventSubscribeInfo)

• 接口说明

  创建订阅者（Promise形式）

• createSubscriber参数描述

  名称	读写属性	类型	必填	描述
  subscribeInfo	只读	CommonEventSubscribeInfo	是	表示订阅信息

• CommonEventSubscribeInfo类型说明

  名称	读写属性	类型	必填	描述
  events	只读	Array	是	表示要发送的公共事件
  publisherPermission	只读	string	否	表示发布者的权限
  publisherDeviceId	只读	int	否	表示设备ID，该值必须是同一ohos网络上的现有设备ID
  userId	只读	int	否	表示用户ID。此参数是可选的，默认值当前用户的ID。如果指定了此参数，则该值必须是系统中现有的用户ID。
  priority	只读	int	否	表示订阅者的优先级。值的范围是-100到1000

• 返回值

  Promise

• 示例

var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo).then((data) => {
	console.info("==========================>createSubscriberPromise=======================>");
    subscriber = data;
});

CommonEvent.subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback)

• 接口说明

  订阅公共事件（callback形式）

• subscribe参数描述

  名称	读写属性	类型	必填	描述
  subscriber	只读	CommonEventSubscriber	是	表示订阅者对象
  callback	只读	AsyncCallback	是	表示接收公共事件数据的回调函数

• CommonEventData类型说明

  名称	读写属性	类型	必填	描述
  event	只读	string	是	表示当前接收的公共事件名称
  bundleName	只读	string	否	表示包名称
  code	只读	int	否	表示公共事件的结果代码，用于传递int类型的数据
  data	只读	string	否	表示公共事件的自定义结果数据，用于传递string 类型的数据
  parameters	只读	{[key: string]: any}	否	表示公共事件的附加信息

• 返回值

  void

• 示例

  • 无序事件：

    var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
    //订阅者信息
    var subscribeInfo = {
    	events: ["event"]
    };
    //订阅公共事件回调
    function SubscribeCallBack(err, data) {
        console.info("==========================>SubscribeCallBack=======================>");
    }
    //创建订阅者回调
    function CreateSubscriberCallBack(err, data) {
    	console.info("==========================>CreateSubscriberCallBack=======================>");
    	subscriber = data;
    	//订阅公共事件
    	CommonEvent.subscribe(subscriber, SubscribeCallBack);
    }
    //创建订阅者
    CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);

  • 有序事件

  var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 //订阅者信息 var subscribeInfo = { events: ["event"] };

  //设置有序公共事件的结果代码回调 function SetCodeCallBack(err) { console.info("==========================>SetCodeCallBack=======================>"); } //设置有序公共事件的结果数据回调 function SetDataCallBack(err) { console.info("==========================>SetDataCallBack=======================>"); } //完成本次有序公共事件处理回调 function FinishCommonEventCallBack(err) { console.info("==========================>FinishCommonEventCallBack=======================>"); } //订阅公共事件回调 function SubscribeCallBack(err, data) { console.info("==========================>SubscribeCallBack=======================>"); //设置有序公共事件的结果代码 subscriber.setCode(0, SetCodeCallBack); //设置有序公共事件的结果数据 subscriber.setData("publish_data_changed", SetDataCallBack); //完成本次有序公共事件处理 subscriber.finishCommonEvent(FinishCommonEventCallBack) }

  //创建订阅者回调 function CreateSubscriberCallBack(err, data) { console.info("==========================>CreateSubscriberCallBack=======================>"); subscriber = data; //订阅公共事件 CommonEvent.subscribe(subscriber, SubscribeCallBack); }

  //创建订阅者 CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);

CommonEvent.unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback)

• 接口说明

  取消订阅公共事件（callback形式）

• unsubscribe参数描述

  名称	读写属性	类型	必填	描述
  subscriber	只读	CommonEventSubscriber	是	表示订阅者对象
  callback	只读	AsyncCallback	是	表示取消订阅的回调方法

• 返回值

  void

• 示例

var subscriber;	//用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
	events: ["event"]
};
//订阅公共事件回调
function SubscribeCallBack(err, data) {
	console.info("==========================>SubscribeCallBack=======================>");
}
//创建订阅者回调
function CreateSubscriberCallBack(err, data) {
	console.info("==========================>CreateSubscriberCallBack=======================>");
	subscriber = data;
	//订阅公共事件
	CommonEvent.subscribe(subscriber, SubscribeCallBack);
}
//取消订阅公共事件回调
function UnsubscribeCallBack(err) {
	console.info("==========================>UnsubscribeCallBack=======================>");
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);
//取消订阅公共事件
CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);