IDynamicDataCallables interface

パッケージ:

@microsoft/sp-dynamic-data

動的データ ソースにするために実装するコンポーネントのインターフェイス。 これは、状態を持つオブジェクト、またはデータを返す一連の緩やかな関数として実装できます。

メソッド

allowedEvents()	動的データ ソースで許可されるイベントの一覧を返します。 この関数が空でない結果を返す場合、source は 'sendEvent' api を定義する必要があります。 この API が定義されていないか、空の配列を返す場合、コンシューマーはこのソースと通信できません。
getAnnotatedPropertyValue(propertyId)	プロパティ ID を指定すると、注釈付き値が返されます。 ソースが注釈付き値を指定しない場合は、サンプル値とメタデータが未定義であるため、'getPropertyValue' が返す任意の値にフォールバックします。
getPropertyDefinitions()	DataSource が提供するすべてのプロパティ定義を返します。
getPropertyValue(propertyId)	プロパティ ID を指定すると、 プロパティの値が返されます。
sendEvent(eventName, data)	定義されている場合、コンシューマーは関連付けられている動的データ ソースにデータを送信できます。 その後、ソースはそれに応じて動作できます。 この API を呼び出すと、'eventName' で渡されたがソースで許可されているイベントの 1 つでない場合にエラーがスローされます。

メソッドの詳細

allowedEvents()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

動的データ ソースで許可されるイベントの一覧を返します。

この関数が空でない結果を返す場合、source は 'sendEvent' api を定義する必要があります。

この API が定義されていないか、空の配列を返す場合、コンシューマーはこのソースと通信できません。

allowedEvents?(): ReadonlyArray<IDynamicDataEventDefinition>;

戻り値

ReadonlyArray<IDynamicDataEventDefinition>

getAnnotatedPropertyValue(propertyId)

プロパティ ID を指定すると、注釈付き値が返されます。 ソースが注釈付き値を指定しない場合は、サンプル値とメタデータが未定義であるため、'getPropertyValue' が返す任意の値にフォールバックします。

getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;

パラメーター

propertyId

string

動的データ ソースから公開されるプロパティ ID の 1 つ。

戻り値

IDynamicDataAnnotatedPropertyValue | undefined

getPropertyDefinitions()

DataSource が提供するすべてのプロパティ定義を返します。

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

戻り値

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyValue(propertyId)

プロパティ ID を指定すると、 プロパティの値が返されます。

getPropertyValue(propertyId: string): any;

パラメーター

propertyId

string

戻り値

any

注釈

この関数が配列を返すときは、同一であると想定されます。

sendEvent(eventName, data)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

定義されている場合、コンシューマーは関連付けられている動的データ ソースにデータを送信できます。 その後、ソースはそれに応じて動作できます。

この API を呼び出すと、'eventName' で渡されたがソースで許可されているイベントの 1 つでない場合にエラーがスローされます。

sendEvent?(eventName: string, data: any): void;

パラメーター

eventName

string

イベントの名前を表す大文字と小文字を区別する文字列。

data

any

動的データ ソースに送信されるデータ。

戻り値

void