Apex リファレンスガイド
jActionLinks クラス
名前空間
使用方法
アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザーを特定の Web ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバーへの API コールを呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce およびサードパーティサービスをフィードに統合することで、ユーザーは生産性を高め、イノベーションを促進できます。
アクションリンクとアクションリンクグループには、定義ビューとコンテキストユーザービューという 2 つのビューがあります。定義には、認証情報などの機密情報が含まれる可能性があります。コンテキストユーザービューは、表示オプションによって絞り込まれ、コンテキストユーザーの状態が値に反映されます。
アクションリンク定義は、サードパーティの機密情報である可能性があります (OAuth ベアラートークンヘッダーなど)。そのため、アクションリンク定義を作成した Apex 名前空間からのコールでのみ定義を参照、変更、または削除できます。さらに、コールを実行するユーザーは、定義を作成したユーザーか、「すべてのデータの参照」権限を持つユーザーである必要があります。アクションリンクグループ定義 (アクションリンク定義を含む) で操作を行うには、次のメソッドを使用します。
- createActionLinkGroupDefinition(communityId, actionLinkGroup)
- deleteActionLinkGroupDefinition(communityId, actionLinkGroupId)
- getActionLinkGroupDefinition(communityId, actionLinkGroupId)
アクションリンクまたはアクションリンクグループのコンテキストユーザーのビューで操作を行うには、次のメソッドを使用します。
- getActionLink(communityId, actionLinkId)
- getActionLinkGroup(communityId, actionLinkGroupId)
- getActionLinkDiagnosticInfo(communityId, actionLinkId)
アクションリンクの使用方法については、「アクションリンクの使用」を参照してください。
ActionLinks のメソッド
createActionLinkGroupDefinition(communityId, actionLinkGroup)
API バージョン
33.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ActionLinkGroupDefinition createActionLinkGroupDefinition(String communityId, ConnectApi.ActionLinkGroupDefinitionInput actionLinkGroup)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- actionLinkGroup
- 型: ConnectApi.ActionLinkGroupDefinitionInput
- アクションリンクグループを定義する ConnectApi.ActionLinkGroupDefinitionInput オブジェクト。
使用方法
アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザーを特定の Web ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバーへの API コールを呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce およびサードパーティサービスをフィードに統合することで、ユーザーは生産性を高め、イノベーションを促進できます。
すべてのアクションリンクはグループに属している必要があります。1 つのグループ内のアクションリンクは、相互排他的で、同じプロパティを共有します。各自のアクショングループでスタンドアロンアクションを定義します。
アクションリンクグループ定義の情報は、サードパーティの機密情報である可能性があります (OAuth ベアラートークンヘッダーなど)。そのため、アクションリンクグループ定義を作成した Apex 名前空間からのコールでのみ定義を参照、変更、または削除できます。さらに、コールを実行するユーザーは、定義を作成したユーザーか、「すべてのデータの参照」権限を持つユーザーである必要があります。
アクションリンクの定義、およびフィード要素を使用した投稿の例
テンプレートのアクションリンクの定義、およびフィード要素を使用した投稿の例
deleteActionLinkGroupDefinition(communityId, actionLinkGroupId)
API バージョン
33.0
Chatter が必要かどうか
いいえ
署名
public static void deleteActionLinkGroupDefinition(String communityId, String actionLinkGroupId)
パラメーター
戻り値
型: Void
使用方法
アクションリンクグループ定義の情報は、サードパーティの機密情報である可能性があります (OAuth ベアラートークンヘッダーなど)。そのため、アクションリンクグループ定義を作成した Apex 名前空間からのコールでのみ定義を参照、変更、または削除できます。さらに、コールを実行するユーザーは、定義を作成したユーザーか、「すべてのデータの参照」権限を持つユーザーである必要があります。
getActionLink(communityId, actionLinkId)
API バージョン
33.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.PlatformAction getActionLink(String communityId, String actionLinkId)
パラメーター
戻り値
getActionLinkDiagnosticInfo(communityId, actionLinkId)
API バージョン
33.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ActionLinkDiagnosticInfo getActionLinkDiagnosticInfo(String communityId, String actionLinkId)
パラメーター
getActionLinkGroup(communityId, actionLinkGroupId)
API バージョン
33.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.PlatformActionGroup getActionLinkGroup(String communityId, String actionLinkGroupId)
パラメーター
使用方法
すべてのアクションリンクはグループに属している必要があります。1 つのグループ内のアクションリンクは、相互排他的で、同じプロパティを共有します。アクションリンクグループ定義とは異なり、アクションリンクグループは、クライアントからアクセスできます。
getActionLinkGroupDefinition(communityId, actionLinkGroupId)
API バージョン
33.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.ActionLinkGroupDefinition getActionLinkGroupDefinition(String communityId, String actionLinkGroupId)
パラメーター
使用方法
アクションリンクグループ定義の情報は、サードパーティの機密情報である可能性があります (OAuth ベアラートークンヘッダーなど)。そのため、アクションリンクグループ定義を作成した Apex 名前空間からのコールでのみ定義を参照、変更、または削除できます。さらに、コールを実行するユーザーは、定義を作成したユーザーか、「すべてのデータの参照」権限を持つユーザーである必要があります。