メッセージの値をセットする

目次

メッセージの値をセットする

現在開いているメッセージの値をセットします。
onclickやonchangeなどのJavaScriptのイベントハンドラー内で実行できます。

関数

garoon.message.body.set(body)

利用できるバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 5.0以降

引数

引数 必須 説明
recipients 配列(オブジェクト) 必須 宛先の一覧
recipients[].id 文字列 条件必須 宛先のGaroonユーザーID
recipients[].idまたはrecipients[].codeが必須です。
両方を指定すると、recipients[].idの値が設定されます。
recipients[].code 文字列 条件必須 宛先のログイン名
recipients[].idまたはrecipients[].codeが必須です。
両方を指定すると、recipients[].idの値が設定されます。
パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。
詳細は ユーザー情報の項目を変更する (External link) を参照してください。
recipients[].name 文字列 省略可 宛先の表示名
recipients[].type 文字列 必須 宛先のタイプ
USERを指定します。

戻り値

なし

利用できる画面

  • メッセージの作成画面
  • メッセージの再利用画面
  • メッセージの宛先変更画面
  • 下書きの編集/送信画面 *1

*1 クラウド版、パッケージ版Garoon 5.9以降 ^

サンプルコード

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
const body = {
  recipients: [
    {
      code: 'sato-noboru',
      name: 'Sato Noboru',
      type: 'USER'
    }
  ]
};

garoon.message.body.set(body);

注意事項

  • garoon.events.on()のイベントハンドラー内では、この関数を実行できません。
    イベントハンドラー内で、メッセージの値を設定する場合には、イベントハンドラーの引数として渡されるイベントオブジェクトを利用してください。