@ohos.commonEvent (Common Event) (System API) (Deprecated)

The CommonEvent module provides capabilities to publish, subscribe to, and unsubscribe from common events, as well as obtain and modify the common event result code and result data.

NOTE

This API has been supported since API version 7 and deprecated since API version 9. You are advised to use @ohos.commonEventManager instead.

This topic describes only system APIs provided by the module. For details about its public APIs, see CommonEvent.

Modules to Import

import commonEvent from '@ohos.commonEvent';

Support

A system common event is an event that is published by a system service or system application and requires specific permissions to subscribe to. To publish or subscribe to this type of event, you must follow the event-specific definitions.

For details about the definitions of all system common events, see System Common Events.

commonEvent.publishAsUser^(deprecated)

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

Publishes a common event to a specific user. This API uses an asynchronous callback to return the result.

NOTE

This API has been supported since API version 8 and deprecated since API version 9. You are advised to use commonEventManager.publishAsUser instead.

System capability: SystemCapability.Notification.CommonEvent

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
event	string	Yes	Name of the common event to publish.
userId	number	Yes	User ID.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import Base from '@ohos.base';

// Callback for common event publication
function publishCB(err:Base.BusinessError) {
    if (err.code) {
        console.error(`publishAsUser failed, code is ${err.code}`);
    } else {
        console.info("publishAsUser");
    }
}

// Specify the user to whom the common event will be published.
let userId = 100;

// Publish a common event.
commonEvent.publishAsUser("event", userId, publishCB);

commonEvent.publishAsUser^(deprecated)

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

Publishes a common event with given properties to a specific user. This API uses an asynchronous callback to return the result.

NOTE This API has been supported since API version 8 and deprecated since API version 9. You are advised to use commonEventManager.publishAsUser instead.

System capability: SystemCapability.Notification.CommonEvent

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
event	string	Yes	Name of the common event to publish.
userId	number	Yes	User ID.
options	CommonEventPublishData	Yes	Properties of the common event to publish.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import Base from '@ohos.base';
import CommonEventManager from '@ohos.commonEventManager';

// Information of a common event.
let options:CommonEventManager.CommonEventPublishData = {
    code: 0,             // Initial code of the common event.
    data: "initial data",// Initial data of the common event.
}

// Callback for common event publication
function publishCB(err:Base.BusinessError) {
    if (err.code) {
        console.error(`publishAsUser failed, code is ${err.code}`);
    } else {
        console.info("publishAsUser");
    }
}

// Specify the user to whom the common event will be published.
let userId = 100;

// Publish a common event.
commonEvent.publishAsUser("event", userId, options, publishCB);