メッセージの宛先変更画面を表示したときのイベント

目次

メッセージの宛先変更画面を表示したときのイベント

メッセージの宛先変更画面を表示したときに発生するイベントです。

イベントタイプ イベントが発生するタイミング
message.body.changeTo.show メッセージの宛先変更画面を表示したとき

利用できるバージョン

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

イベントオブジェクトのプロパティ

プロパティ名 説明
type 文字列 イベントタイプ
「message.body.changeTo.show」が返ります。
body オブジェクト 画面上の情報を保持したメッセージオブジェクト
body.draft 真偽値 下書きかどうか *1
  • true:表示中の画面が「下書きの編集/送信」画面
  • false:それ以外の画面
body.recipients 配列(オブジェクト) 宛先の一覧
body.recipients[].id 文字列 宛先のGaroonユーザーID
body.recipients[].type 文字列 宛先のタイプ
USERが返ります。
body.recipients[].code 文字列 宛先のログイン名
パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。
詳細は ユーザー情報の項目を変更する (External link) を参照してください。
body.recipients[].name 文字列 宛先の表示名

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

イベントオブジェクトで実行できる操作