Apex 開発者ガイド
jConnectApi.ActionLinkDefinitionInput
アクションリンクの定義。アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザーを特定の Web ページに移動したり、ファイルダウンロードを開始したり、Salesforce または外部サーバーへの API コールを呼び出したりできます。アクションリンクには、URL と HTTP メソッドが含まれ、リクエストボディとヘッダー情報 (認証用の OAuth トークンなど) を含めることができます。アクションリンクを使用して Salesforce およびサードパーティサービスをフィードに統合することで、ユーザーは生産性を高め、イノベーションを促進できます。
使用方法
コンテキスト変数は、actionUrl、headers、および requestBody プロパティで使用できます。コンテキスト変数を使用して、アクションリンクを実行したユーザーに関する情報をサーバー側のコードに渡すことができます。アクションリンクが実行されたときに、Salesforce によって値が代入されます。
使用可能なコンテキスト変数を次に示します。
| コンテキスト変数 | 説明 |
|---|---|
| {!actionLinkId} | ユーザーが実行したアクションリンクの ID。 |
| {!actionLinkGroupId} | ユーザーが実行したアクションリンクが含まれるアクションリンクグループの ID。 |
| {!communityId} | ユーザーがアクションリンクを実行したサイトの ID。内部組織の場合、値は空のキー "000000000000000000" になります。 |
| {!communityUrl} | ユーザーがアクションリンクを実行したサイトの URL。内部組織の場合、値は空の文字列 "" になります。 |
| {!orgId} | ユーザーがアクションリンクを実行した組織の ID。 |
| {!userId} | アクションリンクを実行したユーザーの ID。 |
| プロパティ | 型 | 説明 | 必須か省略可能 | 使用可能なバージョン |
|---|---|---|---|---|
| actionType | ConnectApi.ActionLinkType | アクションリンクの種別を定義します。値は次のとおりです。
ユーザーがアクションを実行する前にページを読み込む必要がある場合、Ui を使用します。たとえば、アクションの実行前にユーザーが入力を行う場合やユーザーに情報を表示したりする場合などです。 |
必須 アクションリンクテンプレートに定義できます。 |
33.0 |
| actionUrl | String | アクションリンクの URL。たとえば、Ui アクションリンク URL は Web ページになります。Download アクションリンク URL は、ダウンロードするファイルへのリンクになります。Ui および Download アクションリンク URL がクライアントに提供されます。Api または ApiAsync アクションリンク URL は REST リソースになります。Api および ApiAsync アクションリンク URL はクライアントに提供されません。Salesforce へのリンクは、相対リンクにすることができます。他のすべてのリンクは、https:// で始まる絶対リンクにする必要があります。 | 必須 アクションリンクテンプレートに定義できます。 |
33.0 |
| excludedUserId | String | アクションの実行から除外する単一ユーザーの ID。excludedUserId を指定した場合、userId を指定できません。 | 省略可能 [ユーザー表示設定] および [カスタムユーザー(別名)] 項目を使用してアクションリンクテンプレートに定義できます。 |
33.0 |
| groupDefault | Boolean | このアクションがアクションリンクグループのデフォルトアクションリンクである場合は true、それ以外の場合は false。各アクションリンクグループに含めることができるデフォルトアクションリンクは 1 つだけです。Salesforce UI では、デフォルトアクションリンクには区別しやすいスタイルが適用されます。 | 省略可能 アクションリンクテンプレートに定義できます。 |
33.0 |
| headers | List<ConnectApi.RequestHeaderInput> |
Api および ApiAsync アクションリンク種別の要求ヘッダー。 「アクションリンクの概要、認証、およびセキュリティ」を参照してください。 |
省略可能 アクションリンクテンプレートに定義できます。 |
33.0 |
| labelKey | String | ユーザーインターフェースに表示される表示ラベルのセットのキー。セットには、NewStatus、PendingStatus、SuccessStatus、FailedStatus の状態の表示ラベルが含まれます。たとえば、Approve キーを使用する場合、[承認]、[待機中]、[承認済み]、[失敗] の表示ラベルが含まれます。 キーおよび表示ラベルの完全なリストについては、「アクションリンクの表示ラベル」を参照してください。 アクションリンクに適した定義済み表示ラベルがない場合は、カスタム表示ラベルを使用します。カスタム表示ラベルを使用するには、アクションリンクテンプレートを作成します。「アクションリンクテンプレートの作成」を参照してください。 |
必須 アクションリンクテンプレートに定義できます。 |
33.0 |
| method | ConnectApi.HttpRequestMethod | 次のいずれかの HTTP メソッド。
|
必須 アクションリンクテンプレートに定義できます。 |
33.0 |
| requestBody | String | Api アクションリンクのリクエストボディ。 | 省略可能 アクションリンクテンプレートに定義できます。 |
33.0 |
| requiresConfirmation | Boolean | ユーザーにアクションを確認するように要求する場合は true、それ以外の場合は false。 | 必須 アクションリンクテンプレートに定義できます。 |
33.0 |
| userId | String | アクションを実行できるユーザーの ID。指定しない場合や null の場合、すべてのユーザーがアクションを実行できます。userId を指定した場合、excludedUserId を指定できません。 | 省略可能 [ユーザー表示設定] および [カスタムユーザー(別名)] 項目を使用してアクションリンクテンプレートに定義できます。 |
33.0 |