CommonEvent

NOTE The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Required Permissions

Modules to Import

import CommonEvent from '@ohos.commonEvent';

CommonEvent.publish

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

Publishes a common event. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

// Callback for common event publication
function PublishCallBack(err) {
	if (err.code) {
        console.error("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish");
    }
}

// Publish a common event.
CommonEvent.publish("event", PublishCallBack);

CommonEvent.publish

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

Publishes a common event with given attributes. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

// Attributes of a common event.
var options = {
	code: 0,			 // Result code of the common event
	data: "initial data";// Result data of the common event
	isOrdered: true	 // The common event is an ordered one.
}

// Callback for common event publication
function PublishCallBack(err) {
	if (err.code) {
        console.error("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish");
    }
}

// Publish a common event.
CommonEvent.publish("event", options, PublishCallBack);

CommonEvent.publishAsUser⁸⁺

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

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

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

// Callback for common event publication
function PublishAsUserCallBack(err) {
	if (err.code) {
        console.error("publishAsUser failed " + JSON.stringify(err));
    } else {
        console.info("publishAsUser");
    }
}

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

// Publish a common event.
CommonEvent.publishAsUser("event", userId, PublishAsUserCallBack);

CommonEvent.publishAsUser⁸⁺

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

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

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

// Attributes of a common event.
var options = {
	code: 0,			 // Result code of the common event
	data: "initial data";// Result data of the common event
}

// Callback for common event publication
function PublishAsUserCallBack(err) {
	if (err.code) {
        console.error("publishAsUser failed " + JSON.stringify(err));
    } else {
        console.info("publishAsUser");
    }
}

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

// Publish a common event.
CommonEvent.publishAsUser("event", userId, options, PublishAsUserCallBack);

CommonEvent.createSubscriber

createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback<CommonEventSubscriber>): void

Creates a subscriber. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.

// Subscriber information.
var subscribeInfo = {
	events: ["event"]
};

// Callback for subscriber creation.
function CreateSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.error("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
    }
}

// Create a subscriber.
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);

CommonEvent.createSubscriber

createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise<CommonEventSubscriber>

Creates a subscriber. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Return value

Example

var subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.

// Subscriber information.
var subscribeInfo = {
	events: ["event"]
};

// Create a subscriber.
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<CommonEventData>): void

Subscribes to common events. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.

// Subscriber information.
var subscribeInfo = {
    events: ["event"]
};

// Callback for common event subscription.
function SubscribeCallBack(err, data) {
    if (err.code) {
        console.error("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribe " + JSON.stringify(data));
    }
}

// Callback for subscriber creation.
function CreateSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.error("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
        // Subscribe to a common event.
        CommonEvent.subscribe(subscriber, SubscribeCallBack);
    }
}

// Create a subscriber.
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);

CommonEvent.unsubscribe

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

Unsubscribes from common events. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Used to save the created subscriber object for subsequent subscription and unsubscription.

// Subscriber information.
var subscribeInfo = {
	events: ["event"]
};

// Callback for common event subscription.
function SubscribeCallBack(err, data) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribe " + JSON.stringify(data));
    }
}

// Callback for subscriber creation.
function CreateSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.info("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
        // Subscribe to a common event.
        CommonEvent.subscribe(subscriber, SubscribeCallBack);
    }
}

// Callback for common event unsubscription.
function UnsubscribeCallBack(err) {
	if (err.code) {
        console.info("unsubscribe failed " + JSON.stringify(err));
    } else {
        console.info("unsubscribe");
    }
}

// Create a subscriber.
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);

// Unsubscribe from the common event.
CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);

CommonEventSubscriber

getCode

getCode(callback: AsyncCallback<number>): void

Obtains the result code of this common event. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for result code obtaining of an ordered common event.
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>

Obtains the result code of this common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

Sets the result code for this common event. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for result code setting of an ordered common event.
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>

Sets the result code for this common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

getData

getData(callback: AsyncCallback<string>): void

Obtains the result data of this common event. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for result data obtaining of an ordered common event.
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>

Obtains the result data of this common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

Sets the result data for this common event. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for result data setting of an ordered common event
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>

Sets the result data for this common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

Sets the result code and result data for this common event. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for result code and result data setting of an ordered common event.
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>

Sets the result code and result data for this common event. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

Checks whether this common event is an ordered one. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for checking whether the current common event is an ordered one.
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>

Checks whether this common event is an ordered one. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

Checks whether this common event is a sticky one. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for checking whether the current common event is a sticky one.
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>

Checks whether this common event is a sticky one. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

Aborts this common event. After the abort, the common event is not sent to the next subscriber. This API takes effect only for ordered common events. It uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for common event aborting.
function abortCallback(err) {
    if (err.code) {
        console.error("abortCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("abortCommonEvent");
    }
}
subscriber.abortCommonEvent(abortCallback);

abortCommonEvent

abortCommonEvent(): Promise<void>

Aborts this common event. After the abort, the common event is not sent to the next subscriber. This API takes effect only for ordered common events. It uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

clearAbortCommonEvent

clearAbortCommonEvent(callback: AsyncCallback<void>): void

Clears the aborted state of this common event. This API takes effect only for ordered common events. It uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for clearing the aborted state of the current common event.
function clearAbortCallback(err) {
    if (err.code) {
        console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("clearAbortCommonEvent");
    }
}
subscriber.clearAbortCommonEvent(clearAbortCallback);

clearAbortCommonEvent

clearAbortCommonEvent(): Promise<void>

Clears the aborted state of this common event. This API takes effect only for ordered common events. It uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

getAbortCommonEvent

getAbortCommonEvent(callback: AsyncCallback<boolean>): void

Checks whether this common event is in the aborted state. This API takes effect only for ordered common events. It uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for checking whether the current common event is in the aborted state.
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>

Checks whether this common event is in the aborted state. This API takes effect only for ordered common events. It uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

Obtains the subscriber information. This API uses a callback to return the result.

System capability: SystemCapability.Notification.CommonEvent

Parameters

Example

var subscriber;	// Subscriber object successfully created.

// Callback for subscriber information obtaining.
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>

Obtains the subscriber information. This API uses a promise to return the result.

System capability: SystemCapability.Notification.CommonEvent

Return value

Example

var subscriber;	// Subscriber object successfully created.

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

CommonEventData

System capability: SystemCapability.Notification.CommonEvent

CommonEventPublishData

System capability: SystemCapability.Notification.CommonEvent

CommonEventSubscribeInfo

System capability: SystemCapability.Notification.CommonEvent