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

aura:method

<aura:method> を使用して、コンポーネントの API の一部としてメソッドを定義します。これにより、コンポーネントイベントを起動して処理する代わりに、コンポーネントのクライアント側コントローラからメソッドを直接コールできるようになります。<aura:method> を使用すると、親コンポーネントに含まれる子コンポーネントのメソッドをコールする場合に、親コンポーネントに必要なコードが簡略化されます。

<aura:method> タグには、次のシステム属性があります。

属性 説明
name String メソッド名。メソッド名を使用して、JavaScript コードのメソッドをコールします。次に例を示します。
action Expression 実行するクライアント側のコントローラアクション。次に例を示します。

sampleAction はクライアント側コントローラのアクションです。action の値を指定しない場合、コントローラアクションは、デフォルトのメソッドの name の値に設定されます。

access String メソッドのアクセス制御。有効な値は、次のとおりです。
  • public — 同じ名前空間のコンポーネントはメソッドをコールできます。これはデフォルトのアクセスレベルです。
  • global — どの名前空間のコンポーネントもメソッドをコールできます。
description String メソッドの説明。

パラメータの宣言

<aura:method> には、必要に応じてパラメータを含めることができます。<aura:method> 内で <aura:attribute> タグを使用して、メソッドのパラメータを宣言します。次に例を示します。

パラメータの <aura:attribute> タグに access システム属性は必要ありません。

メモ

ハンドラアクションの作成

このハンドラアクションでは、メソッドに渡される引数へのアクセス方法を示します。

event.getParam('arguments') を使用して引数を取得します。引数がある場合はオブジェクト、引数がない場合は空の配列が返されます。

戻り値

aura:method は同期して実行されます。

  • 同期メソッドは、返す前に実行を終了します。同期 JavaScript コードから値を返すには、return ステートメントを使用します。「同期コードの結果を返す」を参照してください。
  • 非同期メソッドは返した後も実行を続ける場合があります。非同期 JavaScript コードから値を返すには、コールバックを使用します。「非同期コードの結果を返す」を参照してください。