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

ActionLinkTemplate

アクションリンクテンプレートを使用すると、アクションリンク定義を再利用して、アクションリンクをパッケージ化および配布することができます。アクションリンクは、フィード要素上のボタンです。アクションリンクをクリックすると、ユーザを別の Web ページに移動したり、ファイルダウンロードを開始したり、外部サーバまたは Salesforce への API コールを呼び出したりできます。アクションリンクを使用して Salesforce およびサードパーティサービスをフィードに統合できます。このオブジェクトは、API バージョン 33.0 以降で使用できます。

サポートされているコール

create()delete()describeLayout()describeSObjects()query()retrieve()update()upsert()

特別なアクセスルール

「アプリケーションのカスタマイズ」権限を持つユーザのみがこのオブジェクトを変更または削除できます。

項目

項目名 詳細
ActionLinkGroupTemplateId
reference
プロパティ
Create、Filter、Group、Sort
説明
このアクションリンクテンプレートが関連付けられている ActionLinkGroupTemplate の ID。
ActionUrl
textarea
プロパティ
Create、Update
説明
アクションリンクの URL。たとえば、Ui アクションリンク URL は Web ページになります。Download アクションリンク URL は、ダウンロードするファイルへのリンクになります。Ui および Download アクションリンク URL がクライアントに提供されます。Api または ApiAsync アクションリンク URL は REST リソースになります。Api および ApiAsync アクションリンク URL はクライアントに提供されません。Salesforce へのリンクは、相対リンクにすることができます。他のすべてのリンクは、https:// で始まる絶対リンクにする必要があります。

Salesforce サーバでホストされるリソースへのリンクは、 / で開始する相対リンクにすることができます。他のすべてのリンクは、https:// で始まる絶対リンクにする必要があります。この項目には、コンテキスト変数とバインド変数を {!Bindings.key} 形式で含めることができます (https://www.example.com/{!Bindings.itemId} など)。バインド変数の値は、テンプレートからアクションリンクグループをインスタンス化するときに設定します。

Headers
textarea
プロパティ
Create、Nillable、Update
説明
対応するアクションリンクが呼び出されときに送信される HTTP ヘッダーのテンプレート。この項目は、Api および ApiAsync アクションリンクでのみ使用できます。この項目には、コンテキスト変数とバインド変数を {!Bindings.key} 形式で含めることができます。
IsConfirmationRequired
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
true の場合、アクションの実行前に確認ダイアログが表示されます。
IsGroupDefault
boolean
プロパティ
Create、Defaulted on create、Filter、Group、Sort、Update
説明
true の場合、このテンプレートから派生するアクションリンクが、そのアクショングループのデフォルトアクションまたはプライマリアクションになります。各アクショングループに含めることができるデフォルトアクションは 1 つのみです。
Label
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
アクションリンクボタンに表示するカスタムの表示ラベル。どの LabelKey 値もアクションリンクには不適切な場合は、カスタムの表示ラベルを使用します。LabelKey 項目を None に設定し、Label 項目に表示ラベル名を入力します。
アクションリンクには、新規、待機中、成功、失敗の 4 つの状況があります。次の文字列が、各状況の表示ラベルに追加されます。
  • 表示ラベル
  • 表示ラベル待機中
  • 表示ラベル成功
  • 表示ラベル失敗
たとえば、Label の値が「Call Home」の場合、4 つのアクションリンクの状態の値は「Call Home」、「Call Home 待機中」、「Call Home 成功」、および「Call Home 失敗」になります。
LabelKeyNone 以外の値がある場合、Label 項目は空になります。
LabelKey
string
プロパティ
Create、Filter、Group、Sort、Update
説明
新規、待機中、成功、失敗の状況を示す、アクションリンクの表示ラベルのセットのキー。たとえば、[承認] セットには、[承認]、[待機中]、[承認済み]、[失敗] の表示ラベルが含まれます。キーおよび表示ラベルの完全なリストは、『Chatter REST API 開発者ガイド』または『Apex 開発者ガイド』の「アクションリンクの表示ラベル」を参照してください。
アクションリンクに適した表示ラベルキーの値がない場合、この項目を None に設定して、[表示ラベル] 項目にカスタム表示ラベル名を入力します。
LinkType
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
アクションリンクの種別。次のいずれかの値にします。
  • Api — アクションリンクは、アクション URL で同期 API をコールします。Salesforce は、サーバから返された HTTP 状況コードに基づいて状況を SuccessfulStatus または FailedStatus に設定します。
  • ApiAsync — アクションリンクは、アクション URL で非同期 API をコールします。アクションは、非同期操作の完了時にサードパーティが /connect/action-links/actionLinkId への要求を行って状況を SuccessfulStatus または FailedStatus に設定するまで、PendingStatus 状態のままになります。
  • Download — アクションリンクは、アクション URL からファイルをダウンロードします。
  • Ui — アクションリンクはアクション URL の Web ページをユーザに表示します。
Method
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
アクション URL の HTTP メソッド。次のいずれかの値にします。
  • HttpDelete — 成功した場合は HTTP 204 を返します。レスポンスボディまたは出力クラスは空です。
  • HttpGet — 成功した場合は HTTP 200 を返します。
  • HttpHead — 成功した場合は HTTP 200 を返します。レスポンスボディまたは出力クラスは空です。
  • HttpPatch — 成功した場合は HTTP 200 を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204 を返します。
  • HttpPost — 成功した場合は HTTP 201 を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204 を返します。例外は、成功時に HTTP 200 を返すバッチ投稿リソースおよびメソッドです。
  • HttpPut — 成功した場合は HTTP 200 を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204 を返します。

Ui および Download アクションリンクでは、HttpGet を使用する必要があります。

Position
int
プロパティ
Create、Filter、Group、Sort、Update
説明
グループ内の他のアクションリンクに関連するアクションリンクテンプレートの位置を指定する整数。0 は最初の位置です。
RequestBody
textarea
プロパティ
Create、Nillable、Update
説明
対応するアクションリンクが呼び出されときに送信される HTTP リクエストボディのテンプレート。この項目は、Api および ApiAsync アクションリンクでのみ使用できます。この項目には、コンテキスト変数とバインド変数を {!Bindings.key} 形式で含めることができます。
UserAlias
string
プロパティ
Create、Filter、Group、Nillable、Sort、Update
説明
UserVisibility に対して CustomUser または CustomExcludedUser を選択した場合、この項目がカスタムユーザの別名になります。テンプレートを使用してアクションリンクグループを作成する場合、テンプレートバインドでこの別名を使用してカスタムユーザを指定します。
UserVisibility
picklist
プロパティ
Create、Filter、Group、Restricted picklist、Sort、Update
説明
アクションリンクを表示できるユーザ。この値は、アクションリンクグループごとではなく、アクションリンクごとに設定されます。次のいずれかの値にします。
  • Creator — アクションリンクの作成者のみがアクションリンクを表示できます。
  • Everyone — すべてのユーザがアクションリンクを表示できます。
  • EveryoneButCreator — アクションリンクの作成者を除くすべてのユーザがアクションリンクを表示できます。
  • Manager — アクションリンクの作成者のマネージャのみがアクションリンクを表示できます。
  • CustomUser — カスタムユーザのみがアクションリンクを表示できます。
  • CustomExcludedUser — カスタムユーザを除くすべてのユーザがアクションリンクを表示できます。

使用方法

[設定] でアクションリンクテンプレートを作成します。ConnectApi 名前空間または Chatter REST API で Apex クラスを使用してテンプレートからアクションリンクをインスタンス化し、アクションリンクを含むフィード要素を投稿します。

アクションリンクについての詳細は、『Apex 開発者ガイド』または『Chatter REST API 開発者ガイド』の「アクションリンクの使用」を参照してください。