チャットのAPI

概要

FMチャット専用の一連のスクリプトを使うと、手動ではなくスクリプトからチャットを作成できます。

これらのAPIのスクリプトは、ソリューション内でのアクションをユーザに通知するために使用できます。たとえば、プロジェクトのステータスが「承認済み」になったことを通知できます。あるいは、あらかじめスケジュールが決められていたルーチンが完了したことや、レコードにエラーが発生しているため確認が必要なことなど、サーバサイドの処理の結果も通知できます。

このようにしてソリューション内の情報を伝える方法としてFMチャットを使用し、注意事項をユーザに通知できます。

API

ソリューション内にペーストして使うスクリプトと、FMチャット内で直接コールするスクリプトがあります。

NewChatFromEntity (entityID ; entityType ; entityName {; fileName})

ソリューション中の特定のレコードにリンクするエンティティチャットを作成する際に使用するスクリプトです(このスクリプトは自分のファイルにペーストして使います)。これは、サンプルの「FMChat Integration Example.fmp12」ファイルでコールしているスクリプトです。このサンプルを見ると、このAPIを「コールする」方法を理解できるでしょう。

SendMessageFromSystem (type ; message {; sendTo ; attachmentPath ; entityID ; entityType ; public }) 

このスクリプトは、自分で作成したスクリプトから、またはFileMaker Serverから、FMChat.fmp12で直接コールして、システムチャットを作成します。このスクリプトは、何かが起きたら通知したい場合に便利です。おそらく、FileMaker Serverがサーバサイドスクリプトを完了したときや、販売の注文が納品書に変更されたときなどに使用されるでしょう。このスクリプトから送信されるメッセージは、人から送られるものではありません。そのため誰かに何かを通知したいが、特定の誰かから送信するのではないという場合に、このスクリプトが適しています。

それぞれのスクリプトで使用できるパラメータの詳細は、スクリプトの先頭にあるコメントを参照してください。