@salesforce モジュール

@salesforce の範囲が設定されたモジュールでは、実行時に Lightning Web コンポーネントに機能が追加されます。

lightning/uiRecordApi のように @salesforce なしでインポートされたモジュールには、変更されずにすべての組織に対してユニバーサルなリソースが含まれます。

モジュールによっては、モジュール識別子のセットが固定であるものがあります。たとえば @salesforce/i18n モジュールでは、@salesforce/i18n/dir や @salesforce/i18n/lang を含む多数の識別子がサポートされます。

モジュールによっては、モジュール識別子のセットが動的であるものがあります。このセットは、組織のメタデータで定義されます。たとえば、@salesforce/schema は、組織のオブジェクトと項目にアクセスします。

@salesforce/apex から Apex メソッドをインポートします。インポートされたメソッドは、コンポーネントが @wire を使用して、または命令としてコールできる関数です。「Apex メソッドのコール」を参照してください。

• apexMethodName — Apex メソッドを識別する記号。
• apexMethodReference — インポートする Apex メソッドの名前。
• Classname — Apex クラスの名前。
• Namespace — Salesforce 組織の名前空間。組織がデフォルトの名前空間 (c) を使用していない場合は名前空間を指定します。使用している場合は名前空間を指定しないでください。
• apexMethodParams — 必要に応じて apexMethod のパラメーターと一致するプロパティを含むオブジェクト。パラメーター値が null の場合、メソッドがコールされます。パラメーター値が undefined の場合、メソッドはコールされません。Apex メソッドをオーバーロードしている場合、コールするメソッドの選択は非決定的 (実質的にランダム) であり、渡されたパラメーターにより現在エラーが発生しているか、その後発生する可能性があります。@AuraEnabled Apex メソッドをオーバーロードしないでください。

propertyOrFunction — ワイヤーサービスからデータのストリームを受信する非公開のプロパティまたは関数。プロパティが @wire でデコレートされている場合、結果はそのプロパティの data プロパティまたは error プロパティに返されます。関数が @wire でデコレートされている場合、結果は data プロパティまたは error プロパティを持つオブジェクトで返されます。

@salesforce/apex から getSObjectValue をインポートします。このメソッドをコールすると、Apex メソッドで取得されたオブジェクトから項目値を取得できます。

• sObject — Apex メソッドから返されるオブジェクト。

• fieldApiName — 項目の API 参照名。値は文字列、または @salesforce/schema からインポートされた項目への参照にすることができます。最大 5 レベルの拡張項目を指定できます。たとえば、Opportunity.Account.CreatedBy.LastModifiedById は 4 レベルの拡張項目を返します。

@salesforce/apex から refreshApex をインポートします。このメソッドをコールすると、Apex によって返される更新データについてサーバーを照会し、ワイヤープロパティのキャッシュを更新できます。

• {valueProvisionedByApexWireService} が、Apex @wire が付加されたプロパティまたは結び付けられた関数で受け取る引数 (関数にアノテーションを付加した場合) の場合。

@salesforce/apexContinuation から Apex メソッドをインポートします。

• apexMethodName — Apex メソッドを識別する記号。
• apexMethodReference — インポートする Apex メソッドの名前。
• Classname — Apex クラスの名前。
• Namespace — クラスがコンポーネントと同じ名前空間にある場合、名前空間を指定しません。クラスが管理パッケージ内にある場合、管理パッケージの名前空間を指定します。

「継続を使用した長時間コールアウトの実行」を参照してください。

• formFactorPropertyName — ブラウザーを実行しているハードウェアのフォーム要素を参照する名前。可能な値は次のとおりです。
  • Large — デスクトップクライアント。
  • Medium — タブレットクライアント。
  • Small — 電話クライアント。

getRecordCreateDefaults ワイヤーアダプターにフォーム要素を渡し、レコードを作成するためのデフォルトのレイアウト情報とオブジェクト情報を取得します。

@salesforce/community/Id から現在のエクスペリエンスビルダーサイトのネットワーク ID をインポートします。

@salesforce/community/basePath からエクスペリエンスビルダーサイトのベース URL をインポートします。

ベースパスは、ドメインの後に続くサイトの URL のセクションです。サイトドメイン名が UniversalTelco.force.com で、サイトを作成したときに追加された URL 値が myPartnerSite の場合、コミュニティの URL は UniversalTelco.force.com/myPartnerSite/s です。この場合、myPartnerSite/s がベースパスです。

「現在のエクスペリエンスビルダーサイトに関する情報の取得」を参照してください。

@salesforce/contentAssetUrl からコンテンツアセットファイルをインポートします。

• myContentAsset — アセットファイルを参照する名前。

• contentAssetReference — アセットファイルの名前。

  アセットファイル名には、アンダースコアと英数字のみ使用できます。また、アセットファイル名は、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。

• namespace — アセットファイルが管理パッケージ内にある場合、この値は管理パッケージの名前空間です。

「コンテンツアセットファイルへのアクセス」を参照してください。

@salesforce/i18n から Internationalization プロパティをインポートします。

• internationalizationPropertyName — internationalization プロパティを識別する記号。

• internationalizationProperty — Internationalization プロパティ。

internationalization プロパティは、「Internationalization プロパティへのアクセス」に記載されています。

@salesforce/label から Salesforce 組織の表示ラベルをインポートします。

• labelName — 表示ラベルを参照する名前。
• labelReference — 組織の表示ラベルの名前。形式は namespace.labelName です。この形式が使用されるのは、Visualforce やその他の Salesforce テクノロジーの管理パッケージで使用される形式と同じであるからです。これと同じ形式を使用すると、アクセス元の場所にかかわらず、表示ラベル myns.labelName にアクセスできます。

「表示ラベルへのアクセス」を参照してください。

Lightning Message Service 経由で通信するためにコンポーネントが使用する Lightning メッセージチャネルをインポートします。

• channelName — メッセージチャネルを識別する記号。

• channelReference — メッセージチャネルの API 参照名。

• namespace — メッセージチャネルが管理パッケージ内にある場合は、この値は管理パッケージの名前空間です。メッセージチャネルが管理パッケージ内にない場合は、名前空間を含めないでください。

「メッセージチャネルの作成」を参照してください。

@salesforce/resourceUrl から Salesforce 組織の静的リソースをインポートします。

• myResource — 静的リソースを参照する名前。

• resourceReference — 静的リソースの名前。

  静的リソース名には、アンダースコアと英数字のみ使用できます。また、静的リソース名は、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。

• namespace — 静的リソースが管理パッケージ内にある場合、この値は管理パッケージの名前空間となります。

「静的リソースへのアクセス」を参照してください。

@salesforce/schema から Salesforce オブジェクトおよび項目への参照をインポートします。

• objectName — Salesforce オブジェクトを識別する記号。
• objectReference — Salesforce オブジェクトの名前。
• fieldName — Salesforce 項目を識別するインポートされた記号。
• fieldReference — Salesforce 項目の名前。最大 5 レベルの拡張項目を指定できます。たとえば、Account.Owner.Name は 3 レベルの拡張項目を返します。
• namespace — オブジェクトまたは項目が管理パッケージ内にある場合は、この値は管理パッケージの名前空間です。

「Salesforce オブジェクトと項目への参照のインポート」を参照してください。

@salesforce/site/Id から現在のエクスペリエンスビルダーサイトのサイト ID をインポートします。

@salesforce/site/activeLanguages からエクスペリエンスビルダーサイトの有効な言語のリストをインポートします。

エクスペリエンスビルダーサイトの有効な言語のリストには、デフォルトのサイト言語とその他のすべての有効な言語に関するメタデータが含まれています。エクスペリエンスビルダーのサイトの言語は、[設定] | [言語] で設定できます。無効な言語はリストから除外されます。戻り値は言語オブジェクトの配列です。各オブジェクトには、言語の表示ラベルとコード (en-US など) が含まれています。配列はラベルのアルファベット順に並び替えられます。

「現在のエクスペリエンスビルダーサイトに関する情報の取得」を参照してください。

@salesforce/user/Id から現在のユーザーの ID をインポートします。

userId — Salesforce ユーザー ID を識別するインポートされた記号。

ユーザーがゲストユーザーであるかどうかを確認するには、@salesforce/user/isGuest から現在のユーザーの状況をインポートします。

isGuestUser — ユーザーがゲストユーザーであるのか (true)、ゲストユーザーでないのか (false) を識別する記号。

「現在のユーザーに関する情報の取得」を参照してください。

権限をインポートし、現在のユーザーに割り当てられているかどうかを確認します。

• hasPermission — 現在のユーザーがインポートされた権限を持っているか (true)、否か (undefined) を示す Boolean。

• Permission — Salesforce ユーザー権限の名前。

「権限の確認」を参照してください。

カスタム権限をインポートし、現在のユーザーに割り当てられているかどうかを確認します。

• hasPermission — 現在のユーザーがインポートされた権限を持っているか (true)、否か (undefined) を示す Boolean。

• Permission — Salesforce カスタム権限の名前。

「権限の確認」を参照してください。