Alier.message()

メッセージオブジェクトを作成します。

構文

Alier.message(id, code, param, origin) => object 

引数

• id: string （省略可）

  メッセージの識別子です。 メッセージの処理を決めるために利用されます。

• code: string （省略可）

  メッセージの追加の識別子です。 idとは別でメッセージの処理を決めるために利用されます。

• param: any （省略可）

  メッセージに含めるパラメータです。

• origin: object （省略可）

  メッセージの生成元です。 メッセージを中継したときに、どこから発信されたか特定するために利用されます。

返値: object

引数をまとめたメッセージです。

• id: string | null

  引数 id として指定された文字列です。指定されなかった場合、null が設定されます。

• code: string | null

  引数 code として指定された文字列です。指定されなかった場合、null が設定されます。

• param: any | null

  引数 param として指定された任意の値です。指定されなかった場合、null が設定されます。

• origin: object | null

  引数 origin として指定されたオブジェクトです。指定されなかった場合、null が設定されます。

例

const messagePorter = new MessagePorter();

//  メッセージを生成する
const message = Alier.message(
    /* id     = */ "foo",
    /* code   = */ "bar",
    /* param  = */ { key: "value" },
    /* origin = */  null
);

//  messagePorter にリスナーを追加する
messagePorter.addListener(message => console.log(message));

//  messagePorter にメッセージを送る
messagePorter.post(message);
//  ==> "[object Object] { id: "foo", code: "bar", param: { key: "value" }, origin: null }"

解説

オブジェクトへ送信するメッセージを生成します。

生成されたメッセージは何らかの操作を依頼したり状態変更やイベントの発生を通知したりするために利用されます。 メッセージにはその種別や生成元および送信先を識別するための識別子と、操作の実行に必要なパラメータや状態変更の詳細を示す値が含まれます。 メッセージを受信する側は、必要に応じて識別子を検査し、メッセージに含まれるパラメータを利用できます。

作成したメッセージオブジェクトは以下のメソッドに渡すことができます。

• MessagePorter.post()
• ProtoViewLogic.post()
• ProtoViewLogic.broadcast()