Message (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.message_hub.model.Message

すべての実装されたインタフェース:: Serializable, Extensible

public class Message
extends Object
implements Extensible, Serializable

メッセージの配信を行うためのメッセージモデルです。
アプリケーションは、このモデルのインスタンスを生成して、 MessageService.send() を実行してください。

メッセージモデルに、以下のプロパティを指定します。

プロパティ	プロパティ名	説明	必須
id	メッセージID	１回の配信に対して割り振られるユニークなIDです。自動で採番されます。	-
event	イベント	このメッセージの配信タイミングを表すイベントモデルです。	◯
from	送信者	送信したユーザ等を表すモデルです。	×
to	宛先	配信先のユーザ等を表すモデルのリストです。	◯
attribute	属性	追加で設定可能な情報です。配信先メディア等によって必要な情報が変わります。	×

属性情報

配信処理で共通的に利用するため、以下の属性が表示で設定されます。

属性名	jp.co.intra_mart.message_hub.baseUrl
設定値	ベースURL。解決できなかった場合は、`null` が設定されます。

バージョン:: 8.0.0
関連項目:: 直列化された形式

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`Message(Event event)` コンストラクタ。
`Message(Event event, Address from)` コンストラクタ。
`Message(Event event, Address from, Address to)` コンストラクタ。
`Message(Event event, Address from, Address to, Map<String,Object> attributes)` コンストラクタ。
`Message(Event event, Address from, List<Address> to)` コンストラクタ。
`Message(Event event, Address from, List<Address> to, Map<String,Object> attributes)` コンストラクタ。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addTo(Address to)` 宛先を追加します。
`<T> T`	`getAttribute(String name)` 属性を取得します。
`Set<String>`	`getAttributeNames()` 属性名を全て取得します。
`Map<String,Object>`	`getAttributes()` すべての属性を取得します。
`Event`	`getEvent()` イベントを取得します。
`<T> T`	`getExtension(Class<T> extensionType)` 指定したモデル拡張クラスに変換します。
`Address`	`getFrom()` 送信者を取得します。
`String`	`getId()` メッセージIDを取得します。
`List<Address>`	`getTo()` 宛先リストを取得します。
`void`	`setAttribute(String name, Object value)` 属性を設定します。
`void`	`setAttributes(Map<String,Object> attributes)` 属性を設定します。
`void`	`setFrom(Address from)` 送信者を設定します。
`void`	`setTo(List<Address> to)` 宛先リストを設定します。
`String`	`toString()`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - Message
```
public Message(Event event)
```
    コンストラクタ。
    メッセージIDにユニークなメッセージIDが設定されます。
    
    パラメータ:
    
    event - イベント
  - Message
```
public Message(Event event,
               Address from)
```
    コンストラクタ。
    メッセージIDにユニークなメッセージIDが設定されます。
    
    パラメータ:
    
    event - イベント
    
    from - 送信者
  - Message
```
public Message(Event event,
               Address from,
               Address to)
```
    コンストラクタ。
    メッセージIDにユニークなメッセージIDが設定されます。
    
    パラメータ:
    
    event - イベント
    
    from - 送信者
    
    to - 宛先
  - Message
```
public Message(Event event,
               Address from,
               Address to,
               Map<String,Object> attributes)
```
    コンストラクタ。
    メッセージIDにユニークなメッセージIDが設定されます。
    
    パラメータ:
    
    event - イベント
    
    from - 送信者
    
    to - 宛先
    
    attributes - 属性
  - Message
```
public Message(Event event,
               Address from,
               List<Address> to)
```
    コンストラクタ。
    メッセージIDにユニークなメッセージIDが設定されます。
    
    パラメータ:
    
    event - イベント
    
    from - 送信者
    
    to - 宛先リスト
  - Message
```
public Message(Event event,
               Address from,
               List<Address> to,
               Map<String,Object> attributes)
```
    コンストラクタ。
    メッセージIDにユニークなメッセージIDが設定されます。
    
    パラメータ:
    
    event - イベント
    
    from - 送信者
    
    to - 宛先リスト
    
    attributes - 属性
- メソッドの詳細
  - addTo
```
public void addTo(Address to)
```
    宛先を追加します。
    
    パラメータ:
    
    to - 宛先
  - getAttribute
```
public <T> T getAttribute(String name)
```
    属性を取得します。
    
    型パラメータ:
    
    T - 返却クラス型
    
    パラメータ:
    
    name - 属性名
    
    戻り値:
    
    属性値
  - getAttributeNames
```
public Set<String> getAttributeNames()
```
    属性名を全て取得します。
    
    戻り値:
    
    属性名リスト
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    すべての属性を取得します。
    
    戻り値:
    
    すべての属性
  - getEvent
```
public Event getEvent()
```
    イベントを取得します。
    
    戻り値:
    
    イベント
  - getExtension
```
public <T> T getExtension(Class<T> extensionType)
```
    インタフェースからコピーされた説明: Extensible
    
    指定したモデル拡張クラスに変換します。
    
    モデル拡張クラスに変換できない場合は、nullを返却します。
    
    定義:
    
    getExtension インタフェース内 Extensible
    
    型パラメータ:
    
    T - モデル拡張クラスの型
    
    パラメータ:
    
    extensionType - モデル拡張クラス
    
    戻り値:
    
    モデル拡張クラスのインスタンス
  - getFrom
```
public Address getFrom()
```
    送信者を取得します。
    
    戻り値:
    
    送信者
  - getId
```
public String getId()
```
    メッセージIDを取得します。
    
    戻り値:
    
    メッセージID
  - getTo
```
public List<Address> getTo()
```
    宛先リストを取得します。
    
    戻り値:
    
    宛先リスト
  - setAttribute
```
public void setAttribute(String name,
                         Object value)
```
    属性を設定します。
    属性名がnullである場合は属性値は設定されません。
    
    パラメータ:
    
    name - 属性名
    
    value - 属性値
  - setAttributes
```
public void setAttributes(Map<String,Object> attributes)
```
    属性を設定します。
    このメソッドを利用した場合、既に設定されている属性は引数の属性に置き換えられます。
    
    パラメータ:
    
    attributes - 属性
  - setFrom
```
public void setFrom(Address from)
```
    送信者を設定します。
    
    パラメータ:
    
    from - 送信者
  - setTo
```
public void setTo(List<Address> to)
```
    宛先リストを設定します。
    このメソッドを利用した場合は既に設定されている宛先リストは引数の宛先リストに置き換えられます。
    
    パラメータ:
    
    to - 宛先リスト
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object

クラス Message

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

Message

Message

Message

Message

Message

Message

メソッドの詳細

addTo

getAttribute

getAttributeNames

getAttributes

getEvent

getExtension

getFrom

getId

getTo

setAttribute

setAttributes

setFrom

setTo

toString