4.1. 全体の作業の流れ¶
ここでは IM-MessageHub を利用してメッセージを配信する方法を説明します。この章を通して以下のことを学びます。
- IM-MessageHub へのメッセージ配信依頼方法
- イベントの定義方法
- テンプレートの定義方法
- メッセージの作成方法
- メッセージ配信受付 API の利用方法
IM-MessageHub を利用して、メッセージを配信するための流れは以下の通りです。図:メッセージを配信するための流れまず、IM-MessageHub を利用してメッセージを配信処理を実装する前に、以下の3つを定義してください。
どのようなイベントが発生した時に、 どのようなメディアを通じて、 どのようなメッセージを送りたいか?例えば、 IMBox では、(1) Direct Messageを受信した時に、(2) 「IM-Notice」と「メール」を通じて、(3) Direct Messageを受信したことを伝えるメッセージを配信しています。今回のサンプルでは、以下のようなメッセージを配信することとします。
SampleMessageEvent が発生した時に、 IMBox の ApplicationBox を通じて、 SampleMessageEvent が発生したことを伝えるメッセージ全体の作業手順は以下の通りです。
表: IM-MessageHub を利用してメッセージを配信するための作業手順 手順 作成する資材 作業解説 1 配信の契機を表すイベントクラス(図中の Event )
- イベントクラス
イベントを定義する 2 配信するメッセージのテンプレート(図中の TemplateFile )
- テンプレートファイル(日本語、英語、中国語)
テンプレートを定義する 3 配信するメッセージ(図中の Message )
- メッセージを作成する処理
メッセージを作成する 4 配信処理を依頼するサービスクラス(図中の MessageService )
- メッセージの配信を IM-MessageHub へ依頼する処理
メッセージを配信する 5 配信処理を実際に行うクライアント(図中の Client )
- 配信処理を行うクライアントアプリケーション
サンプルの動作を確認する なお、流れに合わせてサンプルを実装し、実際に動作確認を行う際の前提条件は「 サンプルコードについて 」を参照してください。