forcedotcom / connectapihelper Goto Github PK

Helper class that makes it easier to post Chatter @-mentions, rich text, and inline images with Apex code.

License: BSD 3-Clause "New" or "Revised" License

Apex 100.00%

connectapihelper's Introduction

ConnectApiHelper

ConnectApiHelper is an Apex class that makes it easier to do common operations with the classes in the ConnectApi namespace. It includes convenience methods to:

Post Chatter @-mentions with Apex code.
Post rich text, inline images, and record links with Apex code.
Take a feed item or comment body and return an input body that matches it (useful for either editing or re-posting).

Easier @-mentions

If you want to mention someone in a post that says: Hey there @Jane Doe, how are you?, you can do it in one line like this:

ConnectApi.FeedItem fi = (ConnectApi.FeedItem) ConnectApiHelper.postFeedItemWithMentions(Network.getNetworkId(), 'me', 'Hey there {005D00000015tjz}, how are you?');

... instead of this:

ConnectApi.MessageBodyInput messageInput = new ConnectApi.MessageBodyInput();
messageInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();

ConnectApi.TextSegmentInput textSegment = new ConnectApi.TextSegmentInput();
textSegment.text = 'Hey there ';
messageInput.messageSegments.add(textSegment);

ConnectApi.MentionSegmentInput mentionSegment = new ConnectApi.MentionSegmentInput();
mentionSegment.id = '005D00000015tjz'; // The ID of the user to mention.
messageInput.messageSegments.add(mentionSegment);

textSegment = new ConnectApi.TextSegmentInput();
textSegment.text = ', how are you?';
messageInput.messageSegments.add(textSegment);

ConnectApi.FeedItemInput input = new ConnectApi.FeedItemInput();
input.body = messageInput;
input.subjectId = 'me';

ConnectApi.FeedItem fi = ConnectApi.ChatterFeeds.postFeedElement(Network.getNetworkId(), input);

Streamlined rich text, inline images and record links

If you want to add rich text, inline images, or record links in your post, one line will do it:

ConnectApi.FeedItem fi = (ConnectApi.FeedItem) ConnectApiHelper.postFeedItemWithRichText(Network.getNetworkId(),
'me', 'Have you seen this <b>gorgeous</b> view? {img:069x00000000D7m:View of the Space Needle from our office.} \nBy the way, please check {record:01t3E000002GCm9QAG}');

... instead of this:

ConnectApi.MessageBodyInput messageInput = new ConnectApi.MessageBodyInput();
messageInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();

ConnectApi.TextSegmentInput textSegment = new ConnectApi.TextSegmentInput();
textSegment.text = 'Have you seen this ';
messageInput.messageSegments.add(textSegment);

ConnectApi.MarkupBeginSegmentInput markupBeginSegment = new ConnectApi.MarkupBeginSegmentInput();
markupBeginSegment.markupType = ConnectApi.MarkupType.Bold;
messageInput.messageSegments.add(markupBeginSegment);

textSegment = new ConnectApi.TextSegmentInput();
textSegment.text = 'gorgeous';
messageInput.messageSegments.add(textSegment);

ConnectApi.MarkupEndSegmentInput markupEndSegment = new ConnectApi.MarkupEndSegmentInput();
markupEndSegment.markupType = ConnectApi.MarkupType.Bold;
messageInput.messageSegments.add(markupEndSegment);

textSegment = new ConnectApi.TextSegmentInput();
textSegment.text = ' view? ';
messageInput.messageSegments.add(textSegment);

ConnectApi.InlineImageSegmentInput inlineImageSegment = new ConnectApi.InlineImageSegmentInput();
inlineImageSegment.fileId = '069x00000000D7m';
inlineImageSegment.altText = 'View of the Space Needle from our office.';
messageInput.messageSegments.add(inlineImageSegment);

textSegment = new ConnectApi.TextSegmentInput();
textSegment.text = ' \nBy the way, please check ';
messageInput.messageSegments.add(textSegment);

ConnectApi.EntityLinkSegmentInput entityLinkSegment = new ConnectApi.EntityLinkSegmentInput();
entityLinkSegment.entityId = '01t3E000002GCm9QAG';
messageInput.messageSegments.add(entityLinkSegment);

ConnectApi.FeedItemInput input = new ConnectApi.FeedItemInput();
input.body = messageInput;
input.subjectId = 'me';

ConnectApi.FeedItem fi = ConnectApi.ChatterFeeds.postFeedElement(Network.getNetworkId(), input);

Installation

Just copy the ConnectApiHelper and ConnectApiHelperTest classes to your Salesforce org. If you use Salesforce DX, you can clone this repo and develop using your preferred IDE, source control system, and scratch orgs.

Usage

For @-mentions, the methods to use are ConnectApiHelper.postFeedItemWithMentions and ConnectApiHelper.postCommentWithMentions and the parameters and formatting syntax are described in the method comments. To include rich text and inline images as well (starting in version 35.0), the method to use is ConnectApiHelper.postFeedItemWithRichText. You can also refer to the ConnectApiHelperTest class for more examples.

For creating input bodies from output bodies, the methods are ConnectApiHelper.createFeedItemInputFromBody and ConnectApiHelper.createCommentInputFromBody.

Salesforce API Versions

If you need to use an earlier version of the Salesforce API, the current ConnectApiHelper class may not compile, because the methods being called may not be available in the earlier version.

We've provided variants of ConnectApiHelper so that you can use it with earlier Salesforce API versions:

API Version	ConnectApiHelper location	Limitations
43.0 and higher	default
36.0-42.0	v36-v42	Record links not supported
35.0	v35	Same as above
32.0-34.0	v32-v34	Same as above, and rich text not supported
31.0 and earlier	v31AndEarlier	Same as above

connectapihelper's People

Contributors

Stargazers

Watchers

Forkers

boonedox vincent0204 shivanathd kanwar18 beck-dub alouie-sfdc tuandang macanderson flect-kokoro esh3m4 jeremywhiteley accessvasu nortonmd pepke41 chadevanssf bleyle mshanemc nikshanbhag-sf winniecluk sfdc-code nitishschdev nivg mchande1 pankajhingane raghavkhaitan prasannadeshpande datapharmer dashughe vsabbella embraceinnovation smukov nvuillam stephenanders troveryor pratibhabhosle1484 vamsi-chinnam venumisys aranwe rahman123 bizonfr meghasfdc juliodesynit sebastiankessel roman-hnativ henk3000 zhqing1 paustint kg345 divyachaurasiya ghanshyamupadhyay joejamjom treymichaelfeldman richardevans88 chenxin101 gauchogringo remifoyard akashdazeworks mujjammil-khan arufian sharmaronak77 mattazlin hunterhec isabella232 joegabonito rajendrasnagar sfernandez-lc shuilouta dsomous davidmaar runyan32 pbsjw peninsula-group-saleforce gpahalwani freddysilber

connectapihelper's Issues

ConnectApiHelperTest: "Context user does not have permission to create rich text in feed"

I installed the software from UnofficialSF.com and when running unit tests, got this error

Class.ConnectApi.ChatterFeeds.postFeedElement: line 1458, column 1
Class.ConnectApiHelperTest.testCreateInputFromBody: line 257, column 1
10:18:52.130 (194554713)|FATAL_ERROR|ConnectApi.ConnectApiException: Context user does not have permission to create rich text in feed

The ContextUser is UserInfo.getUserId() - which is me, user with System Admin profile. The test appears to be posting a bolded element.

test class is V47

Network.getNetworkId() returns null for the test context

What permission to I need to setup for the running user to be able to execute this unit test?

Please update this file for Spring 19 Hyperlink change.

Error

I am getting the following error when trying to use the example post.

Illegal assignment from ConnectApi.FeedElement to ConnectApi.FeedItem

Code:
ConnectApi.FeedItem fi = ConnectApiHelper.postFeedItemWithMentions(Network.getNetworkId(), 'me', 'Hey there {005D00000015tjz}, how are you?');

My class and the helper class are on V36 and I have made the correction to the one line of the helper method for the V36 change that is listed in this issues area.

Make ConnectApiHelper easier to use with Salesforce DX

Restructure the files in the ConnectApiHelper repo so that we can use Salesforce DX for development. For example, this would allow us to use VS Code and its [Salesforce Extensions(https://developer.salesforce.com/tools/vscode/).

Is there a way to support code snippet?

I also wanted to see if there is a way to Code Markup Type in this helper class?

Change in postFeedElement v36

Line 109 should be changed to

return ConnectApi.ChatterFeeds.postFeedElement(communityId, input);

When we Call ConnectAPIHelper class through Batch Job throwing an exception as it is taking more than 150 DML Statements

When we try to call the postFeedItemWithMentions method from Batch, everytime it is considering as one DML Statement, When the loop reach to 150th time, it is throwing an Exception "First error: Too many DML statements: 151". Is there any possiblity to avoid this issue like instead o calling everytime, can we add it in a list and call only once. Thanks in Advance...!!

Make the class bulk-friendly

The class is not bulkified to use in triggers, would be super useful if it could be done so....

I am getting this while operating in a for loop
System.LimitException: Too many DML statements: 151

Thanks!

Error: Compile Error: Method was removed after version 35.0: postFeedElement at line 109 column 40

I'm getting error when adding the class into my instance with API 40.

FYI - Using ConnectApiHelper in a new Flow Process Action

See https://unofficialsf.com/post-rich-chatter-invocable-action/

I experimented with incorporating the hyperlink code in #17 but got mired in problems. The hyperlink support is a little weaker than I think it can be.

EntityLink segment not allowed. Contact your administrator to enable it.

When using the current version of the helper to create a post in a community, with a reference to a file, I get the error "EntityLink segment not allowed. Contact your administrator to enable it". This does not seem to happen when I create posts internally (eg: when the networkId is null). Has anyone else run into this, and if so, is it actually possible to "enable it" as the error message indicates, or is this a limitation of posting into a community?

getMessageSegmentInputs not working with "Hello"

We are using the lightning-input-rich-text(LWC) and when user using text alignment center|right that time Hello HTML is generating.

Post we are passing Hello HTML as param(inputText) to getMessageSegmentInputs method, but this piece of code String textSegment = inputText.substring(strPos, globalMatcher.start()); returning invalid HTML, hence system throwing error.

Output of textSegment post executing code:
Hello

Error:
Error while parsing Rich Text Content: The markup in the document following the root element must be well-formed.

Could you please help us to resolve this issue.

@amerine @mars @vazexqi @jamesward @edmorley

Thank you,
Hemant

Does ConnectApiHelper work with the ConnectApi.EntityLinkSegmentInput subclass?

Add support for feed item visibility

See http://salesforce.stackexchange.com/questions/102367/using-postfeeditemwithmentions-i-cant-set-visibility-allusers for the details.

Remove dependency to SeeAllData

Using SeeAllData=True is against best practices documented https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_testing_seealldata_using.htm

Since ConnectAPIs are not accessible in data silo'd tests, it would be great to see these examples reworked to use a mock/stubbing framework instead of requiring tests to see all data in an org.

Financial Force has published a robust example of a mock/stubbing framework but, it would be fantastic to have something for salesforce developers leveraging Connect APIs like this to be able to plug-and-play from this repo.

Use Variable on the Post

Hi! First of all thanks to post this to the community.

I have a doubt, not really a issue.

I want to know if I there is a way that I can use a variable inside the String that will pass to the postFeedItemWithRichText method.

Some like this:

ConnectApi.FeedItem fi = (ConnectApi.FeedItem) ConnectApiHelper.postFeedItemWithRichText (Network.getNetworkId(), 'me', 'Hey there {005D00000015tjz}, {some variable} ?');

Then I could change the post based on some previous criteria.

But nevertheless thanks again for the code!