公共事件模块

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

导入模块

import CommonEvent from '@ohos.commonEvent';
`HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿`

Support

CommonEvent模块支持的事件类型。名称指的是系统公共事件宏；值指的是系统公共事件。

系统能力： SystemCapability.Notification.CommonEvent

CommonEvent.publish

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

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

系统能力： SystemCapability.Notification.CommonEvent

参数：

示例：

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

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

CommonEvent.publish

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

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

系统能力： SystemCapability.Notification.CommonEvent

参数：

示例：

//公共事件相关信息
var 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.publishAsUser8+

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

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

系统能力： SystemCapability.Notification.CommonEvent

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

参数：

示例：

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

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

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

CommonEvent.publishAsUser8+

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

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

系统能力： SystemCapability.Notification.CommonEvent

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

参数：

示例：

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

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

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

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

CommonEvent.createSubscriber

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

创建订阅者（callback形式）。

系统能力： SystemCapability.Notification.CommonEvent

参数：

示例：

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

//订阅者信息
var 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

createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise

创建订阅者（Promise形式）。

系统能力： SystemCapability.Notification.CommonEvent

参数：

返回值：

示例：

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

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

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

CommonEvent.subscribe

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

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

系统能力： SystemCapability.Notification.CommonEvent

参数：

示例：

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

//订阅者信息
var 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

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

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

系统能力： SystemCapability.Notification.CommonEvent

参数：

示例：

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

//订阅者信息
var 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): void

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

返回值：

示例：

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

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

getData

getData(callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

返回值：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

返回值：

示例：

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

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

isOrderedCommonEvent

isOrderedCommonEvent(callback: AsyncCallback): void

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

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

var 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

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

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

系统能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

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

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

isStickyCommonEvent

isStickyCommonEvent(callback: AsyncCallback): void

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

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

var 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

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

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

系统能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

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

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

abortCommonEvent

abortCommonEvent(): Promise

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

系统能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

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

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

clearAbortCommonEvent

clearAbortCommonEvent(callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

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

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

clearAbortCommonEvent

clearAbortCommonEvent(): Promise

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

系统能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

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

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

getAbortCommonEvent

getAbortCommonEvent(callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

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

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

getSubscribeInfo

getSubscribeInfo(callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

var 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

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

系统能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

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

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

finishCommonEvent9+

finishCommonEvent(callback: AsyncCallback): void

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

系统能力 ：SystemCapability.Notification.CommonEvent

参数：

示例：

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

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

finishCommonEvent9+

finishCommonEvent(): Promise

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

系统能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

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

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

CommonEventData

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

CommonEventPublishData

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

CommonEventSubscribeInfo

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

审核编辑 黄宇