NavigationUtils ReadMe (管理パッケージ)
管理パッケージランタイムの場合、このページには各 Vlocity リリースの NavigationUtils ReadMe が含まれます。
この情報は、OmniStudio for Managed Packages 用です。標準ランタイムの OmniStudio については、OmniStudio ヘルプを参照してください。
new exports.PageReference(type, attributes, [stateParams])
Lightning Experience、Lightning コミュニティ、または Salesforce モバイル アプリケーション内を移動するには、PageReference オブジェクトを定義します。PageReference 種別は、一意の URL 形式を生成し、その種別のすべてのページに適用される属性を定義します。
パラム |
種別 |
説明 |
|---|---|---|
type |
PageReferenceType |
ページ参照種別。 |
属性 |
オブジェクト |
ページ参照属性。 |
[stateParams] |
string ⎮ any |
対象コンテキストに渡される状態パラメーター。URL クエリ文字列またはオブジェクトの形式で指定できます。 |
PageReference.unfreeze(pageReference, newParams)
@wire(CurrentPageReference) から返された PageReference オブジェクトの凍結を解除および更新するユーティリティメソッドが凍結される
種別: PageReference の静的メソッド
パラム |
種別 |
説明 |
|---|---|---|
pageReference |
PageReference |
@wire(CurrentPageReference) から受信したページ参照オブジェクト |
newParams |
string ⎮ any |
[stateParams] - 現在の参照で拡張される状態パラメーター。URL クエリ文字列またはオブジェクトの形式で指定できます。 |
new exports.AppPageReference(appTarget, pageReference)
組織のアプリケーションランチャーから使用できる標準アプリケーションまたはカスタムアプリケーション。この種別を使用して、ユーザーを特定のアプリケーションまたはアプリケーション内のページに誘導するカスタムナビゲーションコンポーネントを作成します。接続アプリケーションはサポートされていません。
パラム |
種別 |
説明 |
|---|---|---|
appTarget |
string |
移動先のアプリケーション。 |
pageReference |
PageReference |
移動先のアプリケーション内の特定の場所を識別します。 |
ns/navigationUtils.ComponentPageReference
種類: ns/navigationUtils の静的クラス サポート: Lightning Experience、Salesforce モバイルアプリケーション
new exports.ComponentPageReference(name, [stateParams])
Lightning コンポーネント。アドレス指定可能な Lightning Web コンポーネントを作成するには、lightning:isUrlAddressable インタフェースを実装する Aura コンポーネントに組み込みます。
パラム |
種別 |
説明 |
|---|---|---|
name |
string |
namespace__componentName 形式の Lightning コンポーネント名 |
[stateParams] |
string ⎮ オブジェクト |
対象コンテキストに渡される状態パラメーター。URL クエリ文字列またはオブジェクトの形式で指定できます。 |
new exports.KnowledgeArticlePageReference(articleType, urlName)
Knowledge Article レコードを操作するページ。
パラム |
種別 |
説明 |
|---|---|---|
articleType |
string |
Knowledge Article レコードの articleType API 参照名。コミュニティでは、articleType は無視されます。 |
urlName |
string |
対象 KnowledgeArticleVersion レコードの urlName 項目の値。urlName は記事の URL です。 |
new exports.LoginPageReference(action, [stateParams])
コミュニティへの認証のページ。
パラム |
種別 |
説明 |
|---|---|---|
action |
'login' ⎮ 'logout' |
実行するログイン関連のアクション。可能な値は、「login」または「logout」です。 |
[stateParams] |
string ⎮ オブジェクト |
対象コンテキストに渡される状態パラメーター。URL クエリ文字列またはオブジェクトの形式で指定できます。 |
new exports.NamedPageReference(pageName, [stateParams])
一意の名前を持つ標準ページ。エラーが発生した場合、エラービューが読み込まれ、URL は更新されません。
パラム |
種別 |
説明 |
|---|---|---|
pageName |
string |
ページの一意の名前。 |
[stateParams] |
string ⎮ any |
対象コンテキストに渡される状態パラメーター。URL クエリ文字列またはオブジェクトの形式で指定できます。 |
new exports.CommNamedPageReference(pageName, [stateParams])
コミュニティで使用する一意の名前を持つ標準ページ。エラーが発生した場合、エラービューが読み込まれ、URL は更新されません。
パラム |
種別 |
説明 |
|---|---|---|
pageName |
string |
ページの一意の名前。 |
[stateParams] |
string ⎮ any |
対象コンテキストに渡される状態パラメーター。URL クエリ文字列またはオブジェクトの形式で指定できます。 |
new exports.NavItemPageReference(tabName, [stateParams])
CustomTab に対応付けられたコンテンツを表示するページ。Visualforce タブ、Web タブ、Lightning ページ、Lightning コンポーネントタブがサポートされています。
パラム |
種別 |
説明 |
|---|---|---|
tabName |
string |
CustomTab の一意の名前。 |
[stateParams] |
string ⎮ any |
対象コンテキストに渡される状態パラメーター。URL クエリ文字列またはオブジェクトの形式で指定できます。 |
new exports.ObjectPageReference(objectName, [action], [filter])
組織の標準オブジェクトまたはカスタムオブジェクトを操作し、そのオブジェクトの標準アクションをサポートするページ。
パラム |
タイプ |
デフォルト |
説明 |
|---|---|---|---|
objectName |
string |
標準オブジェクトまたはカスタムオブジェクトの API 参照名。管理パッケージの一部であるカスタムオブジェクトの場合、カスタムオブジェクトにプレフィックス ns__ を付けます。 |
|
[アクション] |
string |
|
呼び出すアクション名。有効な値には、 |
[filter] |
string |
|
オブジェクトページの ID。デフォルトは [最近] です。 |
new exports.RecordPageReference(id, [objectName], [action])
組織の特定のレコードのリレーションを操作するページ。関連リストのみがサポートされます。
パラム |
タイプ |
デフォルト |
説明 |
|---|---|---|---|
id |
string |
18 文字のレコード ID。 |
|
[objectName] |
string |
レコードのオブジェクトの API 参照名。ルックアップの場合は省略可能です。 |
|
[アクション] |
string |
|
呼び出すアクション名。有効な値には、 |
new exports.RelationshipPageReference(recordId, [objectApiName], [relationshipApiName], [actionName])
組織の特定のレコードのリレーションを操作するページ。関連リストのみがサポートされます。
パラム |
タイプ |
デフォルト |
説明 |
|---|---|---|---|
recordId |
string |
リレーションを定義するレコードの 18 文字のレコード ID。 |
|
[objectApiName] |
string |
リレーションを定義するオブジェクトの API 参照名。ルックアップの場合は省略可能です。 |
|
[relationshipApiName] |
string |
オブジェクトのリレーション項目の API 参照名。 |
|
[actionName] |
string |
|
呼び出すアクション名。ビューのみがサポートされます。 |
new exports.WebPageReference(url, replace)
外部 URL。
パラム |
種別 |
説明 |
|---|---|---|
url |
string |
移動先のページの URL。 |
replace |
Boolean |
ブラウザのセッション履歴で現在のページをこの URL に置き換え、 |
ns/navigationUtils.parseParams(queryString)
クエリパラメーターをオブジェクトに展開します。
種別: ns/navigationUtils の静的メソッド
パラム |
種別 |
説明 |
|---|---|---|
queryString |
string |
& で区切られた key=value ペア |
