diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 0a40190293d8d5d88864b118c96be99eea6edde2..61ad63f47a5a890ba32c81e4b2d92f222d3555ac 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -125,7 +125,11 @@ - [@ohos.notification (Notification模块)(待停用)](js-apis-notification.md) - application - [EventHub](js-apis-inner-application-eventHub.md) - + - commonEvent + - [CommonEventData](js-apis-inner-commonEvent-commonEventData.md) + - [CommonEventPublishData](js-apis-inner-commonEvent-commonEventPublishData.md) + - [CommonEventSubscriber](js-apis-inner-commonEvent-commonEventSubscriber.md) + - [CommonEventSubscribeInfo](js-apis-inner-commonEvent-commonEventSubscribeInfo.md) - 包管理 - [@ohos.bundle.appControl (appControl模块)](js-apis-appControl.md) - [@ohos.bundle.bundleManager (bundleManager模块)](js-apis-bundleManager.md) diff --git a/zh-cn/application-dev/reference/apis/commonEvent-definitions.md b/zh-cn/application-dev/reference/apis/commonEvent-definitions.md index 6de84fd8a843d2506b05d6df87dfc242d4c3190c..576f230600fe6d6d3e0c9809195009b436a31171 100644 --- a/zh-cn/application-dev/reference/apis/commonEvent-definitions.md +++ b/zh-cn/application-dev/reference/apis/commonEvent-definitions.md @@ -903,3 +903,7 @@ - 值:usual.event.QUICK_FIX_APPLY_RESULT - 订阅者所需权限:无 +## COMMON_EVENT_USER_INFO_UPDATED9+ +表示用户信息已更新。 +- 值:usual.event.USER_INFO_UPDATED +- 订阅者所需权限:无 diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md index 6bb571dc95c24ed6e728b5006cd4b3d33281e8a6..e7205cb1ae17fb98b594a0b8ede1f01c11b50936 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md @@ -67,7 +67,7 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback< | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------- | | event | string | 是 | 表示要发布的公共事件。 | -| options | [CommonEventPublishData](#commoneventpublishdata) | 是 | 表示发布公共事件的属性。 | +| options | [CommonEventPublishData](./js-apis-inner-commonEvent-commonEventPublishData.md) | 是 | 表示发布公共事件的属性。 | | callback | syncCallback\ | 是 | 表示被指定的回调方法。 | **示例:** @@ -151,7 +151,7 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca | -------- | ---------------------- | ---- | ---------------------- | | event | string | 是 | 表示要发布的公共事件。 | | userId | number | 是 | 表示指定向该用户ID发送此公共事件。 | -| options | [CommonEventPublishData](#commoneventpublishdata) | 是 | 表示发布公共事件的属性。 | +| options | [CommonEventPublishData](./js-apis-inner-commonEvent-commonEventPublishData.md) | 是 | 表示发布公共事件的属性。 | | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **示例:** @@ -194,8 +194,8 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------------------------------------ | ---- | -------------------------- | -| subscribeInfo | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | 是 | 表示订阅信息。 | -| callback | AsyncCallback\<[CommonEventSubscriber](#commoneventsubscriber)> | 是 | 表示创建订阅者的回调方法。 | +| subscribeInfo | [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 是 | 表示订阅信息。 | +| callback | AsyncCallback\<[CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md)> | 是 | 表示创建订阅者的回调方法。 | **示例:** @@ -236,12 +236,12 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise | 返回订阅者对象。 | +| Promise\<[CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md)> | 返回订阅者对象。 | **示例:** @@ -276,8 +276,8 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback | 是 | 表示接收公共事件数据的回调函数。 | +| subscriber | [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md) | 是 | 表示订阅者对象。 | +| callback | AsyncCallback\<[CommonEventData](./js-apis-inner-commonEvent-commonEventData.md)> | 是 | 表示接收公共事件数据的回调函数。 | **示例:** @@ -327,7 +327,7 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback): | 参数名 | 类型 | 必填 | 说明 | | ---------- | ----------------------------------------------- | ---- | ------------------------ | -| subscriber | [CommonEventSubscriber](#commoneventsubscriber) | 是 | 表示订阅者对象。 | +| subscriber | [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md) | 是 | 表示订阅者对象。 | | callback | AsyncCallback\ | 否 | 表示取消订阅的回调方法。 | **示例:** @@ -375,809 +375,4 @@ CommonEvent.createSubscriber(subscribeInfo, createCB); // 取消订阅公共事件 CommonEvent.unsubscribe(subscriber, unsubscribeCB); -``` - -## CommonEventSubscriber - -### getCode - -```ts -getCode(callback: AsyncCallback): void -``` - -以回调形式获取公共事件代码。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | ------------------ | -| callback | AsyncCallback\ | 是 | 公共事件代码。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 获取有序公共事件的结果代码回调 -function getCodeCB(err, Code) { - if (err.code) { - console.error(`getCode failed, code is ${err.code}`); - } else { - console.info("getCode " + JSON.stringify(Code)); - } -} -subscriber.getCode(getCodeCB); -``` - -### getCode - -```ts -getCode(): Promise -``` - -以Promise形式获取公共事件代码。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 公共事件代码。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.getCode().then((code) => { - console.info("getCode " + JSON.stringify(code)); -}).catch((err) => { - console.error(`getCode failed, code is ${err.code}`); -}); -``` - -### setCode - -```ts -setCode(code: number, callback: AsyncCallback): void -``` - -以回调形式设置公共事件的代码。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ---------------------- | -| code | number | 是 | 公共事件的代码。 | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 设置有序公共事件的结果代码回调 -function setCodeCB(err) { - if (err.code) { - console.error(`setCode failed, code is ${err.code}`); - } else { - console.info("setCode"); - } -} -subscriber.setCode(1, setCodeCB); -``` - -### setCode - -```ts -setCode(code: number): Promise -``` - -以Promise形式设置公共事件的代码。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------ | -| code | number | 是 | 公共事件的代码。 | - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.setCode(1).then(() => { - console.info("setCode"); -}).catch((err) => { - console.error(`setCode failed, code is ${err.code}`); -}); -``` - -### getData - -```ts -getData(callback: AsyncCallback): void -``` - -以回调形式获取公共事件的数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 公共事件的数据。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 获取有序公共事件的结果数据回调 -function getDataCB(err, data) { - if (err.code) { - console.error(`getData failed, code is ${err.code}`); - } else { - console.info("getData " + JSON.stringify(data)); - } -} - -subscriber.getData(getDataCB); -``` - -### getData - -```ts -getData(): Promise -``` - -以Promise形式获取公共事件的数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ---------------- | ------------------ | -| Promise\ | 公共事件的数据。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.getData().then((data) => { - console.info("getData " + JSON.stringify(data)); -}).catch((err) => { - console.error(`getData failed, code is ${err.code}`); -}); -``` - -### setData - -```ts -setData(data: string, callback: AsyncCallback): void -``` - -以回调形式设置公共事件的数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------------- | -| data | string | 是 | 公共事件的数据。 | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 设置有序公共事件的结果数据回调 -function setDataCB(err) { - if (err.code) { - console.error(`sendData failed, code is ${err.code}`); - } else { - console.info("setData"); - } -} -subscriber.setData("publish_data_changed", setDataCB); -``` - -### setData - -```ts -setData(data: string): Promise -``` - -以Promise形式设置公共事件的果数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | -------------------- | -| data | string | 是 | 公共事件的数据。 | - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.setData("publish_data_changed").then(() => { - console.info("setData"); -}).catch((err) => { - console.error(`setData failed, code is ${err.code}`); -}); -``` - -### setCodeAndData - -```ts -setCodeAndData(code: number, data: string, callback:AsyncCallback): void -``` - -以回调形式设置公共事件代码和数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ---------------------- | -| code | number | 是 | 公共事件的代码。 | -| data | string | 是 | 公共事件的数据。 | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 设置有序公共事件的结果代码和结果数据回调 -function setCodeDataCB(err) { - if (err.code) { - console.error(`setCodeAndData failed, code is ${err.code}`); - } else { - console.info("setCodeDataCallback"); - } -} - -subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCB); -``` - -### setCodeAndData - -```ts -setCodeAndData(code: number, data: string): Promise -``` - -以Promise形式设置公共事件的代码和数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | -------------------- | -| code | number | 是 | 公共事件的代码。 | -| data | string | 是 | 公共事件的数据。 | - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.setCodeAndData(1, "publish_data_changed").then(() => { - console.info("setCodeAndData"); -}).catch((err) => { - console.error(`setCodeAndData failed, code is ${err.code}`); -}); -``` - -### isOrderedCommonEvent - -```ts -isOrderedCommonEvent(callback: AsyncCallback): void -``` - -以回调形式查询当前公共事件的是否为有序公共事件。 - -返回true代表是有序公共事件,false代表不是有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ---------------------------------- | -| callback | AsyncCallback\ | 是 | 当前公共事件的是否为有序公共事件。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 获取当前公共事件是否为有序事件的回调 -function isOrderedCB(err, isOrdered) { - if (err.code) { - console.error(`isOrderedCommonEvent failed, code is ${err.code}`); - } else { - console.info("isOrdered " + JSON.stringify(isOrdered)); - } -} -subscriber.isOrderedCommonEvent(isOrderedCB); -``` - -### isOrderedCommonEvent - -```ts -isOrderedCommonEvent(): Promise -``` - -以Promise形式查询当前公共事件的是否为有序公共事件。 - -返回true代表是有序公共事件,false代表不是有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ----------------- | -------------------------------- | -| Promise\ | 当前公共事件的是否为有序公共事件。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.isOrderedCommonEvent().then((isOrdered) => { - console.info("isOrdered " + JSON.stringify(isOrdered)); -}).catch((err) => { - console.error(`isOrderedCommonEvent failed, code is ${err.code}`); -}); -``` - -### isStickyCommonEvent - -```ts -isStickyCommonEvent(callback: AsyncCallback): void -``` - -以回调形式检查当前公共事件是否为一个粘性事件。 - -返回true代表是粘性公共事件,false代表不是粘性公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ---------------------------------- | -| callback | AsyncCallback\ | 是 | 当前公共事件的是否为粘性公共事件。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 获取当前公共事件是否为粘性事件的回调 -function isStickyCB(err, isSticky) { - if (err.code) { - console.error(`isStickyCommonEvent failed, code is ${err.code}`); - } else { - console.info("isSticky " + JSON.stringify(isSticky)); - } -} -subscriber.isStickyCommonEvent(isStickyCB); -``` - -### isStickyCommonEvent - -```ts -isStickyCommonEvent(): Promise -``` - -以Promise形式检查当前公共事件是否为一个粘性事件。 - -返回true代表是粘性公共事件,false代表不是粘性公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ----------------- | -------------------------------- | -| Promise\ | 当前公共事件的是否为粘性公共事件。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.isStickyCommonEvent().then((isSticky) => { - console.info("isSticky " + JSON.stringify(isSticky)); -}).catch((err) => { - console.error(`isSticky failed, code is ${err.code}`); -}); -``` - -### abortCommonEvent - -```ts -abortCommonEvent(callback: AsyncCallback): void -``` - -以回调形式取消当前的有序公共事件,取消后,有序公共事件不再向下一个订阅者传递。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 取消当前的公共事件。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 取消当前有序公共事件的回调 -function abortCB(err) { - if (err.code) { - console.error(`abortCommonEvent failed, code is ${err.code}`); - } else { - console.info("abortCommonEvent"); - } -} - -subscriber.abortCommonEvent(abortCB); -``` - -### abortCommonEvent - -```ts -abortCommonEvent(): Promise -``` - -以Promise形式取消当前的有序公共事件,取消后,公共事件不再向下一个订阅者传递。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.abortCommonEvent().then(() => { - console.info("abortCommonEvent"); -}).catch((err) => { - console.error(`abortCommonEvent failed, code is ${err.code}`); -}); -``` - -### clearAbortCommonEvent - -```ts -clearAbortCommonEvent(callback: AsyncCallback): void -``` - -以回调形式清除当前有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 清除当前公共事件取消状态的回调 -function clearAbortCB(err) { - if (err.code) { - console.error(`clearAbortCommonEvent failed, code is ${err.code}`); - } else { - console.info("clearAbortCommonEvent"); - } -} - -subscriber.clearAbortCommonEvent(clearAbortCB); -``` - -### clearAbortCommonEvent - -```ts -clearAbortCommonEvent(): Promise -``` - -以Promise形式清除当前有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.clearAbortCommonEvent().then(() => { - console.info("clearAbortCommonEvent"); -}).catch((err) => { - console.error(`clearAbortCommonEvent failed, code is ${err.code}`); -}); -``` - -### getAbortCommonEvent - -```ts -getAbortCommonEvent(callback: AsyncCallback): void -``` - -以回调形式获取当前有序公共事件是否取消的状态。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ---------------------------------- | -| callback | AsyncCallback\ | 是 | 表示当前有序公共事件是否取消的状态。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 获取当前有序公共事件是否取消的回调 -function getAbortCB(err, abortEvent) { - if (err.code) { - console.error(`getAbortCommonEvent failed, code is ${err.code}`); - } else { - console.info("abortEvent " + abortEvent) - } -} - -subscriber.getAbortCommonEvent(getAbortCB); -``` - -### getAbortCommonEvent - -```ts -getAbortCommonEvent(): Promise -``` - -以Promise形式获取当前有序公共事件是否取消的状态。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ----------------- | ---------------------------------- | -| Promise\ | 表示当前有序公共事件是否取消的状态。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.getAbortCommonEvent().then((abortCommonEvent) => { - console.info("abortCommonEvent " + JSON.stringify(abortCommonEvent)); -}).catch((err) => { - console.error(`getAbortCommonEvent failed, code is ${err.code}`); -}); -``` - -### getSubscribeInfo - -```ts -getSubscribeInfo(callback: AsyncCallback): void -``` - -以回调形式获取订阅者的订阅信息。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ---------------------- | -| callback | AsyncCallback\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 是 | 表示订阅者的订阅信息。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 获取订阅者信息回调 -function getCB(err, subscribeInfo) { - if (err.code) { - console.error(`getSubscribeInfo failed, code is ${err.code}`); - } else { - console.info("SubscribeInfo " + JSON.stringify(subscribeInfo)); - } -} - -subscriber.getSubscribeInfo(getCB); -``` - -### getSubscribeInfo - -```ts -getSubscribeInfo(): Promise -``` - -以Promise形式获取订阅者的订阅信息。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ------------------------------------------------------------ | ---------------------- | -| Promise\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 表示订阅者的订阅信息。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.getSubscribeInfo().then((subscribeInfo) => { - console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); -}).catch((err) => { - console.error(`getSubscribeInfo failed, code is ${err.code}`); -}); -``` - -### finishCommonEvent9+ - -```ts -finishCommonEvent(callback: AsyncCallback): void -``` - -以回调形式结束当前有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------------------------- | -| callback | AsyncCallback\ | 是 | 表示有序公共事件结束后的回调函数。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -// 结束当前有序公共事件的回调 -function finishCB(err) { - if (err.code) { - console.error(`finishCommonEvent failed, code is ${err.code}`); - } else { - console.info("FinishCommonEvent"); - } -} - -subscriber.finishCommonEvent(finishCB); -``` - -### finishCommonEvent9+ - -```ts -finishCommonEvent(): Promise -``` - -以Promise形式结束当前有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | - -**示例:** - -```ts -let subscriber; // 创建成功的订阅者对象 - -subscriber.finishCommonEvent().then(() => { - console.info("FinishCommonEvent"); -}).catch((err) => { - console.error(`finishCommonEvent failed, code is ${err.code}`); -}); -``` - -## CommonEventData - -公共事件数据体。 - -**系统能力:** `SystemCapability.Notification.CommonEvent` - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ---------- |-------------------- | ---- | ---- | ------------------------------------------------------- | -| event | string | 是 | 否 | 表示当前接收的公共事件名称。 | -| bundleName | string | 是 | 否 | 表示Bundle名称。 | -| code | number | 是 | 否 | 表示公共事件的结果代码,用于传递int类型的数据。 | -| data | string | 是 | 否 | 表示公共事件的自定义结果数据,用于传递string类型的数据。 | -| parameters | {[key: string]: any} | 是 | 否 | 表示公共事件的附加信息。 | - - -## CommonEventPublishData - -公共事件发送的数据体,包含公共事件内容和属性。 - -**系统能力:** `SystemCapability.Notification.CommonEvent` - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| --------------------- | -------------------- | ---- | ---- | ---------------------------- | -| bundleName | string | 是 | 否 | 表示Bundle名称。 | -| code | number | 是 | 否 | 表示公共事件的结果代码。 | -| data | string | 是 | 否 | 表示公共事件的自定义结果数据。 | -| subscriberPermissions | Array\ | 是 | 否 | 表示订阅者的权限。 | -| isOrdered | boolean | 是 | 否 | 表示是否是有序事件。 | -| isSticky | boolean | 是 | 否 | 表示是否是粘性事件。仅系统应用或系统服务允许发送粘性事件。 | -| parameters | {[key: string]: any} | 是 | 否 | 表示公共事件的附加信息。 | - -## CommonEventSubscribeInfo - -订阅者信息。 - -**系统能力:** `SystemCapability.Notification.CommonEvent` - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ | -| events | Array\ | 是 | 否 | 表示要发送的公共事件。 | -| publisherPermission | string | 是 | 否 | 表示发布者的权限。 | -| publisherDeviceId | string | 是 | 否 | 表示设备ID,该值必须是同一ohos网络上的现有设备ID。 | -| userId | number | 是 | 否 | 表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。 | -| priority | number | 是 | 否 | 表示订阅者的优先级。值的范围是-100到1000。 | \ No newline at end of file +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md index 8873bc0e67a8cd392da2d1c7813c9cf66fafbd26..ca44566e18b198d3bc6da1c889b81145b03b6354 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md @@ -74,7 +74,7 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback< | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | ---------------------- | | event | string | 是 | 表示要发布的公共事件。 | -| options | [CommonEventPublishData](#commoneventpublishdata) | 是 | 表示发布公共事件的属性。 | +| options | [CommonEventPublishData](./js-apis-inner-commonEvent-commonEventPublishData.md) | 是 | 表示发布公共事件的属性。 | | callback | syncCallback\ | 是 | 表示被指定的回调方法。 | **错误码:** @@ -173,7 +173,7 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca | -------- | ---------------------- | ---- | ---------------------- | | event | string | 是 | 表示要发布的公共事件。 | | userId | number | 是 | 表示指定向该用户ID发送此公共事件。 | -| options | [CommonEventPublishData](#commoneventpublishdata) | 是 | 表示发布公共事件的属性。 | +| options | [CommonEventPublishData](./js-apis-inner-commonEvent-commonEventPublishData.md) | 是 | 表示发布公共事件的属性。 | | callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | **错误码:** @@ -224,8 +224,8 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac | 参数名 | 类型 | 必填 | 说明 | | ------------- | ------------------------------------------------------------ | ---- | -------------------------- | -| subscribeInfo | [CommonEventSubscribeInfo](#commoneventsubscribeinfo) | 是 | 表示订阅信息。 | -| callback | AsyncCallback\<[CommonEventSubscriber](#commoneventsubscriber)> | 是 | 表示创建订阅者的回调方法。 | +| subscribeInfo | [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 是 | 表示订阅信息。 | +| callback | AsyncCallback\<[CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md)> | 是 | 表示创建订阅者的回调方法。 | **示例:** @@ -270,12 +270,12 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise | 返回订阅者对象。 | +| Promise\<[CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md)> | 返回订阅者对象。 | **示例:** @@ -311,8 +311,8 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback | 是 | 表示接收公共事件数据的回调函数。 | +| subscriber | [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md) | 是 | 表示订阅者对象。 | +| callback | AsyncCallback\<[CommonEventData](./js-apis-inner-commonEvent-commonEventData.md)> | 是 | 表示接收公共事件数据的回调函数。 | **示例:** @@ -371,7 +371,7 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback): | 参数名 | 类型 | 必填 | 说明 | | ---------- | ----------------------------------------------- | ---- | ------------------------ | -| subscriber | [CommonEventSubscriber](#commoneventsubscriber) | 是 | 表示订阅者对象。 | +| subscriber | [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md) | 是 | 表示订阅者对象。 | | callback | AsyncCallback\ | 否 | 表示取消订阅的回调方法。 | **示例:** @@ -425,794 +425,4 @@ try { } catch (err) { console.error(`unsubscribe failed, code is ${err.code}, message is ${err.message}`); } -``` - -## CommonEventSubscriber - -### getCode - -```ts -getCode(callback: AsyncCallback): void -``` - -以回调形式获取公共事件代码。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | ------------------ | -| callback | AsyncCallback\ | 是 | 公共事件代码。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//获取有序公共事件代码回调 -function getCodeCB(err, code) { - if (err.code) { - console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("getCode " + JSON.stringify(code)); - } -} -subscriber.getCode(getCodeCB); -``` - -### getCode - -```ts -getCode(): Promise -``` - -以Promise形式获取公共事件代码。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 公共事件代码。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.getCode().then((code) => { - console.info("getCode " + JSON.stringify(code)); -}).catch((err) => { - console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### setCode - -```ts -setCode(code: number, callback: AsyncCallback): void -``` - -以回调形式设置公共事件的代码。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ---------------------- | -| code | number | 是 | 公共事件的代码。 | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//设置有序公共事件的代码回调 -function setCodeCB(err) { - if (err.code) { - console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("setCode"); - } -} -subscriber.setCode(1, setCodeCB); -``` - -### setCode - -```ts -setCode(code: number): Promise -``` - -以Promise形式设置公共事件的代码。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------------ | -| code | number | 是 | 公共事件的代码。 | - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.setCode(1).then(() => { - console.info("setCode"); -}).catch((err) => { - console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### getData - -```ts -getData(callback: AsyncCallback): void -``` - -以回调形式获取公共事件的数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 公共事件的数据。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//获取有序公共事件代码数据回调 -function getDataCB(err, data) { - if (err.code) { - console.error(`getData failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("getData " + JSON.stringify(data)); - } -} -subscriber.getData(getDataCB); -``` - -### getData - -```ts -getData(): Promise -``` - -以Promise形式获取公共事件的数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ---------------- | ------------------ | -| Promise\ | 公共事件的数据。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.getData().then((data) => { - console.info("getData " + JSON.stringify(data)); -}).catch((err) => { - console.error(`getData failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### setData - -setData(data: string, callback: AsyncCallback\): void - -以回调形式设置公共事件的数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------------- | -| data | string | 是 | 公共事件的数据。 | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//设置有序公共事件的结果数据回调 -function setDataCB(err) { - if (err.code) { - console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("setData"); - } -} -subscriber.setData("publish_data_changed", setDataCB); -``` - -### setData - -```ts -setData(data: string): Promise -``` - -以Promise形式设置公共事件的果数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | -------------------- | -| data | string | 是 | 公共事件的数据。 | - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.setData("publish_data_changed").then(() => { - console.info("setData"); -}).catch((err) => { - console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### setCodeAndData - -```ts -setCodeAndData(code: number, data: string, callback:AsyncCallback): void -``` - -以回调形式设置公共事件代码和数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | ---------------------- | -| code | number | 是 | 公共事件的代码。 | -| data | string | 是 | 公共事件的数据。 | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//设置有序公共事件的代码和数据回调 -function setCodeDataCB(err) { - if (err.code) { - console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("setCodeDataCallback"); - } -} -subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCB); -``` - -### setCodeAndData - -```ts -setCodeAndData(code: number, data: string): Promise -``` - -以Promise形式设置公共事件的代码和数据。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | -------------------- | -| code | number | 是 | 公共事件的代码。 | -| data | string | 是 | 公共事件的数据。 | - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.setCodeAndData(1, "publish_data_changed").then(() => { - console.info("setCodeAndData"); -}).catch((err) => { - console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### isOrderedCommonEvent - -```ts -isOrderedCommonEvent(callback: AsyncCallback): void -``` - -以回调形式查询当前公共事件的是否为有序公共事件。 - -返回true代表是有序公共事件,false代表不是有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ---------------------------------- | -| callback | AsyncCallback\ | 是 | 当前公共事件的是否为有序公共事件。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//获取当前公共事件是否为有序事件的回调 -function isOrderedCB(err, isOrdered) { - if (err.code) { - console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("isOrdered " + JSON.stringify(isOrdered)); - } -} -subscriber.isOrderedCommonEvent(isOrderedCB); -``` - -### isOrderedCommonEvent - -```ts -isOrderedCommonEvent(): Promise -``` - -以Promise形式查询当前公共事件的是否为有序公共事件。 - -返回true代表是有序公共事件,false代表不是有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ----------------- | -------------------------------- | -| Promise\ | 当前公共事件的是否为有序公共事件。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.isOrderedCommonEvent().then((isOrdered) => { - console.info("isOrdered " + JSON.stringify(isOrdered)); -}).catch((err) => { - console.error(`isOrdered failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### isStickyCommonEvent - -```ts -isStickyCommonEvent(callback: AsyncCallback): void -``` - -以回调形式检查当前公共事件是否为一个粘性事件。 - -返回true代表是粘性公共事件,false代表不是粘性公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ---------------------------------- | -| callback | AsyncCallback\ | 是 | 当前公共事件的是否为粘性公共事件。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//获取当前公共事件是否为粘性事件的回调 -function isStickyCB(err, isSticky) { - if (err.code) { - console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("isSticky " + JSON.stringify(isSticky)); - } -} -subscriber.isStickyCommonEvent(isStickyCB); -``` - -### isStickyCommonEvent - -```ts -isStickyCommonEvent(): Promise -``` - -以Promise形式检查当前公共事件是否为一个粘性事件。 - -返回true代表是粘性公共事件,false代表不是粘性公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ----------------- | -------------------------------- | -| Promise\ | 当前公共事件的是否为粘性公共事件。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.isStickyCommonEvent().then((isSticky) => { - console.info("isSticky " + JSON.stringify(isSticky)); -}).catch((err) => { - console.error(`isSticky failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### abortCommonEvent - -```ts -abortCommonEvent(callback: AsyncCallback): void -``` - -以回调形式取消当前的有序公共事件,取消后,有序公共事件不再向下一个订阅者传递。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 取消当前的有序公共事件。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//取消当前有序公共事件的回调 -function abortCB(err) { - if (err.code) { - console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("abortCommonEvent"); - } -} -subscriber.abortCommonEvent(abortCB); -``` - -### abortCommonEvent - -```ts -abortCommonEvent(): Promise -``` - -以Promise形式取消当前的有序公共事件,取消后,公共事件不再向下一个订阅者传递。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.abortCommonEvent().then(() => { - console.info("abortCommonEvent"); -}).catch((err) => { - console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### clearAbortCommonEvent - -```ts -clearAbortCommonEvent(callback: AsyncCallback): void -``` - -以回调形式清除当前有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//清除当前公共事件取消状态的回调 -function clearAbortCB(err) { - if (err.code) { - console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("clearAbortCommonEvent"); - } -} -subscriber.clearAbortCommonEvent(clearAbortCB); -``` - -### clearAbortCommonEvent - -```ts -clearAbortCommonEvent(): Promise -``` - -以Promise形式清除当前有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.clearAbortCommonEvent().then(() => { - console.info("clearAbortCommonEvent"); -}).catch((err) => { - console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### getAbortCommonEvent - -```ts -getAbortCommonEvent(callback: AsyncCallback): void -``` - -以回调形式获取当前有序公共事件是否取消的状态。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------- | ---- | ---------------------------------- | -| callback | AsyncCallback\ | 是 | 表示当前有序公共事件是否取消的状态。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//获取当前有序公共事件是否取消的回调 -function getAbortCB(err, abortEvent) { - if (err.code) { - console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("abortCommonEvent " + abortEvent) - } -} -subscriber.getAbortCommonEvent(getAbortCB); -``` - -### getAbortCommonEvent - -```ts -getAbortCommonEvent(): Promise -``` - -以Promise形式获取当前有序公共事件是否取消的状态。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ----------------- | ---------------------------------- | -| Promise\ | 表示当前有序公共事件是否取消的状态。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.getAbortCommonEvent().then((abortEvent) => { - console.info("abortCommonEvent " + JSON.stringify(abortEvent)); -}).catch((err) => { - console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### getSubscribeInfo - -```ts -getSubscribeInfo(callback: AsyncCallback): void -``` - -以回调形式获取订阅者的订阅信息。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------------------------------------ | ---- | ---------------------- | -| callback | AsyncCallback\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 是 | 表示订阅者的订阅信息。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//获取订阅者信息回调 -function getCB(err, subscribeInfo) { - if (err.code) { - console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); - } else { - console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); - } -} -subscriber.getSubscribeInfo(getCB); -``` - -### getSubscribeInfo - -```ts -getSubscribeInfo(): Promise -``` - -以Promise形式获取订阅者的订阅信息。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ------------------------------------------------------------ | ---------------------- | -| Promise\<[CommonEventSubscribeInfo](#commoneventsubscribeinfo)> | 表示订阅者的订阅信息。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.getSubscribeInfo().then((subscribeInfo) => { - console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); -}).catch((err) => { - console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -### finishCommonEvent9+ - -```ts -finishCommonEvent(callback: AsyncCallback): void -``` - -以回调形式结束当前有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**参数:** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------- | ---- | -------------------------------- | -| callback | AsyncCallback\ | 是 | 表示有序公共事件结束后的回调函数。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -//结束当前有序公共事件的回调 -function finishCB(err) { - if (err.code) { - console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); -} else { - console.info("FinishCommonEvent"); -} - -subscriber.finishCommonEvent(finishCB); -``` - -### finishCommonEvent9+ - -```ts -finishCommonEvent(): Promise -``` - -以Promise形式结束当前有序公共事件。 - -**系统能力**:`SystemCapability.Notification.CommonEvent` - -**返回值:** - -| 类型 | 说明 | -| ---------------- | -------------------- | -| Promise\ | 返回一个Promise的结果。 | - -**示例:** - -```ts -let subscriber; //创建成功的订阅者对象 - -subscriber.finishCommonEvent().then(() => { - console.info("FinishCommonEvent"); -}).catch((err) => { - console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); -}); -``` - -## 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\ | 是 | 否 | 表示订阅者的权限。 | -| isOrdered | boolean | 是 | 否 | 表示是否是有序事件。 | -| isSticky | boolean | 是 | 否 | 表示是否是粘性事件。仅系统应用或系统服务允许发送粘性事件。 | -| parameters | {[key: string]: any} | 是 | 否 | 表示公共事件的附加信息。 | - -## CommonEventSubscribeInfo - -**系统能力:** `SystemCapability.Notification.CommonEvent` - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ | -| events | Array\ | 是 | 否 | 表示要发送的公共事件。 | -| publisherPermission | string | 是 | 否 | 表示发布者的权限。 | -| publisherDeviceId | string | 是 | 否 | 表示设备ID,该值必须是同一ohos网络上的现有设备ID。 | -| userId | number | 是 | 否 | 表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。 | -| priority | number | 是 | 否 | 表示订阅者的优先级。值的范围是-100到1000。 | \ No newline at end of file +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventData.md new file mode 100644 index 0000000000000000000000000000000000000000..e84f3b4abffbb032a8a79c489a780ad252158737 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventData.md @@ -0,0 +1,11 @@ +# CommonEventData + +**系统能力:** `SystemCapability.Notification.CommonEvent` + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ---------- |-------------------- | ---- | ---- | ------------------------------------------------------- | +| event | string | 是 | 否 | 表示当前接收的公共事件名称。 | +| bundleName | string | 是 | 否 | 表示包名称。 | +| code | number | 是 | 否 | 表示公共事件的结果代码,用于传递int类型的数据。 | +| data | string | 是 | 否 | 表示公共事件的自定义结果数据,用于传递string类型的数据。 | +| parameters | {[key: string]: any} | 是 | 否 | 表示公共事件的附加信息。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventPublishData.md b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventPublishData.md new file mode 100644 index 0000000000000000000000000000000000000000..9d5fe786465e99ce4e85c49310943df600ccb8e6 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventPublishData.md @@ -0,0 +1,13 @@ +# CommonEventPublishData + +**系统能力:** `SystemCapability.Notification.CommonEvent` + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| --------------------- | -------------------- | ---- | ---- | ---------------------------- | +| bundleName | string | 是 | 否 | 表示包名称。 | +| code | number | 是 | 否 | 表示公共事件的结果代码。 | +| data | string | 是 | 否 | 表示公共事件的自定义结果数据。 | +| subscriberPermissions | Array\ | 是 | 否 | 表示订阅者的权限。 | +| isOrdered | boolean | 是 | 否 | 表示是否是有序事件。 | +| isSticky | boolean | 是 | 否 | 表示是否是粘性事件。仅系统应用或系统服务允许发送粘性事件。 | +| parameters | {[key: string]: any} | 是 | 否 | 表示公共事件的附加信息。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscribeInfo.md b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscribeInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..6938b5351b61ab96cf8d87cc78fc3333af21cfa6 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscribeInfo.md @@ -0,0 +1,11 @@ +# CommonEventSubscribeInfo + +**系统能力:** `SystemCapability.Notification.CommonEvent` + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------------- | -------------- | ---- | ---- | ------------------------------------------------------------ | +| events | Array\ | 是 | 否 | 表示要发送的公共事件。 | +| publisherPermission | string | 是 | 否 | 表示发布者的权限。 | +| publisherDeviceId | string | 是 | 否 | 表示设备ID,该值必须是同一ohos网络上的现有设备ID。 | +| userId | number | 是 | 否 | 表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。 | +| priority | number | 是 | 否 | 表示订阅者的优先级。值的范围是-100到1000。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md new file mode 100644 index 0000000000000000000000000000000000000000..411b63e250403b1f5ee916d273f5306c88cda65c --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md @@ -0,0 +1,750 @@ +# CommonEventSubscriber + +## getCode + +```ts +getCode(callback: AsyncCallback): void +``` + +以回调形式获取公共事件代码。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ------------------ | +| callback | AsyncCallback\ | 是 | 公共事件代码。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//获取有序公共事件代码回调 +function getCodeCB(err, code) { + if (err.code) { + console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("getCode " + JSON.stringify(code)); + } +} +subscriber.getCode(getCodeCB); +``` + +## getCode + +```ts +getCode(): Promise +``` + +以Promise形式获取公共事件代码。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ---------------- | -------------------- | +| Promise\ | 公共事件代码。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.getCode().then((code) => { + console.info("getCode " + JSON.stringify(code)); +}).catch((err) => { + console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## setCode + +```ts +setCode(code: number, callback: AsyncCallback): void +``` + +以回调形式设置公共事件的代码。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ---------------------- | +| code | number | 是 | 公共事件的代码。 | +| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//设置有序公共事件的代码回调 +function setCodeCB(err) { + if (err.code) { + console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("setCode"); + } +} +subscriber.setCode(1, setCodeCB); +``` + +## setCode + +```ts +setCode(code: number): Promise +``` + +以Promise形式设置公共事件的代码。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------ | +| code | number | 是 | 公共事件的代码。 | + +**返回值:** + +| 类型 | 说明 | +| ---------------- | -------------------- | +| Promise\ | 返回一个Promise的结果。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.setCode(1).then(() => { + console.info("setCode"); +}).catch((err) => { + console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## getData + +```ts +getData(callback: AsyncCallback): void +``` + +以回调形式获取公共事件的数据。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | -------------------- | +| callback | AsyncCallback\ | 是 | 公共事件的数据。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//获取有序公共事件代码数据回调 +function getDataCB(err, data) { + if (err.code) { + console.error(`getData failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("getData " + JSON.stringify(data)); + } +} +subscriber.getData(getDataCB); +``` + +## getData + +```ts +getData(): Promise +``` + +以Promise形式获取公共事件的数据。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ---------------- | ------------------ | +| Promise\ | 公共事件的数据。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.getData().then((data) => { + console.info("getData " + JSON.stringify(data)); +}).catch((err) => { + console.error(`getData failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## setData + +setData(data: string, callback: AsyncCallback\): void + +以回调形式设置公共事件的数据。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | -------------------- | +| data | string | 是 | 公共事件的数据。 | +| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//设置有序公共事件的结果数据回调 +function setDataCB(err) { + if (err.code) { + console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("setData"); + } +} +subscriber.setData("publish_data_changed", setDataCB); +``` + +## setData + +```ts +setData(data: string): Promise +``` + +以Promise形式设置公共事件的果数据。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------- | +| data | string | 是 | 公共事件的数据。 | + +**返回值:** + +| 类型 | 说明 | +| ---------------- | -------------------- | +| Promise\ | 返回一个Promise的结果。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.setData("publish_data_changed").then(() => { + console.info("setData"); +}).catch((err) => { + console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## setCodeAndData + +```ts +setCodeAndData(code: number, data: string, callback:AsyncCallback): void +``` + +以回调形式设置公共事件代码和数据。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ---------------------- | +| code | number | 是 | 公共事件的代码。 | +| data | string | 是 | 公共事件的数据。 | +| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//设置有序公共事件的代码和数据回调 +function setCodeDataCB(err) { + if (err.code) { + console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("setCodeDataCallback"); + } +} +subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCB); +``` + +## setCodeAndData + +```ts +setCodeAndData(code: number, data: string): Promise +``` + +以Promise形式设置公共事件的代码和数据。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------- | +| code | number | 是 | 公共事件的代码。 | +| data | string | 是 | 公共事件的数据。 | + +**返回值:** + +| 类型 | 说明 | +| ---------------- | -------------------- | +| Promise\ | 返回一个Promise。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.setCodeAndData(1, "publish_data_changed").then(() => { + console.info("setCodeAndData"); +}).catch((err) => { + console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## isOrderedCommonEvent + +```ts +isOrderedCommonEvent(callback: AsyncCallback): void +``` + +以回调形式查询当前公共事件的是否为有序公共事件。 + +返回true代表是有序公共事件,false代表不是有序公共事件。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ---------------------------------- | +| callback | AsyncCallback\ | 是 | 当前公共事件的是否为有序公共事件。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//获取当前公共事件是否为有序事件的回调 +function isOrderedCB(err, isOrdered) { + if (err.code) { + console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("isOrdered " + JSON.stringify(isOrdered)); + } +} +subscriber.isOrderedCommonEvent(isOrderedCB); +``` + +## isOrderedCommonEvent + +```ts +isOrderedCommonEvent(): Promise +``` + +以Promise形式查询当前公共事件的是否为有序公共事件。 + +返回true代表是有序公共事件,false代表不是有序公共事件。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ----------------- | -------------------------------- | +| Promise\ | 当前公共事件的是否为有序公共事件。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.isOrderedCommonEvent().then((isOrdered) => { + console.info("isOrdered " + JSON.stringify(isOrdered)); +}).catch((err) => { + console.error(`isOrdered failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## isStickyCommonEvent + +```ts +isStickyCommonEvent(callback: AsyncCallback): void +``` + +以回调形式检查当前公共事件是否为一个粘性事件。 + +返回true代表是粘性公共事件,false代表不是粘性公共事件。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ---------------------------------- | +| callback | AsyncCallback\ | 是 | 当前公共事件的是否为粘性公共事件。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//获取当前公共事件是否为粘性事件的回调 +function isStickyCB(err, isSticky) { + if (err.code) { + console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("isSticky " + JSON.stringify(isSticky)); + } +} +subscriber.isStickyCommonEvent(isStickyCB); +``` + +## isStickyCommonEvent + +```ts +isStickyCommonEvent(): Promise +``` + +以Promise形式检查当前公共事件是否为一个粘性事件。 + +返回true代表是粘性公共事件,false代表不是粘性公共事件。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ----------------- | -------------------------------- | +| Promise\ | 当前公共事件的是否为粘性公共事件。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.isStickyCommonEvent().then((isSticky) => { + console.info("isSticky " + JSON.stringify(isSticky)); +}).catch((err) => { + console.error(`isSticky failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## abortCommonEvent + +```ts +abortCommonEvent(callback: AsyncCallback): void +``` + +以回调形式取消当前的有序公共事件,取消后,有序公共事件不再向下一个订阅者传递。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | -------------------- | +| callback | AsyncCallback\ | 是 | 取消当前的有序公共事件。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//取消当前有序公共事件的回调 +function abortCB(err) { + if (err.code) { + console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("abortCommonEvent"); + } +} +subscriber.abortCommonEvent(abortCB); +``` + +## abortCommonEvent + +```ts +abortCommonEvent(): Promise +``` + +以Promise形式取消当前的有序公共事件,取消后,公共事件不再向下一个订阅者传递。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ---------------- | -------------------- | +| Promise\ | 返回一个Promise的结果。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.abortCommonEvent().then(() => { + console.info("abortCommonEvent"); +}).catch((err) => { + console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## clearAbortCommonEvent + +```ts +clearAbortCommonEvent(callback: AsyncCallback): void +``` + +以回调形式清除当前有序公共事件。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | -------------------- | +| callback | AsyncCallback\ | 是 | 表示被指定的回调方法。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//清除当前公共事件取消状态的回调 +function clearAbortCB(err) { + if (err.code) { + console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("clearAbortCommonEvent"); + } +} +subscriber.clearAbortCommonEvent(clearAbortCB); +``` + +## clearAbortCommonEvent + +```ts +clearAbortCommonEvent(): Promise +``` + +以Promise形式清除当前有序公共事件。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ---------------- | -------------------- | +| Promise\ | 返回一个Promise的结果。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.clearAbortCommonEvent().then(() => { + console.info("clearAbortCommonEvent"); +}).catch((err) => { + console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## getAbortCommonEvent + +```ts +getAbortCommonEvent(callback: AsyncCallback): void +``` + +以回调形式获取当前有序公共事件是否取消的状态。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------- | ---- | ---------------------------------- | +| callback | AsyncCallback\ | 是 | 表示当前有序公共事件是否取消的状态。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//获取当前有序公共事件是否取消的回调 +function getAbortCB(err, abortEvent) { + if (err.code) { + console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("abortCommonEvent " + abortEvent) + } +} +subscriber.getAbortCommonEvent(getAbortCB); +``` + +## getAbortCommonEvent + +```ts +getAbortCommonEvent(): Promise +``` + +以Promise形式获取当前有序公共事件是否取消的状态。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ----------------- | ---------------------------------- | +| Promise\ | 表示当前有序公共事件是否取消的状态。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.getAbortCommonEvent().then((abortEvent) => { + console.info("abortCommonEvent " + JSON.stringify(abortEvent)); +}).catch((err) => { + console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## getSubscribeInfo + +```ts +getSubscribeInfo(callback: AsyncCallback): void +``` + +以回调形式获取订阅者的订阅信息。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ---------------------- | +| callback | AsyncCallback\<[CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md)> | 是 | 表示订阅者的订阅信息。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//获取订阅者信息回调 +function getCB(err, subscribeInfo) { + if (err.code) { + console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); + } else { + console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); + } +} +subscriber.getSubscribeInfo(getCB); +``` + +## getSubscribeInfo + +```ts +getSubscribeInfo(): Promise +``` + +以Promise形式获取订阅者的订阅信息。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ------------------------------------------------------------ | ---------------------- | +| Promise\<[CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md)> | 表示订阅者的订阅信息。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.getSubscribeInfo().then((subscribeInfo) => { + console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); +}).catch((err) => { + console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); +}); +``` + +## finishCommonEvent9+ + +```ts +finishCommonEvent(callback: AsyncCallback): void +``` + +以回调形式结束当前有序公共事件。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | -------------------------------- | +| callback | AsyncCallback\ | 是 | 表示有序公共事件结束后的回调函数。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +//结束当前有序公共事件的回调 +function finishCB(err) { + if (err.code) { + console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); +} else { + console.info("FinishCommonEvent"); +} + +subscriber.finishCommonEvent(finishCB); +``` + +## finishCommonEvent9+ + +```ts +finishCommonEvent(): Promise +``` + +以Promise形式结束当前有序公共事件。 + +**系统能力**:`SystemCapability.Notification.CommonEvent` + +**返回值:** + +| 类型 | 说明 | +| ---------------- | -------------------- | +| Promise\ | 返回一个Promise的结果。 | + +**示例:** + +```ts +let subscriber; //创建成功的订阅者对象 + +subscriber.finishCommonEvent().then(() => { + console.info("FinishCommonEvent"); +}).catch((err) => { + console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); +}); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/website.md b/zh-cn/application-dev/website.md index d10a1bd6d103518624f07c3bfacd69599a2a2f5d..cc82becbf18818bce250dc445b5837674685fc3c 100644 --- a/zh-cn/application-dev/website.md +++ b/zh-cn/application-dev/website.md @@ -927,6 +927,11 @@ - [@ohos.notification (Notification模块)(待停用)](reference/apis/js-apis-notification.md) - application - [EventHub](reference/apis/js-apis-inner-application-eventHub.md) + - commonEvent + - [CommonEventData](reference/apis/js-apis-inner-commonEvent-commonEventData.md) + - [CommonEventPublishData](reference/apis/js-apis-inner-commonEvent-commonEventPublishData.md) + - [CommonEventSubscriber](reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md) + - [CommonEventSubscribeInfo](reference/apis/js-apis-inner-commonEvent-commonEventSubscribeInfo.md) - 包管理 - [@ohos.bundle.appControl (appControl模块)](reference/apis/js-apis-appControl.md) - [@ohos.bundle.bundleManager (bundleManager模块)](reference/apis/js-apis-bundleManager.md)