APIの起動
前述のAPIは、サブスクライブ、SubscribeOnce、公開および処分です。
それぞれの概要を次に示します:
サブスクライブ
このAPIは、サービス・センターからイベントをサブスクライブできます。 このAPIを使用すると、外部アプリケーションはサービス・センターからアプリケーション・レベルまたはオブジェクト・レベルのイベントをリスニングできます。 イベントがこのAPIの使用をサブスクライブすると、サブスクリプションが処分されるまで外部アプリケーションに通知されます。
次のコード・サンプルは、Subscribeの構文を示しています:
subscribe: (payload: IEventSubscriptionPayload, callbackFunction: (response:IEventResponsePayload) => void)
=> ISubscriptionContext;| パラメータ | 必須かどうか | 説明 |
|---|---|---|
| payload | Yes | 対応するイベント名を持つサブスクリプションの詳細をリクエストします。 |
SubscribeOnce
このAPIを使用して、サービス・センター・イベントに1回のみサブスクライブします。 このAPIを使用すると、外部アプリケーションはサービス・センターからアプリケーションまたはオブジェクト・レベルのイベントをリスニングできます。 このサブスクリプションは、最初の通知後に自動的に破棄されます。
次のコード・サンプルは、SubscribeOnceの構文を示しています:
subscribeOnce: (payload: IEventSubscriptionPayload, callbackFunction: (response: IEventResponsePayload) => void)
=> ISubscriptionContext;| パラメータ | 必須かどうか | 説明 |
|---|---|---|
| payload | Yes | 対応するイベント名を持つサブスクリプションの詳細をリクエストします。 |
| callbackFunction | Yes | サービス・センター内でイベントがトリガーされるたびにコールを受信するコールバック関数。 |
パブリッシュ
このAPIは、サービス・センターに操作を通知できます。 APIは、then-catchブロックを追加できるpromiseを返します。 その後、ブロックは操作のステータスと、プロセスの完了後に返されたデータを返します。
次のコード例は、Publishの構文を示しています:
publish: (payload: IOperationPublishPayload) => Promise<IOperationResponsePayload>;| パラメータ | 必須かどうか | 説明 |
|---|---|---|
| payload | Yes | 対応するoperationNameを持つサブスクリプションの詳細をリクエストします。 |
処分
このAPIは、イベントに追加されたサブスクリプションを処分または登録解除できます。 サブスクリプションを処分することで、APIはクライアント側レシーバへのそれ以上の通知をトリガーしません。
次のコード例は、Disposeの構文を示しています:
dispose:() => void;