IFieldValueChangeEventRequest
このオブジェクトは、フィールド値変更イベント・サブスクリプションのリクエスト・オブジェクトとして渡されます。
関数
setFields
このファンクションを使用して、FieldValueChangeイベント・リクエスト・オブジェクトのフィールドを設定します。 渡される有効なフィールド名については、「フィールド名マッピング」の項を参照してください。
ノート: 現在、複合フィールドはサポートされていません
次のブロックは、setFieldsの構文を示しています。
setFields: (fields: string[]) => void
パラメータは次のとおりです:
パラメータ | 必須かどうか | 説明 |
---|---|---|
フィールド | Yes | サブスクリプションの追加先となるフィールド値。 |
次のコード・サンプルは、setFieldsメソッドが使用されているFieldValueChangeイベントをサブスクライブするためのTypescriptの例を示しています:
/// <reference path="uiEventsFramework.d.ts"/>
const frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1');
const tabContext: ITabContext = await frameworkProvider.getTabContext();
const recordContext: IRecordContext = await tabContext.getActiveRecord();
const requestObject: IFieldValueChangeEventRequest = frameworkProvider.requestHelper.createSubscriptionRequest('cxEventBusFieldValueChangeEvent') as IFieldValueChangeEventRequest;
requestObject.setFields(['ServiceRequest.Title','ServiceRequest.ProblemDescription']);
recordContext.subscribe(requestObject, (message: IEventResponse) => {
const response = message as IFieldValueChangeEventResponse;
// custom code
});
次のコード・サンプルは、setFieldsメソッドが使用されているFieldValueChangeイベント・イベントをサブスクライブするためのJavascriptの例を示しています。
const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1');
const tabContext = await frameworkProvider.getTabContext();
const recordContext = await tabContext.getActiveRecord();
const requestObject = frameworkProvider.requestHelper.createSubscriptionRequest('cxEventBusFieldValueChangeEvent')
requestObject.setFields(['ServiceRequest.Title','ServiceRequest.ProblemDescription']);
recordContext.subscribe(requestObject, (response) => {
// custom code
});
getEventName
この関数は、作成されたイベント・リクエスト・オブジェクトからイベント名を取得します。
次のコード・サンプルは、getEventNameの構文を示しています:
getEventName(): string;
次のコード・サンプルは、getEventNameメソッドが使用されているFieldValueChangeイベントをサブスクライブするためのtypescriptの例を示しています:
/// <reference path="uiEventsFramework.d.ts"/>
const frameworkProvider: IUiEventsFrameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1');
const tabContext: ITabContext = await frameworkProvider.getTabContext();
const recordContext: IRecordContext = await tabContext.getActiveRecord();
const requestObject: IFieldValueChangeEventRequest = frameworkProvider.requestHelper.createSubscriptionRequest('cxEventBusFieldValueChangeEvent') as IFieldValueChangeEventRequest;
requestObject.setFields(['ServiceRequest.Title','ServiceRequest.ProblemDescription']);
recordContext.subscribe(requestObject, (message: IEventResponse) => {
const response = message as IFieldValueChangeEventResponse;
// custom code
});
const eventName: string = requestObject.getEventName(); // 'cxEventBusFieldValueChangeEvent'
次のコード・スニペットは、getEventNameメソッドが使用されているFieldValueChangeイベントをサブスクライブするためのJavascriptの例を示しています:
const frameworkProvider = await CX_SVC_UI_EVENTS_FRAMEWORK.uiEventsFramework.initialize('MyFirstExtensionID''v1');
const tabContext = await frameworkProvider.getTabContext();
const recordContext = await tabContext.getActiveRecord();
const requestObject = frameworkProvider.requestHelper.createSubscriptionRequest('cxEventBusFieldValueChangeEvent');
requestObject.setFields(['ServiceRequest.Title','ServiceRequest.ProblemDescription']);
recordContext.subscribe(requestObject, (response) => {
// custom code
});
const eventName = requestObject.getEventName(); // 'cxEventBusFieldValueChangeEvent'