intra-mart Accel Platform IM-MessageHub プログラミングガイド 第2版 2015-12-01

5.2. 配信先メディアを定義する

最初に、 IM-MessageHub が受け付けたメッセージを配信する新しい配信先メディアを定義します。
新しく配信先メディアを定義するためには、プラグインファイル(plugin.xml)を作成する必要があります。
作成するプラグインファイル(plugin.xml)の定義例は以下の通りです。
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
<?xml version="1.0" encoding="UTF-8"?>
<plugin>
    <extension point = "jp.co.intra_mart.message_hub.DeliveryMedias">
        <delivery-media
                id = "immh.sample.delivery" 
                name-key = "CAP.Z.SAMPLE.APPLICATION.NAME" 
                name = "Sample Delivery Media" 
                deliverer-class ="sample.message_hub.delivery.SampleMessageDeliverer" 
                version = "8.0.0" 
                rank = "100" />
    </extension>
</plugin>
表:タグおよび属性の詳細
設定名称 説明
拡張ポイント
jp.co.intra_mart.message_hub.DeliveryMedias 固定です。
id
この配信先メディアを一意に表すユニークなIDを指定します。
name-key
表示名を定義したメッセージファイルのプロパティキー名を指定します。
name
表示名がメッセージファイルより解決できなかった場合の表示名を指定します。
英語で指定することを推奨します。
deliverer-class
後述する「 配信クラスを作成する 」にて作成した配信クラスの完全修飾クラス名(FQCN)を指定します。
version
この定義のバージョン情報を指定します。
rank
この定義の実行順序を指定します。
deliverer-class 属性で定義した配信クラスの実行順序に利用されます。

なお、 intra-mart Accel Platform が提供している配信先メディアに設定されている rank の値は「 配信先メディア一覧 」を参照してください。

5.2.1. 配信先メディアに紐づく詳細な配信設定

IM-MessageHub では、配信先メディアに紐づく詳細な配信設定を行うことが可能です。
  • 設定例

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    <?xml version="1.0" encoding="UTF-8"?>
    <plugin>
        <extension point = "jp.co.intra_mart.message_hub.DeliveryMedias">
            <delivery-media id = "..."  />
                <description>...</description>
    
                <display-setting
                    visible = "true" 
                    order = "10" 
                    initial-check-state = "checked" 
                    allow-user-settings = "false" 
                />
    
            </delivery-media>
        </extension>
    </plugin>
    
表:属性の詳細
設定項目 説明
visible
配信先メディアに紐づく配信設定をユーザに対して表示するか否かを設定します。
設定可能な値は以下の通りです。
  • true - 表示する
  • false - 表示しない
未設定の場合は、true (表示する)となります。
あわせて「 配信設定の表示可否(visible)の優先順位 」を参照してください。
order
配信先メディアの表示順を設定します。
正の整数値を指定してください。

未設定の場合は、9999 となります。
この値は、メッセージ通知設定画面での表示順として利用されます。
詳しくは「 メッセージ通知設定画面 」の「 画面項目 」を参照してください。

なお、 intra-mart Accel Platform が提供している配信先メディアに設定されている order の値は「 配信先メディア一覧 」を参照してください。
initial-check-state
配信先メディアに紐づく配信可否の初期値を設定します。
設定可能な値は以下の通りです。
  • checked - 配信を行う
  • unchecked - 配信を行わない
未設定の場合は、メッセージ通知設定の初期値が有効となります。
allow-user-settings
配信先メディアに紐づく配信設定の変更をユーザに対して許可するか否かを設定します。
設定可能な値は以下の通りです。
  • true - ユーザ変更可能
  • false - ユーザ変更不可能
未設定の場合は、true (ユーザ変更可能)となります。
あわせて「 配信設定の表示可否(visible)の優先順位 」を参照してください。