使い方
このセクションでは、プラットフォームイベントAPIの使い方について詳述しています。
プラットフォームイベントAPI
RaySheetでは３つのカスタムプラットフォームイベントを定義しています。
- レコード取得イベント：表画面に表示するレコードを取得する際に公開されるイベント
- レコード保存イベント：レコードを保存する際に公開されるイベント
- レコードエクスポートイベント：レコードのエクスポートをする際に公開されるイベント
利用者はこれらのカスタムプラットフォームイベントをフローやApexなどで登録することができます。レコードの取得/保存/エクスポートのイベントを捕捉し、RaySheetとのAPI（アプリケーションプログラミングインターフェース）として様々な形で利用できます。
カスタムプラットフォームイベントの詳細は「リファレンス」を参照してください。
プラットフォームイベントについての詳細はSalesforceが提供している「プラットフォームイベント開発者ガイド」を参照してください。
有効化
プラットフォームイベントAPIを使用するためには、有効化する必要があります。[RaySheet設定]-[組織の設定]-[プラットフォームイベントAPIの有効化]を有効にしてください。
プラットフォームイベントAPIを有効化すると、RaySheetで定義しているカスタムプラットフォームイベントを公開するようになります。つまり、大規模プラットフォームイベントの割り当てに適用されるようになります。プラットフォームイベントの割り当ての最大数は組織ごとに決まっているため、十分に注意して有効化してください。
プラットフォームイベントの割り当てについての詳細はSalesforceが提供しているドキュメントである「プラットフォームイベントの割り当て」を参照してください。