ISubscriptionContext
ISubscriptionContextオブジェクトには、アプリケーション・レベルまたはオブジェクト・レベルのイベントをリスニングするサブスクライブまたはサブスクライブ・アグリーメントAPIのコール中に、サブスクリプションを追加したオブジェクトへの参照が含まれます。 このオブジェクト上でdispose APIをコールして、その特定のサブスクリプションを任意の時点で破棄または登録解除できます。
関数
処分
このAPIを使用して、イベントに追加されたサブスクリプションを処分または登録解除します。 サブスクリプションを処分することで、APIはクライアント側レシーバへのそれ以上の通知をトリガーしません。
dispose:() => void;
次のコード・スニペットは、Typescriptの例を示しています:
/// <reference path="uiEventsFramework.d.ts"/>
const frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1');
const globalContext: IGlobalContext = await frameworkProvider.getGlobalContext();
const requestObject: IEventRequest = frameworkProvider.requestHelper.createSubscriptionRequest('cxEventBusTabCloseEvent');
const subscriptionContext: ISubscriptionContext = globalContext.subscribe(requestObject, (response: IEventResponse) => {
// custom code
});
subscriptionContext.dispose();
次のコード・スニペットは、JavaScriptの例を示しています:
const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1');
const globalContext = await frameworkProvider.getGlobalContext();
const requestObject = frameworkProvider.requestHelper.createSubscriptionRequest('cxEventBusTabCloseEvent');
const subscriptionContext = globalContext.subscribe(requestObject, (response) => {
// custom code
});
subscriptionContext.dispose();