Force.com Apex Code Developer's Guide

Getting Started
Writing Apex
Ways to Invoke Apex
Finishing Touches
Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Communities Class
CommunityModeration Class
Datacloud Class
ManagedTopics Class
Mentions Class
Organization Class
QuestionAndAnswers Class
Recommendations Class
Records Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi.ActionLinkDefinitionInput Class
ConnectApi.ActionLinkGroupDefinitionInput Class
ConnectApi.​ActionLinkTemplate​BindingInput
ConnectApi.AnnouncementInput Class
ConnectApi.​AssociatedActions​CapabilityInput Class
ConnectApi.Binary​​Input Class
ConnectApi.BatchInput Class
ConnectApi.​BookmarksCapability​Input
ConnectApi.CanvasAttachmentInput Class
ConnectApi.​CanvasCapability​Input
ConnectApi.Chatter​​GroupInput Class
ConnectApi.Comment​​Input Class
ConnectApi.ContentAttachmentInput Class
ConnectApi.​ContentCapability​Input
ConnectApi.DatacloudOrderInput Class
ConnectApi.​FeedElement​CapabilitiesInput
ConnectApi.​FeedElement​CapabilityInput Class
ConnectApi.​FeedElementInput Class
ConnectApi.​Feed​Item​Attachment​​Input Class
ConnectApi.​​FeedItem​​Input Class
ConnectApi.​Group​Information​Input Class
ConnectApi.HashtagSegmentInput Class
ConnectApi.InlineImageSegmentInput
ConnectApi.LinkAttachmentInput Class
ConnectApi.​LinkCapabilityInput
ConnectApi.LinkSegmentInput Class
ConnectApi.ManagedTopicPositionCollectionInput Class
ConnectApi.ManagedTopicPositionInput Class
ConnectApi.MarkupBeginSegmentInput
ConnectApi.MarkupEndSegmentInput
ConnectApi.MentionSegmentInput Class
ConnectApi.​Message​​Body​Input Class
ConnectApi.​Message​Segment​Input Class
ConnectApi.MuteCapabilityInput
ConnectApi.NewFileAttachmentInput Class
ConnectApi.PhotoInput Class
ConnectApi.PollAttachmentInput Class
ConnectApi.​PollCapabilityInput
ConnectApi.​QuestionAndAnswers​CapabilityInput
ConnectApi.RecommendationAudienceInput
ConnectApi.RecommendationDefinitionInput
ConnectApi.RequestHeaderInput Class
ConnectApi.ScheduledRecommendationInput
ConnectApi.TextSegmentInput Class
ConnectApi.TopicInput Class
ConnectApi.TopicNamesInput
ConnectApi.UserInput Class
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ConnectApi.ActionLinkDefinitionInput Class

The definition of an action link. An action link is a button on a feed element. Clicking an action link can take a user to a Web page, initiate a file download, or invoke an API call to Salesforce or to an external server. An action link includes a URL and an HTTP method, and can include a request body and header information, such as an OAuth token for authentication. Use action links to integrate Salesforce and third-party services into the feed so that users can take action to drive productivity and accelerate innovation.

Usage

You can use context variables in the actionUrl, headers, and requestBody properties. Use context variables to pass information about the user who executed the action link to your server-side code. Salesforce substitutes the value when the action link is executed.
These are the available context variables:
Context Variable Description
{!actionLinkId} The ID of the action link the user executed.
{!actionLinkGroupId} The ID of the action link group containing the action link the user executed.
{!communityId} The ID of the community in which the user executed the action link. The value for your internal organization is the empty key "000000000000000000".
{!communityUrl} The URL of the community in which the user executed the action link. The value for your internal organization is empty string "".
{!orgId} The ID of the organization in which the user executed the action link.
{!userId} The ID of the user that executed the action link.
Property Type Description Required or Optional Available Version
actionType ConnectApi.​ActionLinkType Defines the type of action link. Values are:
  • Api—The action link calls a synchronous API at the action URL. Salesforce sets the status to SuccessfulStatus or FailedStatus based on the HTTP status code returned by your server.
  • ApiAsync—The action link calls an asynchronous API at the action URL. The action remains in a PendingStatus state until a third party makes a request to /connect/action-links/actionLinkId to set the status to SuccessfulStatus or FailedStatus when the asynchronous operation is complete.
  • Download—The action link downloads a file from the action URL.
  • Ui—The action link takes the user to a Web page at the action URL.

Use Ui if you need to load a page before the user performs an action, for example, to have the user provide input or view something before the action happens.

Invoking ApiAsync action links from an app requires a call to set the status. However, there isn’t currently a way to set the status of an action link using Apex. To set the status, use Chatter REST API. See the Action Link resource in the Chatter REST API Developer's Guide for more information.

Note

 Required

Can be defined in an action link template.

 33.0
actionUrl String The action link URL. For example, a Ui action link URL is a Web page. A Download action link URL is a link to the file to download. Ui and Download action link URLs are provided to clients. An Api or ApiAsync action link URL is a REST resource. Api and ApiAsync action link URLs aren’t provided to clients. Links to Salesforce can be relative. All other links must be absolute and start with https://.

To avoid issues due to upgrades or changing functionality in your API, we recommend using a versioned API for actionUrl, for example, https://www.example.com/​api/v1/exampleResource. If your API isn’t versioned, you can use the expirationDate property of the ConnectApi.ActionLinkGroup​DefinitionInput class to avoid issues due to upgrades or changing functionality in your API.

Tip

 Required

Can be defined in an action link template.

 33.0
excludedUserId String ID of a single user to exclude from performing the action. If you specify an excludedUserId, you can’t specify a userId. Optional

Can be defined in an action link template using the User Visibility and Custom User Alias fields.

 33.0
groupDefault Boolean true if this action is the default action link in the action link group; false otherwise. There can be only one default action link per action link group. The default action link gets distinct styling in the Salesforce UI. Optional

Can be defined in an action link template.

 33.0
headers List<ConnectApi.​RequestHeader​Input> The request headers for the Api and ApiAsync action link types.

See Action Links Overview, Authentication, and Security.

 Optional

Can be defined in an action link template.

 33.0
labelKey String Key for the set of labels to show in the user interface. A set includes labels for these states: NewStatus, PendingStatus, SuccessStatus, FailedStatus. For example, if you use the Approve key, you get these labels: Approve, Pending, Approved, Failed.

For a complete list of keys and labels, see Action Links Labels.

If none of the predefined labels work for your action link, use a custom label. To use a custom label, create an action link template. See Create Action Link Templates.

 Required

Can be defined in an action link template.

 33.0
method ConnectApi.​HttpRequest​Method One of these HTTP methods:
  • HttpDelete—Returns HTTP 204 on success. Response body or output class is empty.
  • HttpGet—Returns HTTP 200 on success.
  • HttpHead—Returns HTTP 200 on success. Response body or output class is empty.
  • HttpPatch—Returns HTTP 200 on success or HTTP 204 if the response body or output class is empty.
  • HttpPost—Returns HTTP 201 on success or HTTP 204 if the response body or output class is empty. Exceptions are the batch posting resources and methods, which return HTTP 200 on success.
  • HttpPut—Return HTTP 200 on success or HTTP 204 if the response body or output class is empty.
 Required

Can be defined in an action link template.

 33.0
requestBody String The request body for Api action links.

Escape quotation mark characters in the requestBody value.

Note

 Optional

Can be defined in an action link template.

 33.0
requires​Confirmation Boolean true to require the user to confirm the action; false otherwise. Required

Can be defined in an action link template.

 33.0
userId String The ID of the user who can execute the action. If not specified or null, any user can execute the action. If you specify a userId, you can’t specify an excludedUserId. Optional

Can be defined in an action link template using the User Visibility and Custom User Alias fields.

 33.0