force:hasRecordId
force:hasRecordId インターフェースを Lightning コンポーネントに追加すると、現在のレコードの ID をコンポーネントに割り当てることができます。現在の���コード ID は、Lightning Experience または Salesforce アプリケーションのオブジェクト固有のカスタムアクションやアクション上書きなどとして、コンポーネントを Lightning レコードページで使用する場合に便利です。このインターフェースは、Lightning Experience、Salesforce アプリケーション、およびテンプレートベースのコミュニティ内で使用される場合以外は影響しません。
このインターフェースはマーカーインターフェースです。マーカーインターフェースは、インターフェースの動作をコンポーネントに追加するよう伝える、コンポーネントのコンテナへの信号です。コンポーネントに特定のメソッドまたは属性を実装する必要はありません。コンポーネントの implements 属性にインターフェース名を追加するだけです。
force:hasRecordId インターフェースは、このインターフェースを実装するコンポーネントに対して 2 つのことを行います。
-
recordId という名前の属性をコンポーネントに追加します。この属性は文字列型であり、その値は 18 文字の Salesforce レコード ID (001xx000003DGSWAA4 など) です。これを自分で追加した場合、属性の定義は次のようなマークアップになります。
1<aura:attribute name="recordId" type="String" /> - Lightning Experience または Salesforce アプリケーションのレコードコンテキストでコンポーネントを呼び出す場合、recordId を、表示するレコードの ID に設定します。
例
次の例に、force:hasRecordId インターフェースを Lightning コンポーネントに追加するために必要なマークアップを示します。
1<aura:component implements="force:lightningQuickAction,force:hasRecordId">
2
3 <!-- ... -->
4
5</aura:component>コンポーネントのコントローラは、component.get("v.recordId") を使用して、recordId 属性から現在のレコードの ID にアクセスできます。recordId 属性は、force:hasRecordId インターフェースによって自動的にコンポーネントに追加されます。