この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Salesforce コンソールインテグレーションツールキット開発者ガイド

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

コンソールイベントのメソッド

コンソールで特定のタイプのイベント (ユーザがタブを閉じた場合など) が発生したときに、JavaScript を実行できます。次の標準イベントがサポートされます。
イベント 説明 ペイロード
sforce.console.ConsoleEvent.OPEN_TAB 主タブまたはサブタブが開かれると起動します。API バージョン 30.0 以降で使用できます。
  • id — 開かれたタブの ID。
  • objectId — 開かれたタブのオブジェクト ID (使用可能な場合)。
sforce.console.ConsoleEvent.CLOSE_TAB additionalParams 引数に指定された ID を持つ主タブまたはサブタブが閉じられたときに起動します。または、指定された ID を持たない主タブまたはサブタブが閉じられたときに起動します。API バージョン 30.0 以降で使用できます。
  • id — 閉じられたタブの ID。
  • objectID — 閉じられたタブのオブジェクト ID (使用可能な場合)。
sforce.console.ConsoleEvent.CONSOLE_LOGOUT ユーザが [ログアウト] をクリックしたときにコンソールのログアウトの実行を遅延します。[ログアウト] をクリックすると、次の処理が実行されます。
  1. フロート表示が開き、ユーザにログアウトの処理中であることを伝えます。
  2. sforce.console.ConsoleEvent.CONSOLE_LOGOUT を使用して登録されているコールバックが実行されます。
  3. コンソールログアウトロジックが実行されます。

コールバックに同期ブロックコードが含まれている場合、コンソールログアウトコードは、ブロックコードが実行されるまで実行されません。ベストプラクティスとして、同期ブロックコードまたはログアウト時の長時間のコード実行は避けてください。

API バージョン 31.0 以降で使用できます。

なし
コンソールイベントには、次のメソッドを使用できます。
メソッド 説明
addEventListener() イベントが起動されると、カスタムイベントタイプまたは標準イベントタイプのリスナーを追加します。このメソッドは、API バージョン 25.0 以降ではカスタムイベントタイプのリスナーを追加し、API バージョン 30.0 以降では標準イベントタイプのリスナーを追加します。
fireEvent() カスタムイベントを起動します。このメソッドは、API バージョン 25.0 以降でのみ使用できます。
removeEventListener() カスタムイベントタイプまたは標準イベントタイプのリスナーを削除します。このメソッドは、API バージョン 25.0 以降ではカスタムイベントタイプのリスナーを削除し、API バージョン 30.0 以降では標準イベントタイプのリスナーを削除します。