公共事件模塊

說明： 本模塊首批接口從API version 7開始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

導(dǎo)入模塊

import CommonEvent from '@ohos.commonEvent';
`HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿`

Support

CommonEvent模塊支持的事件類型。名稱指的是系統(tǒng)公共事件宏；值指的是系統(tǒng)公共事件。

系統(tǒng)能力： SystemCapability.Notification.CommonEvent

CommonEvent.publish

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

發(fā)布公共事件（callback形式）。

系統(tǒng)能力： SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

//發(fā)布公共事件回調(diào)
function PublishCallBack(err) {
	if (err.code) {
        console.error("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish");
    }
}

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

CommonEvent.publish

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

發(fā)布公共事件指定發(fā)布信息（callback形式）。

系統(tǒng)能力： SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

//公共事件相關(guān)信息
var options = {
	code: 0,			 //公共事件的初始代碼
	data: "initial data",//公共事件的初始數(shù)據(jù)
	isOrdered: true	 //有序公共事件
}

//發(fā)布公共事件回調(diào)
function PublishCallBack(err) {
	if (err.code) {
        console.error("publish failed " + JSON.stringify(err));
    } else {
        console.info("publish");
    }
}

//發(fā)布公共事件
CommonEvent.publish("event", options, PublishCallBack);

CommonEvent.publishAsUser8+

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

向指定用戶發(fā)布公共事件（callback形式）。

系統(tǒng)能力： SystemCapability.Notification.CommonEvent

系統(tǒng)API： 此接口為系統(tǒng)接口，三方應(yīng)用不支持調(diào)用。

參數(shù)：

示例：

//發(fā)布公共事件回調(diào)
function PublishAsUserCallBack(err) {
	if (err.code) {
        console.error("publishAsUser failed " + JSON.stringify(err));
    } else {
        console.info("publishAsUser");
    }
}

//指定發(fā)送的用戶
var userId = 100;

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

CommonEvent.publishAsUser8+

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

向指定用戶發(fā)布公共事件并指定發(fā)布信息（callback形式）。

系統(tǒng)能力： SystemCapability.Notification.CommonEvent

系統(tǒng)API： 此接口為系統(tǒng)接口，三方應(yīng)用不支持調(diào)用。

參數(shù)：

示例：

//公共事件相關(guān)信息
var options = {
	code: 0,			 //公共事件的初始代碼
	data: "initial data",//公共事件的初始數(shù)據(jù)
}

//發(fā)布公共事件回調(diào)
function PublishAsUserCallBack(err) {
	if (err.code) {
        console.error("publishAsUser failed " + JSON.stringify(err));
    } else {
        console.info("publishAsUser");
    }
}

//指定發(fā)送的用戶
var userId = 100;

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

CommonEvent.createSubscriber

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

創(chuàng)建訂閱者（callback形式）。

系統(tǒng)能力： SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber; //用于保存創(chuàng)建成功的訂閱者對(duì)象，后續(xù)使用其完成訂閱及退訂的動(dòng)作

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

//創(chuàng)建訂閱者回調(diào)
function CreateSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.error("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
    }
}

//創(chuàng)建訂閱者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);

CommonEvent.createSubscriber

createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise

創(chuàng)建訂閱者（Promise形式）。

系統(tǒng)能力： SystemCapability.Notification.CommonEvent

參數(shù)：

返回值：

示例：

var subscriber; //用于保存創(chuàng)建成功的訂閱者對(duì)象，后續(xù)使用其完成訂閱及退訂的動(dòng)作

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

//創(chuàng)建訂閱者
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形式）。

系統(tǒng)能力： SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber; //用于保存創(chuàng)建成功的訂閱者對(duì)象，后續(xù)使用其完成訂閱及退訂的動(dòng)作

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

//訂閱公共事件回調(diào)
function SubscribeCallBack(err, data) {
    if (err.code) {
        console.error("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribe " + JSON.stringify(data));
    }
}

//創(chuàng)建訂閱者回調(diào)
function CreateSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.error("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
        //訂閱公共事件
        CommonEvent.subscribe(subscriber, SubscribeCallBack);
    }
}

//創(chuàng)建訂閱者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);

CommonEvent.unsubscribe

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

取消訂閱公共事件（callback形式）。

系統(tǒng)能力： SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//用于保存創(chuàng)建成功的訂閱者對(duì)象，后續(xù)使用其完成訂閱及退訂的動(dòng)作

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

//訂閱公共事件回調(diào)
function SubscribeCallBack(err, data) {
    if (err.code) {
        console.info("subscribe failed " + JSON.stringify(err));
    } else {
        console.info("subscribe " + JSON.stringify(data));
    }
}

//創(chuàng)建訂閱者回調(diào)
function CreateSubscriberCallBack(err, commonEventSubscriber) {
    if (err.code) {
        console.info("createSubscriber failed " + JSON.stringify(err));
    } else {
        console.info("createSubscriber");
        subscriber = commonEventSubscriber;
        //訂閱公共事件
        CommonEvent.subscribe(subscriber, SubscribeCallBack);
    }
}

//取消訂閱公共事件回調(diào)
function UnsubscribeCallBack(err) {
	if (err.code) {
        console.info("unsubscribe failed " + JSON.stringify(err));
    } else {
        console.info("unsubscribe");
    }
}

//創(chuàng)建訂閱者
CommonEvent.createSubscriber(subscribeInfo, CreateSubscriberCallBack);

//取消訂閱公共事件
CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);

CommonEventSubscriber

getCode

getCode(callback: AsyncCallback): void

獲取公共事件的結(jié)果代碼（callback形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//獲取有序公共事件的結(jié)果代碼回調(diào)
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

獲取公共事件的結(jié)果代碼（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

設(shè)置公共事件的結(jié)果代碼（callback形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//設(shè)置有序公共事件的結(jié)果代碼回調(diào)
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

設(shè)置公共事件的結(jié)果代碼（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

getData

getData(callback: AsyncCallback): void

獲取公共事件的結(jié)果數(shù)據(jù)（callback形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//獲取有序公共事件的結(jié)果數(shù)據(jù)回調(diào)
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

獲取公共事件的結(jié)果數(shù)據(jù)（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

設(shè)置公共事件的結(jié)果數(shù)據(jù)（callback形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//設(shè)置有序公共事件的結(jié)果數(shù)據(jù)回調(diào)
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

設(shè)置公共事件的結(jié)果數(shù)據(jù)（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

設(shè)置公共事件的結(jié)果代碼和結(jié)果數(shù)據(jù)（callback形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//設(shè)置有序公共事件的結(jié)果代碼和結(jié)果數(shù)據(jù)回調(diào)
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

設(shè)置公共事件的結(jié)果代碼和結(jié)果數(shù)據(jù)（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

isOrderedCommonEvent

isOrderedCommonEvent(callback: AsyncCallback): void

查詢當(dāng)前公共事件的是否為有序公共事件（callback形式）。

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

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//獲取當(dāng)前公共事件是否為有序事件的回調(diào)
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

查詢當(dāng)前公共事件的是否為有序公共事件（Promise形式）。

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

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

isStickyCommonEvent

isStickyCommonEvent(callback: AsyncCallback): void

檢查當(dāng)前公共事件是否為一個(gè)粘性事件（callback形式）。

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

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//獲取當(dāng)前公共事件是否為粘性事件的回調(diào)
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

檢查當(dāng)前公共事件是否為一個(gè)粘性事件（Promise形式）。

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

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

abortCommonEvent

abortCommonEvent(callback: AsyncCallback): void

取消當(dāng)前的公共事件，僅對(duì)有序公共事件有效，取消后，公共事件不再向下一個(gè)訂閱者傳遞（callback形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//取消當(dāng)前有序公共事件的回調(diào)
function abortCallback(err) {
    if (err.code) {
        console.error("abortCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("abortCommonEvent");
    }
}
subscriber.abortCommonEvent(abortCallback);

abortCommonEvent

abortCommonEvent(): Promise

取消當(dāng)前的公共事件，僅對(duì)有序公共事件有效，取消后，公共事件不再向下一個(gè)訂閱者傳遞（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

clearAbortCommonEvent

clearAbortCommonEvent(callback: AsyncCallback): void

清除當(dāng)前公共事件的取消狀態(tài)，僅對(duì)有序公共事件有效（callback形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//清除當(dāng)前公共事件取消狀態(tài)的回調(diào)
function clearAbortCallback(err) {
    if (err.code) {
        console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
    } else {
        console.info("clearAbortCommonEvent");
    }
}
subscriber.clearAbortCommonEvent(clearAbortCallback);

clearAbortCommonEvent

clearAbortCommonEvent(): Promise

清除當(dāng)前公共事件的取消狀態(tài)，僅對(duì)有序公共事件有效（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

getAbortCommonEvent

getAbortCommonEvent(callback: AsyncCallback): void

獲取當(dāng)前有序公共事件是否取消的狀態(tài)（callback形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//獲取當(dāng)前有序公共事件是否取消的回調(diào)
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

獲取當(dāng)前有序公共事件是否取消的狀態(tài)（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

//獲取訂閱者信息回調(diào)
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形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

finishCommonEvent9+

finishCommonEvent(callback: AsyncCallback): void

結(jié)束當(dāng)前有序公共事件（callback形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

參數(shù)：

示例：

var subscriber; //創(chuàng)建成功的訂閱者對(duì)象

//結(jié)束當(dāng)前有序公共事件的回調(diào)
function finishCommonEventCallback(err) {
  if (err.code) {
    console.error("finishCommonEvent failed " + JSON.stringify(err));
} else {
    console.info("FinishCommonEvent");
}
}
subscriber.finishCommonEvent(finishCommonEventCallback);

finishCommonEvent9+

finishCommonEvent(): Promise

結(jié)束當(dāng)前有序公共事件（Promise形式）。

系統(tǒng)能力 ：SystemCapability.Notification.CommonEvent

返回值：

示例：

var subscriber;	//創(chuàng)建成功的訂閱者對(duì)象

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

CommonEventData

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.CommonEvent

CommonEventPublishData

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.CommonEvent

CommonEventSubscribeInfo

系統(tǒng)能力： 以下各項(xiàng)對(duì)應(yīng)的系統(tǒng)能力均為SystemCapability.Notification.CommonEvent

審核編輯 黃宇