@ohos.commonEvent (公共事件模块)

本模块提供了公共事件的能力，包括公共事件的权限列表，发布公共事件，订阅或取消订阅公共事件，获取或修改公共事件结果代码、结果数据等。

说明：

从API Version 9开始，该接口不再维护，推荐使用新接口@ohos.commonEventManager。

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import CommonEvent from '@ohos.commonEvent';

Support

系统公共事件是指由系统服务或系统应用发布的事件，订阅这些系统公共事件需要特定的权限。发布或订阅这些事件需要使用如下链接中的枚举定义。

全部系统公共事件枚举定义请参见系统公共事件定义。

CommonEvent.publish^(deprecated)

publish(event: string, callback: AsyncCallback<void>): void

发布公共事件（callback形式）。

说明： 从 API version 7开始支持，从API version 9开始废弃。建议使用commonEventManager.publish替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

名称	类型	必填	说明
event	string	是	表示要发送的公共事件。
callback	AsyncCallback<void>	是	表示被指定的回调方法。

示例：

//发布公共事件回调
function publishCallBack(err) {
	if (err.code) {
        console.error("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish");
    }
}

//发布公共事件
CommonEvent.publish("event", publishCallBack);

CommonEvent.publish^(deprecated)

publish(event: string, options: CommonEventPublishData, callback: AsyncCallback<void>): void

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

说明： 从 API version 7开始支持，从API version 9开始废弃。建议使用commonEventManager.publish替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

名称	类型	必填	说明
event	string	是	表示要发布的公共事件。
options	CommonEventPublishData	是	表示发布公共事件的属性。
callback	AsyncCallback<void>	是	表示被指定的回调方法。

示例：

//公共事件相关信息
let options = {
	code: 0,			 //公共事件的初始代码
	data: "initial data",//公共事件的初始数据
	isOrdered: true	 //有序公共事件
}

//发布公共事件回调
function publishCallBack(err) {
	if (err.code) {
        console.error("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish");
    }
}

//发布公共事件
CommonEvent.publish("event", options, publishCallBack);

CommonEvent.publishAsUser^(deprecated)

publishAsUser(event: string, userId: number, callback: AsyncCallback<void>): void

向指定用户发布公共事件（callback形式）。

说明： 从 API version 8开始支持，从API version 9开始废弃。建议使用commonEventManager.publishAsUser替代。

系统能力： SystemCapability.Notification.CommonEvent

系统API：此接口为系统接口，三方应用不支持调用。

参数：

名称	类型	必填	说明
event	string	是	表示要发送的公共事件。
userId	number	是	表示指定向该用户ID发送此公共事件。
callback	AsyncCallback<void>	是	表示被指定的回调方法。

示例：

//发布公共事件回调
function publishAsUserCallBack(err) {
	if (err.code) {
        console.error("publishAsUser failed " + JSON.stringify(err));
    } else {
        console.info("publishAsUser");
    }
}

//指定发送的用户
let userId = 100;

//发布公共事件
CommonEvent.publishAsUser("event", userId, publishAsUserCallBack);

CommonEvent.publishAsUser^(deprecated)

publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback<void>): void

向指定用户发布公共事件并指定发布信息（callback形式）。

说明： 从 API version 8开始支持，从API version 9开始废弃。建议使用commonEventManager.publishAsUser替代。

系统能力： SystemCapability.Notification.CommonEvent

系统API：此接口为系统接口，三方应用不支持调用。

参数：

名称	类型	必填	说明
event	string	是	表示要发布的公共事件。
userId	number	是	表示指定向该用户ID发送此公共事件。
options	CommonEventPublishData	是	表示发布公共事件的属性。
callback	AsyncCallback<void>	是	表示被指定的回调方法。

示例：

//公共事件相关信息
let options = {
	code: 0,			 //公共事件的初始代码
	data: "initial data",//公共事件的初始数据
}

//发布公共事件回调
function publishAsUserCallBack(err) {
	if (err.code) {
        console.error("publishAsUser failed " + JSON.stringify(err));
    } else {
        console.info("publishAsUser");
    }
}

//指定发送的用户
let userId = 100;

//发布公共事件
CommonEvent.publishAsUser("event", userId, options, publishAsUserCallBack);

CommonEvent.createSubscriber^(deprecated)

createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback): void

创建订阅者（callback形式）。

说明： 从 API version 7开始支持，从API version 9开始废弃。建议使用commonEventManager.createSubscriber替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

名称	类型	必填	说明
subscribeInfo	CommonEventSubscribeInfo	是	表示订阅信息。
callback	AsyncCallback<CommonEventSubscriber>	是	表示创建订阅者的回调方法。

示例：

let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作

//订阅者信息
let subscribeInfo = {
	events: ["event"]
};

//创建订阅者回调
function createSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.error("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
    }
}

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

CommonEvent.createSubscriber^(deprecated)

createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise

创建订阅者（Promise形式）。

说明： 从 API version 7开始支持，从API version 9开始废弃。建议使用commonEventManager.createSubscriber替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

名称	类型	必填	说明
subscribeInfo	CommonEventSubscribeInfo	是	表示订阅信息。

返回值：

类型	说明
Promise<CommonEventSubscriber>	返回订阅者对象。

示例：

let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作

//订阅者信息
let subscribeInfo = {
	events: ["event"]
};

//创建订阅者
CommonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber) => {
    console.info("createSubscriber");
    subscriber = commonEventSubscriber;
}).catch((err) => {
    console.error("createSubscriber failed " + JSON.stringify(err));
});

subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void

订阅公共事件（callback形式）。

说明： 从 API version 7开始支持，从API version 9开始废弃。建议使用commonEventManager.subscribe替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

名称	类型	必填	说明
subscriber	CommonEventSubscriber	是	表示订阅者对象。
callback	AsyncCallback<CommonEventData>	是	表示接收公共事件数据的回调函数。

示例：

let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作

//订阅者信息
let subscribeInfo = {
    events: ["event"]
};

//订阅公共事件回调
function subscribeCallBack(err, data) {
    if (err.code) {
        console.error("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribe " + JSON.stringify(data));
    }
}

//创建订阅者回调
function createSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.error("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
        //订阅公共事件
        CommonEvent.subscribe(subscriber, subscribeCallBack);
    }
}

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

CommonEvent.unsubscribe^(deprecated)

unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback<void>): void

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

说明： 从 API version 7开始支持，从API version 9开始废弃。建议使用commonEventManager.subscribe替代。

系统能力： SystemCapability.Notification.CommonEvent

参数：

名称	类型	必填	说明
subscriber	CommonEventSubscriber	是	表示订阅者对象。
callback	AsyncCallback<void>	否	表示取消订阅的回调方法。

示例：

let subscriber;	//用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作

//订阅者信息
let subscribeInfo = {
	events: ["event"]
};

//订阅公共事件回调
function subscribeCallBack(err, data) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribe " + JSON.stringify(data));
    }
}

//创建订阅者回调
function createSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.info("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
        //订阅公共事件
        CommonEvent.subscribe(subscriber, subscribeCallBack);
    }
}

//取消订阅公共事件回调
function unsubscribeCallBack(err) {
	if (err.code) {
        console.info("unsubscribe failed " + JSON.stringify(err));
    } else {
        console.info("unsubscribe");
    }
}

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

//取消订阅公共事件
CommonEvent.unsubscribe(subscriber, unsubscribeCallBack);

CommonEventSubscriber

getCode

getCode(callback: AsyncCallback<number>): void

获取公共事件的结果代码（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
callback	AsyncCallback<number>	是	公共事件的结果代码。

示例：

let subscriber;	//创建成功的订阅者对象

//获取有序公共事件的结果代码回调
function getCodeCallback(err, Code) {
    if (err.code) {
        console.error("getCode failed " + JSON.stringify(err));
    } else {
        console.info("getCode " + JSON.stringify(Code));
    }
}
subscriber.getCode(getCodeCallback);

getCode

getCode(): Promise<number>

获取公共事件的结果代码（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型	说明
Promise<number>	公共事件的结果代码。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.getCode().then((Code) => {
    console.info("getCode " + JSON.stringify(Code));
}).catch((err) => {
    console.error("getCode failed " + JSON.stringify(err));
});

setCode

setCode(code: number, callback: AsyncCallback<void>): void

设置公共事件的结果代码（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
code	number	是	公共事件的结果代码。
callback	AsyncCallback<void>	是	表示被指定的回调方法。

示例：

let subscriber;	//创建成功的订阅者对象

//设置有序公共事件的结果代码回调
function setCodeCallback(err) {
    if (err.code) {
        console.error("setCode failed " + JSON.stringify(err));
    } else {
        console.info("setCode");
    }
}
subscriber.setCode(1, setCodeCallback);

setCode

setCode(code: number): Promise<void>

设置公共事件的结果代码（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
code	number	是	公共事件的结果代码。

返回值：

类型	说明
Promise<void>	返回一个Promise的结果。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.setCode(1).then(() => {
    console.info("setCode");
}).catch((err) => {
    console.error("setCode failed " + JSON.stringify(err));
});

getData

getData(callback: AsyncCallback<string>): void

获取公共事件的结果数据（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
callback	AsyncCallback<string>	是	公共事件的结果数据。

示例：

let subscriber;	//创建成功的订阅者对象

//获取有序公共事件的结果数据回调
function getDataCallback(err, Data) {
    if (err.code) {
        console.error("getData failed " + JSON.stringify(err));
    } else {
        console.info("getData " + JSON.stringify(Data));
    }
}
subscriber.getData(getDataCallback);

getData

getData(): Promise<string>

获取公共事件的结果数据（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型	说明
Promise<string>	公共事件的结果数据。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.getData().then((Data) => {
    console.info("getData " + JSON.stringify(Data));
}).catch((err) => {
    console.error("getData failed " + JSON.stringify(err));
});

setData

setData(data: string, callback: AsyncCallback<void>): void

设置公共事件的结果数据（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
data	string	是	公共事件的结果数据。
callback	AsyncCallback<void>	是	表示被指定的回调方法。

示例：

let subscriber;	//创建成功的订阅者对象

//设置有序公共事件的结果数据回调
function setDataCallback(err) {
    if (err.code) {
        console.error("setData failed " + JSON.stringify(err));
    } else {
        console.info("setData");
    }
}
subscriber.setData("publish_data_changed", setDataCallback);

setData

setData(data: string): Promise<void>

设置公共事件的结果数据（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
data	string	是	公共事件的结果数据。

返回值：

类型	说明
Promise<void>	返回一个Promise的结果。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.setData("publish_data_changed").then(() => {
    console.info("setData");
}).catch((err) => {
    console.error("setData failed " + JSON.stringify(err));
});

setCodeAndData

setCodeAndData(code: number, data: string, callback:AsyncCallback<void>): void

设置公共事件的结果代码和结果数据（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
code	number	是	公共事件的结果代码。
data	string	是	公共事件的结果数据。
callback	AsyncCallback<void>	是	表示被指定的回调方法。

示例：

let subscriber;	//创建成功的订阅者对象

//设置有序公共事件的结果代码和结果数据回调
function setCodeDataCallback(err) {
    if (err.code) {
        console.error("setCodeAndData failed " + JSON.stringify(err));
    } else {
        console.info("setCodeDataCallback");
    }
}
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback);

setCodeAndData

setCodeAndData(code: number, data: string): Promise<void>

设置公共事件的结果代码和结果数据（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
code	number	是	公共事件的结果代码。
data	string	是	公共事件的结果数据。

返回值：

类型	说明
Promise<void>	返回一个Promise的结果。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
    console.info("setCodeAndData");
}).catch((err) => {
    console.info("setCodeAndData failed " + JSON.stringify(err));
});

isOrderedCommonEvent

isOrderedCommonEvent(callback: AsyncCallback<boolean>): void

查询当前公共事件的是否为有序公共事件（callback形式）。

返回true代表是有序公共事件，false代表不是有序公共事件。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	当前公共事件的是否为有序公共事件。

示例：

let subscriber;	//创建成功的订阅者对象

//获取当前公共事件是否为有序事件的回调
function isOrderedCallback(err, isOrdered) {
    if (err.code) {
        console.error("isOrderedCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("isOrdered " + JSON.stringify(isOrdered));
    }
}
subscriber.isOrderedCommonEvent(isOrderedCallback);

isOrderedCommonEvent

isOrderedCommonEvent(): Promise<boolean>

查询当前公共事件的是否为有序公共事件（Promise形式）。

返回true代表是有序公共事件，false代表不是有序公共事件。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型	说明
Promise<boolean>	当前公共事件的是否为有序公共事件。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.isOrderedCommonEvent().then((isOrdered) => {
    console.info("isOrdered " + JSON.stringify(isOrdered));
}).catch((err) => {
    console.error("isOrdered failed " + JSON.stringify(err));
});

isStickyCommonEvent

isStickyCommonEvent(callback: AsyncCallback<boolean>): void

检查当前公共事件是否为一个粘性事件（callback形式）。

返回true代表是粘性公共事件，false代表不是粘性公共事件。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	当前公共事件的是否为粘性公共事件。

示例：

let subscriber;	//创建成功的订阅者对象

//获取当前公共事件是否为粘性事件的回调
function isStickyCallback(err, isSticky) {
    if (err.code) {
        console.error("isStickyCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("isSticky " + JSON.stringify(isSticky));
    }
}
subscriber.isStickyCommonEvent(isStickyCallback);

isStickyCommonEvent

isStickyCommonEvent(): Promise<boolean>

检查当前公共事件是否为一个粘性事件（Promise形式）。

返回true代表是粘性公共事件，false代表不是粘性公共事件。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型	说明
Promise<boolean>	当前公共事件的是否为粘性公共事件。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.isStickyCommonEvent().then((isSticky) => {
    console.info("isSticky " + JSON.stringify(isSticky));
}).catch((err) => {
    console.error("isSticky failed " + JSON.stringify(err));
});

abortCommonEvent

abortCommonEvent(callback: AsyncCallback<void>): void

取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	取消当前的公共事件。

示例：

let subscriber;	//创建成功的订阅者对象

//取消当前有序公共事件的回调
function abortCallback(err) {
    if (err.code) {
        console.error("abortCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("abortCommonEvent");
    }
}
subscriber.abortCommonEvent(abortCallback);

abortCommonEvent

abortCommonEvent(): Promise<void>

取消当前的公共事件，仅对有序公共事件有效，取消后，公共事件不再向下一个订阅者传递（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型	说明
Promise<void>	返回一个Promise的结果。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.abortCommonEvent().then(() => {
    console.info("abortCommonEvent");
}).catch((err) => {
    console.error("abortCommonEvent failed " + JSON.stringify(err));
});

clearAbortCommonEvent

clearAbortCommonEvent(callback: AsyncCallback<void>): void

清除当前公共事件的取消状态，仅对有序公共事件有效（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	表示被指定的回调方法。

示例：

let subscriber;	//创建成功的订阅者对象

//清除当前公共事件取消状态的回调
function clearAbortCallback(err) {
    if (err.code) {
        console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("clearAbortCommonEvent");
    }
}
subscriber.clearAbortCommonEvent(clearAbortCallback);

clearAbortCommonEvent

clearAbortCommonEvent(): Promise<void>

清除当前公共事件的取消状态，仅对有序公共事件有效（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型	说明
Promise<void>	返回一个Promise的结果。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.clearAbortCommonEvent().then(() => {
    console.info("clearAbortCommonEvent");
}).catch((err) => {
    console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
});

getAbortCommonEvent

getAbortCommonEvent(callback: AsyncCallback<boolean>): void

获取当前有序公共事件是否取消的状态（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	表示当前有序公共事件是否取消的状态。

示例：

let subscriber;	//创建成功的订阅者对象

//获取当前有序公共事件是否取消的回调
function getAbortCallback(err, AbortCommonEvent) {
    if (err.code) {
        console.error("getAbortCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("AbortCommonEvent " + AbortCommonEvent)
    }
}
subscriber.getAbortCommonEvent(getAbortCallback);

getAbortCommonEvent

getAbortCommonEvent(): Promise<boolean>

获取当前有序公共事件是否取消的状态（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型	说明
Promise<boolean>	表示当前有序公共事件是否取消的状态。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.getAbortCommonEvent().then((AbortCommonEvent) => {
    console.info("AbortCommonEvent " + JSON.stringify(AbortCommonEvent));
}).catch((err) => {
    console.error("getAbortCommonEvent failed " + JSON.stringify(err));
});

getSubscribeInfo

getSubscribeInfo(callback: AsyncCallback<CommonEventSubscribeInfo>): void

获取订阅者的订阅信息（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
callback	AsyncCallback<CommonEventSubscribeInfo>	是	表示订阅者的订阅信息。

示例：

let subscriber;	//创建成功的订阅者对象

//获取订阅者信息回调
function getSubscribeInfoCallback(err, SubscribeInfo) {
    if (err.code) {
        console.error("getSubscribeInfo failed " + JSON.stringify(err));
    } else {
        console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
    }
}
subscriber.getSubscribeInfo(getSubscribeInfoCallback);

getSubscribeInfo

getSubscribeInfo(): Promise<CommonEventSubscribeInfo>

获取订阅者的订阅信息（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型	说明
Promise<CommonEventSubscribeInfo>	表示订阅者的订阅信息。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.getSubscribeInfo().then((SubscribeInfo) => {
    console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
}).catch((err) => {
    console.error("getSubscribeInfo failed " + JSON.stringify(err));
});

finishCommonEvent⁹⁺

finishCommonEvent(callback: AsyncCallback<void>): void

结束当前有序公共事件（callback形式）。

系统能力：SystemCapability.Notification.CommonEvent

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	表示有序公共事件结束后的回调函数。

示例：

let subscriber; //创建成功的订阅者对象

//结束当前有序公共事件的回调
function finishCommonEventCallback(err) {
  if (err.code) {
    console.error("finishCommonEvent failed " + JSON.stringify(err));
} else {
    console.info("FinishCommonEvent");
}
}
subscriber.finishCommonEvent(finishCommonEventCallback);

finishCommonEvent⁹⁺

finishCommonEvent(): Promise<void>

结束当前有序公共事件（Promise形式）。

系统能力：SystemCapability.Notification.CommonEvent

返回值：

类型	说明
Promise<void>	返回一个Promise的结果。

示例：

let subscriber;	//创建成功的订阅者对象

subscriber.finishCommonEvent().then(() => {
    console.info("FinishCommonEvent");
}).catch((err) => {
    console.error("finishCommonEvent failed " + JSON.stringify(err));
});

CommonEventData

公共事件数据体。

系统能力： 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent

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

CommonEventPublishData

公共事件发送的数据体，包含公共事件内容和属性。

系统能力： 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent

名称	类型	可读	可写	说明
bundleName	string	是	否	表示包名称。
code	number	是	否	表示公共事件的结果代码。
data	string	是	否	表示公共事件的自定义结果数据。
subscriberPermissions	Array<string>	是	否	表示订阅者的权限。
isOrdered	boolean	是	否	表示是否是有序事件。
isSticky	boolean	是	否	表示是否是粘性事件。仅系统应用或系统服务允许发送粘性事件。
parameters	{[key: string]: any}	是	否	表示公共事件的附加信息。

CommonEventSubscribeInfo

订阅者信息。

系统能力： 以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent

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

@ohos.commonEvent (公共事件模块)

导入模块

Support

CommonEvent.publish(deprecated)

CommonEvent.publish(deprecated)

CommonEvent.publishAsUser(deprecated)

CommonEvent.publishAsUser(deprecated)

CommonEvent.createSubscriber(deprecated)

CommonEvent.createSubscriber(deprecated)

CommonEvent.subscribe(deprecated)

CommonEvent.unsubscribe(deprecated)

CommonEventSubscriber

getCode

getCode

setCode

setCode

getData

getData

setData

setData

setCodeAndData

setCodeAndData

isOrderedCommonEvent

isOrderedCommonEvent

isStickyCommonEvent

isStickyCommonEvent

abortCommonEvent

abortCommonEvent

clearAbortCommonEvent

clearAbortCommonEvent

getAbortCommonEvent

getAbortCommonEvent

getSubscribeInfo

getSubscribeInfo

finishCommonEvent9+

finishCommonEvent9+

CommonEventData

CommonEventPublishData

CommonEventSubscribeInfo

CommonEvent.publish^(deprecated)

CommonEvent.publish^(deprecated)

CommonEvent.publishAsUser^(deprecated)

CommonEvent.publishAsUser^(deprecated)

CommonEvent.createSubscriber^(deprecated)

CommonEvent.createSubscriber^(deprecated)

CommonEvent.subscribe^(deprecated)

CommonEvent.unsubscribe^(deprecated)

finishCommonEvent⁹⁺

finishCommonEvent⁹⁺