Lightning コンポーネント開発者ガイド
jインターフェースの参照
これらのプラットフォームインターフェースを実装し、コンポーネントをさまざまなコンテキストで使用したり、コンポーネントで追加のコンテキストデータを受信したりできます。コンポーネントは、複数のインターフェースを実装できます。インターフェースのなかには、一緒に実装するものと、相互に排他的なものがあります。また、Lightning Experience と Salesforce アプリケーションにのみ影響するインターフェースもあります。
リファレンスドキュメントは、次のリンクのコンポーネントライブラリにあります。
- 認証されていない環境は developer.salesforce.com/docs/component-library です。
- 認証された環境は https://<myDomain>.lightning.force.com/componentReference/suite.app で、<myDomain> はユーザのカスタム Salesforce ドメインの名前です。
インターフェースは、次をはじめとするさまざまな名前空間に属します。
- クライアント
- Lightning for Outlook または Lightning for Gmail に固有のインターフェースを提供します。
- flexipage
- Lightning ページおよび Lightning アプリケーションビルダーに固有のインターフェースを提供します。
- force
- Lightning Experience および Salesforce アプリケーションに固有のインターフェースを提供します。
- forceCommunity
- コミュニティに固有のインターフェースを提供します。
- lightning
- Lightning Experience、Salesforce アプリケーション、およびコミュニティに固有のインターフェースを提供します。
- ltng
- Lightning Out で処理されるイベントを提供します。
これらのインターフェースの一部の概要を次に示します。完全なリストについては、「コンポーネントライブラリ」を参照してください。
- clients:availableForMailAppAppPage
- Lightning アプリケーションビルダー、Lightning for Outlook または Lightning for Gmail の Lightning ページに表示するには、コンポーネントに clients:availableForMailAppAppPage インターフェースを実装する必要があります。詳細は、「Lightning for Outlook および Lightning for Gmail のコンポーネントの作成」を参照してください。
- clients:hasEventContext
- Lightning for Outlook および Lightning for Gmail で行動の日付または場所属性にコンポーネントが割り当てられるようにします。詳細は、「Lightning for Outlook および Lightning for Gmail のコンポーネントの作成」を参照してください。
- clients:hasItemContext
- Lightning for Outlook および Lightning for Gmail でメールまたは行動の項目属性にコンポーネントが割り当てられるようにします。詳細は、「Lightning for Outlook および Lightning for Gmail のコンポーネントの作成」を参照してください。
- flexipage:availableForAllPageTypes
- Lightning アプリケーションビルダーやあらゆる Lightning ページのタイプに対応するコンポーネントを作成するグローバルインターフェースです。詳細は、「Lightning ページと Lightning アプリケーションビルダーのコンポーネントの設定」を参照してください。
- ユーティリティバーに表示するには、コンポーネントに flexipage:availableForAllPageTypes インターフェースを実装する必要があります。詳細は、Salesforce ヘルプの「Lightning アプリケーションへのユーティリティバーの追加」を参照してください。
- flexipage:availableForRecordHome
- コンポーネントがレコードページ専用に設計されている場合は、flexipage:availableForAllPageTypes の代わりに flexipage:availableForRecordHome インターフェースを実装します。詳細は、「Lightning Experience のレコードホームページのコンポーネントの設定」を参照してください。
- forceCommunity:availableForAllPageTypes
- コミュニティビルダーに表示するには、コンポーネントに forceCommunity:availableForAllPageTypes インターフェースを実装する必要があります。詳細は、「コミュニティのコンポーネントの設定」を参照してください。
- force:appHostable
- Lightning Experience または Salesforce アプリケーションでコンポーネントがカスタムタブとして使用されるようにします。詳細は、「Lightning Experience アプリケーションのカスタムタブとしての Lightning コンポーネントの追加」を参照してください。
- force:lightningQuickAction
- [キャンセル] ボタンなどの標準アクションコントロールがあるパネルにコンポーネントを表示できるようにします。これらのコンポーネントにも専用のコントロールを表示および実装できますが、標準コントロールからのイベントを処理する必要があります。force:lightningQuickAction を実装する場合は、同じコンポーネント内に force:lightningQuickActionWithoutHeader を実装できません。詳細は、「カスタムアクション用のコンポーネントの設定」を参照してください。
- force:lightningQuickActionWithoutHeader
- 追加のコントロールなしでパネルにコンポーネントを表示できるようにします。このコンポーネントは、アクションの完全なユーザインターフェースを提供します。force:lightningQuickActionWithoutHeader を実装する場合は、同じコンポーネント内に force:lightningQuickAction を実装できません。詳細は、「カスタムアクション用のコンポーネントの設定」を参照してください。
- ltng:allowGuestAccess
- Lightning Out 連動関係アプリケーションに ltng:allowGuestAccess インターフェースを追加すると、ユーザは Salesforce の認証を行わずにそのアプリケーションにアクセスできます。このインターフェースでは、Lightning コンポーネントを含むアプリケーションを作成し、あらゆる場所のすべてのユーザにリリースできます。詳細は、「未認証ユーザとの Lightning Out アプリケーションの共有」を参照してください。