ChatterFeeds Class

deleteComment(communityId, commentId)

Delete a comment.

API Version

28.0

Requires Chatter

Yes

Signature

public static Void deleteComment(String communityId, String commentId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; The ID for a comment.

Return Value

Type: Void

deleteFeedElement(communityId, feedElementId)

Delete a feed element.

API Version

31.0

Requires Chatter

Yes

Signature

public static deleteFeedElement(String communityId, String feedElementId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.

Return Value

Type: Void

deleteLike(communityId, likeId)

Delete a like on a comment or post.

API Version

28.0

Requires Chatter

Yes

Signature

public static Void deleteLike(String communityId, String likeId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
likeId: Type: String; The ID for a like.

Return Value

Type: Void

deleteStream(communityId, streamId)

Delete a Chatter feed stream.

API Version

39.0

Requires Chatter

Yes

Signature

public static Void deleteStream(String communityId, String streamId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
streamId: Type: String; ID of the Chatter feed stream.

Return Value

Type: Void

getComment(communityId, commentId)

Get a comment.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.Comment getComment(String communityId, String commentId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; The ID for a comment.

Return Value

Type: ConnectApi.Comment

getCommentBatch(communityId, commentIds)

Get a list of comments.

API Version

42.0

Requires Chatter

Yes

Signature

public static ConnectApi.BatchResult[] getCommentBatch(String communityId, List<String> commentIds)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentIds: Type: List<String>; A list of up to 100 comment IDs.

Return Value

Type: ConnectApi.BatchResult[]

The ConnectApi.BatchResult.getResult() method returns a ConnectApi.Comment object and errors for comments that didn’t load.

getCommentInContext(communityId, commentId, pageSize)

Get a threaded comment in the context of its parent comments and post.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement getCommentInContext(String communityId, String commentId, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; ID of the comment.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25.

Return Value

If the comment doesn’t support the comments capability, the return value is ConnectApi.NotFoundException.

getCommentsForFeedElement(communityId, feedElementId)

Get comments for a feed element.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.

Return Value

If the feed element doesn’t support the Comments capability, the return value is ConnectApi.NotFoundException.

getCommentsForFeedElement(communityId, feedElementId, threadedCommentsCollapsed)

Get comments in a threaded style for a feed element.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId, Boolean threadedCommentsCollapsed)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
threadedCommentsCollapsed: Type: Boolean; Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

If the feed element doesn’t support the Comments capability, the return value is ConnectApi.NotFoundException.

getCommentsForFeedElement(communityId, feedElementId, pageParam, pageSize)

Get a page of comments for a feed element.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId, String pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
pageParam: Type: String; The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of comments per page. Valid values are from 1 through 100. If you pass null, the default size is 25.

Return Value

If the feed element doesn’t support the Comments capability, the return value is ConnectApi.NotFoundException.

getCommentsForFeedElement(communityId, feedElementId, pageParam, pageSize, threadedCommentsCollapsed)

Get a page of comments in a threaded style for a feed element.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId, String pageParam, Integer pageSize, Boolean threadedCommentsCollapsed)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
pageParam: Type: String; The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of comments per page. Valid values are from 1 through 100. If you pass null, the default size is 25.
threadedCommentsCollapsed: Type: Boolean; Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

If the feed element doesn’t support the Comments capability, the return value is ConnectApi.NotFoundException.

getCommentsForFeedElement(communityId, feedElementId, threadedCommentsCollapsed, sortParam)

Get sorted comments in a threaded style for a feed element.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentsCapability getCommentsForFeedElement(String communityId, String feedElementId, Boolean threadedCommentsCollapsed, ConnectApi.FeedCommentSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

sortParam

Order of comments. Values are:

CreatedDateLatestAsc—Sorts by most recently created comments in ascending order.
CreatedDateOldestAsc—Sorts by oldest comments in ascending order.
Relevance—Sorts by most relevant content.

Return Value

If the feed element doesn’t support the Comments capability, the return value is ConnectApi.NotFoundException.

getCommentsForFeedElement(communityId, feedElementId, pageParam, pageSize, threadedCommentsCollapsed, sortParam)

Get a page of sorted comments in a threaded style for a feed element.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId, String pageParam, Integer pageSize, Boolean threadedCommentsCollapsed, ConnectApi.FeedCommentSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of comments per page. Valid values are from 1 through 100. If you pass null, the default size is 25.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

sortParam

Order of comments. Values are:

CreatedDateLatestAsc—Sorts by most recently created comments in ascending order.
CreatedDateOldestAsc—Sorts by oldest comments in ascending order.
Relevance—Sorts by most relevant content.

Return Value

If the feed element doesn’t support the Comments capability, the return value is ConnectApi.NotFoundException.

getCommentsForFeedElement(communityId, feedElementId, sortParam)

Get sorted comments for a feed element.

API Version

41.0

Available to Guest Users

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentsCapability getCommentsForFeedElement(String communityId, String feedElementId, ConnectApi.FeedCommentSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element.

sortParam

Order of comments. Values are:

CreatedDateLatestAsc—Sorts by most recently created comments in ascending order.
CreatedDateOldestAsc—Sorts by oldest comments in ascending order.
Relevance—Sorts by most relevant content.

Return Value

Type: ConnectApi.CommentsCapability

If the feed element doesn’t support the Comments capability, the return value is ConnectApi.NotFoundException.

getCommentsForFeedElement(communityId, feedElementId, sortParam, threadedCommentsCollapsed)

Get sorted comments in a threaded style for a feed element.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentsCapability getCommentsForFeedElement(String communityId, String feedElementId, ConnectApi.FeedCommentSortOrder sortParam, Boolean threadedCommentsCollapsed)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element.

sortParam

Order of comments. Values are:

CreatedDateLatestAsc—Sorts by most recently created comments in ascending order.
CreatedDateOldestAsc—Sorts by oldest comments in ascending order.
Relevance—Sorts by most relevant content.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

Type: ConnectApi.CommentsCapability

If the feed element doesn’t support the Comments capability, the return value is ConnectApi.NotFoundException.

getExtensions(communityId, pageParam, pageSize)

Get extensions.

API Version

40.0

Available to Guest Users

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ExtensionDefinitions getExtensions(String communityId, String pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
pageParam: Type: String; Specifies the page token to be used to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. The default size is 15.

Return Value

Type: ConnectApi.ExtensionDefinitions

getFeed(communityId, feedType)

Get a feed.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.Feed getFeed(String communityId, ConnectApi.FeedType feedType)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

Return Value

Type: ConnectApi.Feed

getFeed(communityId, feedType, sortParam)

Get a sorted feed.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.Feed getFeed(String communityId, ConnectApi.FeedType feedType, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

If feedType is DirectMessages, sortParam must be LastModifiedDateDesc.

Return Value

Type: ConnectApi.Feed

getFeed(communityId, feedType, subjectId)

Get a feed for a record or user.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.Feed getFeed(String communityId, ConnectApi.FeedType feedType, String subjectId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.
subjectId: Type: String; If feedType is Record, subjectId can be any record ID, including a group ID. If feedType is Streams, subjectId must be a stream ID. If feedType is Topics, subjectId must be a topic ID. If feedType is UserProfile, subjectId can be any user ID. If the feedType is any other value, subjectId must be the ID of the context user or the alias me.

Return Value

Type: ConnectApi.Feed

getFeed(communityId, feedType, subjectId, sortParam)

Get a sorted feed for a record or user.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.Feed getFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

If feedType is Record, subjectId can be any record ID, including a group ID. If feedType is Streams, subjectId must be a stream ID. If feedType is Topics, subjectId must be a topic ID. If feedType is UserProfile, subjectId can be any user ID. If the feedType is any other value, subjectId must be the ID of the context user or the alias me.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

Return Value

Type: ConnectApi.Feed

getFeedDirectory(String)

Get a list of all feeds available to the context user.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedDirectory getFeedDirectory(String communityId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.

Return Value

Type: ConnectApi.FeedDirectory

getFeedElement(communityId, feedElementId)

Get a feed element.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.

Return Value

getFeedElement(communityId, feedElementId, commentSort)

Get a feed element with sorted comments.

API Version

41.0

Available to Guest Users

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, ConnectApi.FeedCommentSortOrder commentSort)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element.

commentSort

Order of comments.

CreatedDateLatestAsc—Sorts by most recently created comments in ascending order.
CreatedDateOldestAsc—Sorts by oldest comments in ascending order.
Relevance—Sorts by most relevant content.

The default value is CreatedDateLatestAsc.

Return Value

getFeedElement(communityId, feedElementId, threadedCommentsCollapsed)

Get a feed element and its comments in a threaded style.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Boolean threadedCommentsCollapsed)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
threadedCommentsCollapsed: Type: Boolean; Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

getFeedElement(communityId, feedElementId, threadedCommentsCollapsed, commentSort)

Get a feed element and its sorted comments in a threaded style.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Boolean threadedCommentsCollapsed, ConnectApi.FeedCommentSortOrder commentSort)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

commentSort

Order of comments.

CreatedDateLatestAsc—Sorts by most recently created comments in ascending order.
CreatedDateOldestAsc—Sorts by oldest comments in ascending order.
Relevance—Sorts by most relevant content.

Return Value

getFeedElement(communityId, feedElementId, recentCommentCount, elementsPerBundle)

Get a feed element with the specified number of elements per bundle including no more than the specified number of comments per feed element.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Integer recentCommentCount, Integer elementsPerBundle)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
recentCommentCount: Type: Integer; Maximum number of comments to return with each feed element. The default value is 3.
elementsPerBundle: Type: Integer; Maximum number of feed elements per bundle. The default and maximum value is 10.

Return Value

getFeedElement(communityId, feedElementId, recentCommentCount, elementsPerBundle, threadedCommentsCollapsed)

Get a feed element with its comments in a threaded style with the specified number of elements per bundle and comments per feed element.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Integer recentCommentCount, Integer elementsPerBundle, Boolean threadedCommentsCollapsed)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
recentCommentCount: Type: Integer; Maximum number of comments to return with each feed element. The default value is 3.
elementsPerBundle: Type: Integer; Maximum number of feed elements per bundle. The default and maximum value is 10.
threadedCommentsCollapsed: Type: Boolean; Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

getFeedElement(communityId, feedElementId, recentCommentCount, elementsPerBundle, threadedCommentsCollapsed, commentSort)

Get a feed element with its sorted comments in a threaded style with the specified number of elements per bundle and comments per feed element.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Integer recentCommentCount, Integer elementsPerBundle, Boolean threadedCommentsCollapsed, ConnectApi.FeedCommentSortOrder commentSort)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

commentSort

Order of comments.

CreatedDateLatestAsc—Sorts by most recently created comments in ascending order.
CreatedDateOldestAsc—Sorts by oldest comments in ascending order.
Relevance—Sorts by most relevant content.

Return Value

getFeedElement(communityId, feedElementId, recentCommentCount, elementsPerBundle, commentSort)

Get a feed element with the specified number of elements per bundle including no more than the specified number of sorted comments per feed element.

API Version

41.0

Available to Guest Users

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedCommentSortOrder commentSort)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

commentSort

Order of comments.

CreatedDateLatestAsc—Sorts by most recently created comments in ascending order.
CreatedDateOldestAsc—Sorts by oldest comments in ascending order.
Relevance—Sorts by most relevant content.

The default value is CreatedDateLatestAsc.

Return Value

getFeedElementBatch(communityId, feedElementIds)

Get a list of feed elements.

API Version

31.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.BatchResult[] getFeedElementBatch(String communityId, List<String> feedElementIds)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementIds: Type: List<String>; A list of up to 500 feed element IDs.

Return Value

Type: ConnectApi.BatchResult[]

The ConnectApi.BatchResult.getResult() method returns a ConnectApi.FeedElement object and errors for feed elements that didn’t load.

getFeedElementPoll(communityId, feedElementId)

Get the poll associated with a feed element.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.PollCapability getFeedElementPoll(String communityId, String feedElementId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.

Return Value

Type: ConnectApi.PollCapability

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

Triggers on FeedItem objects run before their attachment and capabilities information is saved, which means that ConnectApi.FeedItem.attachment information and ConnectApi.FeedElement.capabilities information may not be available in the trigger.

Note

getFeedElementsFromBundle(communityId, feedElementId)

Get feed elements from a bundle.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromBundle(String communityId, String feedElementId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.

Return Value

getFeedElementsFromBundle(communityId, feedElementId, pageParam, pageSize, elementsPerBundle, recentCommentCount)

Get a page of feed elements from a bundle. Specify the number of elements per bundle and include no more than the specified number of comments per feed element.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromBundle(String communityId, String feedElementId, String pageParam, Integer pageSize, Integer elementsPerBundle, Integer recentCommentCount)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
pageParam: Type: String; Specifies the page token to be used to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
elementsPerBundle: Type: Integer; Maximum number of feed elements per bundle. The default and maximum value is 10.
recentCommentCount: Type: Integer; Maximum number of comments to return with each feed element. The default value is 3.

Return Value

getFeedElementsFromFeed(communityId, feedType)

Get feed elements from the Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview feeds.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, pageParam, pageSize, sortParam)

Get a page of sorted feed elements from the Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview feeds.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

If feedType is DirectMessages, sortParam must be LastModifiedDateDesc.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam)

Get a page of sorted feed elements from the Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview feeds. Each feed element contains no more than the specified number of comments.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

If feedType is DirectMessages, sortParam must be LastModifiedDateDesc.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, filter)

Get a page of sorted and filtered feed elements from the Home feed. Each feed element contains no more than the specified number of comments.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. The only valid value is Home.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

When the sortParam is MostViewed, you must pass in null for the pageParam.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

When the sortParam is MostViewed, the pageSize must be a value from 1 to 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, filter, threadedCommentsCollapsed)

Get a page of filtered and sorted feed elements with comments in a threaded style from the Home feed. Each feed element contains no more than the specified number of comments.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

The type of feed. The only valid value is Home.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

When the sortParam is MostViewed, you must pass in null for the pageParam.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

When the sortParam is MostViewed, the pageSize must be a value from 1 to 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, subjectId)

Get feed elements from any feed other than Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview for a user or record.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.
subjectId: Type: String; If feedType is Record, subjectId can be any record ID, including a group ID. If feedType is Streams, subjectId must be a stream ID. If feedType is Topics, subjectId must be a topic ID. If feedType is UserProfile, subjectId can be any user ID. If the feedType is any other value, subjectId must be the ID of the context user or the alias me.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

Example for Getting the Context User’s News Feed

Example for Getting Another User’s Profile Feed

Example for Getting Another User’s Record Feed

getFeedElementsFromFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam)

Get a page of sorted feed elements from any feed other than Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

The number of feed elements per page.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam)

Get a page of sorted feed elements from any feed other than Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview. Each feed element includes no more than the specified number of comments.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, showInternalOnly)

Get a page of sorted feed elements from a record feed. Each feed element includes no more than the specified number of comments. Specify whether to return feed elements posted by internal (non-community) users only.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, filter)

Get a page of sorted and filtered feed elements from the UserProfile feed.

API Version

35.0

Available to Guest Users

35.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.UserProfile.

subjectId

Type: String

The ID of any user. To specify the context user, use the user ID or the alias me.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

filter

Value must be ConnectApi.FeedFilter.CommunityScoped or ConnectApi.FeedFilter.AuthoredBy.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

Example

This example gets only community-specific feed elements.

getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, filter, threadedCommentsCollapsed)

Get a page of feed elements with comments in a threaded style from the UserProfile feed.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.UserProfile.

subjectId

Type: String

The ID of any user. To specify the context user, use the user ID or the alias me.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

filter

Value must be ConnectApi.FeedFilter.CommunityScoped or ConnectApi.FeedFilter.AuthoredBy.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, customFilter)

Get a page of sorted and filtered feed elements from the case feed.

API Version

40.0

Available to Guest Users

40.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly)

Get a page of sorted feed elements from a record feed. Specify the number of elements per bundle and include no more than the specified number of comments per feed element. Specify whether to return feed elements posted by internal (non-community) users only.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, filter)

Get a page of sorted and filtered feed elements from a record feed. Specify the number of elements per bundle and include no more than the specified number of comments per feed element. Specify whether to return feed elements posted by internal (non-community) users only.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, ConnectApi.FeedFilter filter)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, filter, threadedCommentsCollapsed)

Get a page of sorted and filtered feed elements with comments in a threaded style for a record feed. Specify the number of elements per bundle and include no more than the specified number of comments per feed element. Specify whether to return feed elements posted by internal (non-community) users only.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, ConnectApi.FeedFilter filter, Boolean threadedCommentsCollapsed)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, customFilter)

Get a page of sorted and filtered feed elements from a case feed.

API Version

40.0

Available to Guest Users

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, String customFilter)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, customFilter, threadedCommentsCollapsed)

Get a page of filtered and sorted feed elements with comments in a threaded style from a case feed.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, String customFilter, Boolean threadedCommentsCollapsed)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix)

Get feed elements from a feed filtered by a key prefix for a user.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the context user or the alias me.
keyPrefix: Type: String; A key prefix that specifies record type. A key prefix is the first three characters in the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam)

Get a page of sorted feed elements from a feed filtered by a key prefix for a user.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

A key prefix that specifies record type. A key prefix is the first three characters in the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam)

Get a page of sorted feed elements from a feed filtered by a key prefix for a user. Each feed element contains no more than the specified number of comments.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsFromFilterFeedUpdatedSince(communityId, subjectId, keyPrefix, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince)

Get a page of feed elements from a feed filtered by a key prefix for a user. Include only feed elements that have been updated since the time specified in the updatedSince parameter.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsFromFilterFeedUpdatedSince(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

An opaque token defining the modification time stamp of the feed and the sort order.

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince)

Get a page of feed elements from the Company, DirectMessageModeration, Home, and Moderation feeds. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Each feed element contains no more than the specified number of comments.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, Home, and Moderation.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

An opaque token containing information about the last modified date of the feed. Do not construct this token. Retrieve this token from the updatesToken property of the ConnectApi.FeedElementPage response body.

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince, filter)

Get a page of filtered feed elements from the Home feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Each feed element contains no more than the specified number of comments.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. The only valid value is Home.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince)

Get a page of feed elements from the Files, Groups, News, People, and Record feeds. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Each feed element contains no more than the specified number of comments.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

One of these values:

Files
Groups
News
People
Record

subjectId

Type: String

If feedType is ConnectApi.Record, subjectId can be any record ID, including a group ID. Otherwise, it must be the context user or the alias me.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, showInternalOnly)

Get a page of feed elements from a record feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Specify whether to return feed elements posted by internal (non-community) users only.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, filter)

Get a page of filtered feed elements from a UserProfile feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter.

API Version

35.0

Available to Guest Users

35.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedFilter filter)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.UserProfile.

subjectId

Type: String

The ID of any user. To specify the context user, use the user ID or the alias me.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

An opaque token defining the modification time stamp of the feed and the sort order.

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

filter

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, customFilter)

Get a page of filtered feed elements from a case feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter.

API Version

40.0

Available to Guest Users

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, String customFilter)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

An opaque token defining the modification time stamp of the feed and the sort order.

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly)

Get a page of feed elements from a record feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Specify the maximum number of feed elements in a bundle and whether to return feed elements posted by internal (non-community) users only.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, filter)

Get a page of filtered feed elements from a record feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter. Specify the maximum number of feed elements in a bundle and whether to return feed elements posted by internal (non-community) users only.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, ConnectApi.FeedFilter filter)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, customFilter)

Get a page of filtered feed elements from a case feed. Include only feed elements that have been updated since the time specified in the updatedSince parameter.

API Version

40.0

Available to Guest Users

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, String customFilter)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedWithFeedElements(communityId, feedType, pageSize)

Get information about a feed and a page of feed elements from the feed.

API Version

40.0

Available to Guest Users

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.Feed getFeedWithFeedElements(String communityId, ConnectApi.FeedType feedType, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Landing, Moderation, and PendingReview. Landing is valid only when communityId is internal.
pageSize: Type: Integer; Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in 0, feed elements aren’t returned with the feed.

Return Value

Type: ConnectApi.Feed

getFeedWithFeedElements(communityId, feedType, pageSize, recentCommentCount)

Get a page of information about the feed and the feed elements with the specified number of comments per feed element from the feed.

API Version

40.0

Available to Guest Users

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.Feed getFeedWithFeedElements(String communityId, ConnectApi.FeedType feedType, Integer pageSize, Integer recentCommentCount)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Landing, Moderation, and PendingReview. Landing is valid only when communityId is internal.
pageSize: Type: Integer; Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in 0, feed elements aren’t returned with the feed.
recentCommentCount: Type: Integer; Maximum number of comments to return with each feed element. The default value is 3.

Return Value

Type: ConnectApi.Feed

getFilterFeed(communityId, subjectId, keyPrefix)

Get a feed filtered by a key prefix for a user.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.Feed getFilterFeed(String communityId, String subjectId, String keyPrefix)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the context user or the alias me.
keyPrefix: Type: String; A key prefix is the first three characters of a record ID, which specifies the entity type.

Return Value

Type: ConnectApi.Feed

getFilterFeed(communityId, subjectId, keyPrefix, sortParam)

Get a sorted feed filtered by a key prefix for a user.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.Feed getFilterFeed(String communityId, String subjectId, String keyPrefix, ConnectApi.FeedType sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

sortParam

Type: ConnectApi.FeedType

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

Return Value

Type: ConnectApi.Feed

getFilterFeedDirectory(communityId, subjectId)

Get a feed directory of filter feeds available to the context user.

API Version

30.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedDirectory getFilterFeedDirectory(String communityId, String subjectId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the context user or the alias me.

Return Value

Type: ConnectApi.FeedDirectory

This feed directory contains a list of filter feeds, which are the news feed filtered to include feed items whose parent is a specific entity type.

Usage

Call this method to return a directory containing a list of ConnectApi.FeedDirectoryItem objects. Each object contains a key prefix associated with an entity type the context user is following. A key prefix is the first three characters of a record ID, which specifies the entity type.

Use key prefixes to filter the news feed so that it contains only feed items whose parent is the entity type associated with the key prefix. For example, get all the feed items whose parent is an Account. To get the feed items, pass a key prefix to the ConnectApi.getFeedItemsFromFilterFeed method.

The information about filter feeds never contains the key prefixes for users (005) or groups (0F9), but all users can use those key prefixes as filters.

The ConnectApi.FeedDirectory.favorites property is always empty when returned by a call to getFilterFeedDirectory because you can’t filter a news feed by favorites.

Example

This example calls getFilterFeedDirectory and loops through the returned FeedDirectoryItem objects to find the key prefixes the context user can use to filter their news feed. It then copies each keyPrefix value to a list. Finally, it passes one of the key prefixes from the list to the getFeedItemsFromFilterFeed method. The returned feed items include every feed item from the news feed whose parent is the entity type specified by the passed key prefix.

getLike(communityId, likeId)

Get a like on a post or comment.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLike getLike(String communityId, String likeId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
likeId: Type: String; The ID for a like.

Return Value

getLikesForComment(communityId, commentId)

Get likes for a comment.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLikePage getLikesForComment(String communityId, String commentId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; The ID for a comment.

Return Value

getLikesForComment(communityId, commentId, pageParam, pageSize)

Get a page of likes for a comment.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLikePage getLikesForComment(String communityId, String commentId, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; The ID for a comment.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getLikesForFeedElement(communityId, feedElementId)

Get likes for a feed element.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLikePage getLikesForFeedElement(String communityId, String feedElementId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.

Return Value

Type: ConnectApi.ChatterLikePage Class

If the feed element doesn’t support the ChatterLikes capability, the return value is ConnectApi.NotFoundException.

getLikesForFeedElement(communityId, feedElementId, pageParam, pageSize)

Get a page of likes for a feed element.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLikePage getLikesForFeedElement(String communityId, String feedElementId, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
pageParam: Type: String; The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.ChatterLikePage Class

If the feed element doesn’t support the ChatterLikes capability, the return value is ConnectApi.NotFoundException.

getLinkMetadata(communityId, urls)

Get link metadata for URLs.

API Version

42.0

Available to Guest Users

42.0

Requires Chatter

Signature

public static ConnectApi.LinkMetadataCollection getLinkMetadata(String communityId, String urls)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
urls: Type: String; Comma-separated list of URL-encoded URLs.

Return Value

Type: ConnectApi.LinkMetadataCollection

getPinnedFeedElementsFromFeed(communityId, feedType, subjectId)

Get pinned feed elements from a group or topic feed.

API Version

41.0

Available to Guest Users

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.PinnedFeedElements getPinnedFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Record and Topics.
subjectId: Type: String; If feedType is Record, subjectId must be a group ID. If feedType is Topics, subjectId must be a topic ID.

Return Value

Type: ConnectApi.PinnedFeedElements

If the feed doesn’t support this capability, the return value is ConnectApi.NotFoundException.

getReadByForFeedElement(communityId, feedElementId)

Get information about who read a feed element and when.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ReadByPage getReadByForFeedElement(String communityId, String feedElementId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.

Return Value

Type: ConnectApi.ReadByPage

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

getReadByForFeedElement(communityId, feedElementId, pageParam, pageSize)

Get a page of information about who read a feed element and when.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ReadByPage getReadByForFeedElement(String communityId, String feedElementId, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
pageParam: Type: String; Specifies the page token to be used to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.ReadByPage

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

getRelatedPosts(communityId, feedElementId, filter, maxResults)

Get posts related to the context feed element.

API Version

37.0

Available to Guest Users

37.0

Requires Chatter

Yes

Signature

public static ConnectApi.RelatedFeedPosts getRelatedPosts(String communityId, String feedElementId, ConnectApi.RelatedFeedPostType filter, Integer maxResults)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element. The feed element must be a question.

filter

Type: ConnectApi.RelatedFeedPostType

Specifies the type of related post. Values are:

Answered—Related questions that have at least one answer.
BestAnswer—Related questions that have a best answer.
Generic—All types of related questions, including answered, with a best answer, and unanswered.
Unanswered—Related questions that don’t have answers.

Generic is the default value.

maxResults

Type: Integer

The maximum number of results to return. You can return up to 25 results; 5 is the default.

Return Value

Type: ConnectApi.RelatedFeedPosts

In version 37.0 and later, related feed posts are questions.

Each related feed post has a score indicating how closely it’s related to the context feed post. We return related feed posts sorted by score, with the highest score first.

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getStream(communityId, streamId)

Get information about a Chatter feed stream.

API Version

39.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStream getStream(String communityId, String streamId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
streamId: Type: String; ID of the Chatter feed stream.

Return Value

getStream(communityId, streamId, globalScope)

Get information about a Chatter feed stream, regardless of community.

API Version

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStream getStream(String communityId, String streamId, Boolean globalScope)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
streamId: Type: String; ID of the Chatter feed stream.
globalScope: Type: Boolean; Specifies whether to get streams from all the context user’s communities, regardless of the communityId value.
If you know the community ID for the stream, we recommend setting globalScope to false.
Tip

Return Value

getStreams(communityId)

Get the Chatter feed streams for the context user.

API Version

39.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStreamPage getStreams(String communityId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.

Return Value

getStreams(communityId, sortParam)

Get and sort the Chatter feed streams for the context user.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStreamPage getStreams(String communityId, ConnectApi.SortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

sortParam

Type: ConnectApi.SortOrder

Specifies the sort order. Values are:

Ascending—Items are in ascending alphabetical order (A-Z).
Descending—Items are in descending alphabetical order (Z-A).
MostRecentlyViewed—Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.

If not specified, default value is Ascending.

Return Value

getStreams(communityId, pageParam, pageSize)

Get a page of Chatter feed streams for the context user.

API Version

39.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStreamPage getStreams(String communityId, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25.

Return Value

getStreams(communityId, pageParam, pageSize, sortParam)

Get a sorted page of Chatter feed streams for the context user.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStreamPage getStreams(String communityId, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

pageParam

Type: Integer

Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25.

sortParam

Type: ConnectApi.SortOrder

Specifies the sort order. Values are:

Ascending—Items are in ascending alphabetical order (A-Z).
Descending—Items are in descending alphabetical order (Z-A).
MostRecentlyViewed—Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.

If not specified, default value is Ascending.

Return Value

getStreams(communityId, pageParam, pageSize, sortParam, globalScope)

Get a sorted page of Chatter feed streams from all communities for the context user.

API Version

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStreamPage getStreams(String communityId, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam, Boolean globalScope)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

pageParam

Type: Integer

Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25.

sortParam

Type: ConnectApi.SortOrder

Specifies the sort order. Values are:

Ascending—Items are in ascending alphabetical order (A-Z).
Descending—Items are in descending alphabetical order (Z-A).
MostRecentlyViewed—Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.

If not specified, default value is Ascending.

globalScope

Type: Boolean

Specifies whether to get streams from all the context user’s communities, regardless of the communityId value.

If you know the community ID for the streams, we recommend setting globalScope to false.

Tip

Return Value

getSupportedEmojis()

Get supported emojis for the org.

API Version

39.0

Requires Chatter

Yes

Signature

public static ConnectApi.SupportedEmojis getSupportedEmojis()

Return Value

Type: ConnectApi.SupportedEmojis

Usage

To get the list, emojis must be enabled in your org.

getThreadsForFeedComment(communityId, commentId)

Get threaded comments for a comment.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentPage getThreadsForFeedComment(String communityId, String commentId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; ID of the comment.

Return Value

If the comment doesn’t support the comments capability, the return value is ConnectApi.NotFoundException.

getThreadsForFeedComment(communityId, commentId, pageParam, pageSize)

Get a page of threaded comments for a comment.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentPage getThreadsForFeedComment(String communityId, String commentId, String pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; ID of the comment.
pageParam: Type: String; Specifies the page token to be used to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

If the comment doesn’t support the comments capability, the return value is ConnectApi.NotFoundException.

getThreadsForFeedComment(communityId, commentId, threadedCommentsCollapsed)

Access the comments capability for a comment.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.CommentsCapability getThreadsForFeedComment(String communityId, String commentId, Boolean threadedCommentsCollapsed)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; ID of the comment.
threadedCommentsCollapsed: Type: Boolean; Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

Type: ConnectApi.CommentsCapability

If the comment doesn’t support the comments capability, the return value is ConnectApi.NotFoundException.

getTopUnansweredQuestions(communityId) (Pilot)

Get top unanswered questions for the context user in a community.

API Version

We provide top-five unanswered questions to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Pilot programs are subject to change, and we can’t guarantee acceptance. Top five unanswered questions isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Note

42.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getTopUnansweredQuestions(String communityId)

Parameters

communityId: Type: String; ID of the community.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getTopUnansweredQuestions(communityId, filter) (Pilot)

Get filtered top unanswered questions for the context user in a community.

API Version

Note

42.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getTopUnansweredQuestions(String communityId, ConnectApi.TopUnansweredQuestionsFilterType filter)

Parameters

communityId: Type: String; ID of the community.
filter: Type: ConnectApi.FeedFilter; Specifies the filter for the feed. UnansweredQuestionsWithCandidateAnswers is the only valid value.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getTopUnansweredQuestions(communityId, pageSize) (Pilot)

Get a page of top unanswered questions for the context user in a community.

API Version

Note

42.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getTopUnansweredQuestions(String communityId, Integer pageSize)

Parameters

communityId: Type: String; ID of the community.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 0 through 10. If you pass in null, the default size is 5.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getTopUnansweredQuestions(communityId, filter, pageSize) (Pilot)

Get a page of filtered top unanswered questions for the context user in a community.

API Version

Note

42.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage getTopUnansweredQuestions(String communityId, ConnectApi.FeedFilter filter, Integer pageSize)

Parameters

communityId: Type: String; ID of the community.
filter: Type: ConnectApi.FeedFilter; Specifies the filter for the feed. UnansweredQuestionsWithCandidateAnswers is the only valid value.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 0 through 10. If you pass in null, the default size is 5.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getVotesForComment(communityId, commentId, vote)

Get the first page of users who upvoted or downvoted a comment.

API Version

42.0

Available to Guest Users

42.0

Requires Chatter

Yes

Signature

public static ConnectApi.VotePage getVotesForComment(String communityId, String commentId, ConnectApi.UpDownVoteValue vote)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

commentId

Type: String

ID of the comment.

vote

Specifies the value of the vote for the feed element. Values are:

Down
Up

You can’t specify None.

Return Value

If the comment doesn’t support this capability, the return value is ConnectApi.NotFoundException.

getVotesForComment(communityId, commentId, vote, pageParam, pageSize)

Get a page of users who upvoted or downvoted a comment.

API Version

42.0

Available to Guest Users

42.0

Requires Chatter

Yes

Signature

public static ConnectApi.VotePage getVotesForComment(String communityId, String commentId, ConnectApi.UpDownVoteValue vote, Integer pageParam, Integer pageSize)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

commentId

Type: String

ID of the comment.

vote

Specifies the value of the vote for the feed element. Values are:

Down
Up

You can’t specify None.

pageParam

Type: Integer

Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

If the comment doesn’t support this capability, the return value is ConnectApi.NotFoundException.

getVotesForFeedElement(communityId, feedElementId, vote)

Get the first page of users who upvoted or downvoted a feed element.

API Version

42.0

Available to Guest Users

42.0

Requires Chatter

Yes

Signature

public static ConnectApi.VotePage getVotesForFeedElement(String communityId, String feedElementId, ConnectApi.UpDownVoteValue vote)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element.

vote

Specifies the value of the vote for the feed element. Values are:

Down
Up

You can’t specify None.

Return Value

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

getVotesForFeedElement(communityId, feedElementId, vote, pageParam, pageSize)

Get a page of users who upvoted or downvoted a feed element.

API Version

42.0

Available to Guest Users

42.0

Requires Chatter

Yes

Signature

public static ConnectApi.VotePage getVotesForFeedElement(String communityId, String feedElementId, ConnectApi.UpDownVoteValue vote, Integer pageParam, Integer pageSize)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element.

vote

Specifies the value of the vote for the feed element. Values are:

Down
Up

You can’t specify None.

pageParam

Type: Integer

Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

isCommentEditableByMe(communityId, commentId)

Discover whether the context user can edit a comment.

API Version

34.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedEntityIsEditable isCommentEditableByMe(String communityId, String commentId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; ID of the comment.

Return Value

Type: ConnectApi.FeedEntityIsEditable

If the comment doesn’t support the edit capability, the return value is ConnectApi.NotFoundException.

isFeedElementEditableByMe(communityId, feedElementId)

Discover whether the context user can edit a feed element.

API Version

34.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedEntityIsEditable isFeedElementEditableByMe(String communityId, String feedElementId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element. Feed items are the only type of feed element that can be edited.

Return Value

Type: ConnectApi.FeedEntityIsEditable

If the feed element doesn’t support the edit capability, the return value is ConnectApi.NotFoundException.

isModified(communityId, feedType, subjectId, since)

Discover whether a news feed has been updated or changed. Use this method to poll a news feed for updates.

This feature is available through a Feed Polling pilot program. This pilot program is closed and not accepting new participants.

Important

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedModifiedInfo isModified(String communityId, ConnectApi.FeedType feedType, String subjectId, String since)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; Specifies the type of feed. The only supported type is News
subjectId: Type: String; The ID of the context user or the alias me.
since: Type: String; An opaque token containing information about the last modified date of the feed. Retrieve this token from the FeedElementPage.isModifiedToken property.

Return Value

Type: ConnectApi.FeedModifiedInfo

likeComment(communityId, commentId)

Like a comment for the context user.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLike likeComment(String communityId, String commentId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; The ID for a comment.

Return Value

If the context user has already liked the comment, this method is a non-operation and returns the existing like.

likeFeedElement(communityId, feedElementId)

Like a feed element.

API Version

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLike likeFeedElement(String communityId, String feedElementId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.

Return Value

If the feed element doesn’t support the ChatterLikes capability, the return value is ConnectApi.NotFoundException.

Example

postCommentToFeedElement(communityId, feedElementId, text)

Post a plain-text comment to a feed element.

API Version

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.Comment postCommentToFeedElement(String communityId, String feedElementId, String text)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
text: Type: String; Text of the comment. A comment can contain up to 10,000 characters.

Return Value

Type: ConnectApi.Comment

If the feed element doesn’t support the Comments capability, the return value is ConnectApi.NotFoundException.

Example

postCommentToFeedElement(communityId, feedElementId, comment, feedElementFileUpload)

Post a rich-text comment to a feed element. Use this method to include mentions and to attach a file.

API Version

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.Comment postCommentToFeedElement(String communityId, String feedElementId, ConnectApi.CommentInput comment, ConnectApi.BinaryInput feedElementFileUpload)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
comment: Type: ConnectApi.CommentInput; The comment body, including text and mentions, and capabilities, such as information about an attached file. A comment can contain up to 10,000 characters.
feedElementFileUpload: Type: ConnectApi.BinaryInput; A new binary file to attach to the comment, or null. If you specify a binary file, specify the title and description of the file in the comment parameter.

Return Value

Type: ConnectApi.Comment

If the feed element doesn’t support the Comments capability, the return value is ConnectApi.NotFoundException.

Example for Posting a Comment with Mentions

You can post comments with mentions two ways. Use the ConnectApiHelper repository on GitHub to write a single line of code, or use this method example.

Example for Posting a Comment with an Existing File

Example for Posting a Comment with a New File

Example for Posting a Rich-Text Comment with an Inline Image

You can post rich-text comments with inline images and mentions two ways. Use the ConnectApiHelper repository on GitHub to write a single line of code, or use this method example. In this example, the image file is existing content that has already been uploaded to Salesforce.

Example for Posting a Rich-Text Comment with a Code Block

postFeedElement(communityId, subjectId, feedElementType, text)

Post a plain-text feed element.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement postFeedElement(String communityId, String subjectId, ConnectApi.FeedElementType feedElementType, String text)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the parent this feed element is being posted to. This value can be the ID of a user, group, or record, or the string me to indicate the context user.
feedElementType: Type: ConnectApi.FeedElementType; The only possible value is FeedItem.
text: Type: String; The text of the feed element. A feed element can contain up to 10,000 characters.

Return Value

Example

postFeedElement(communityId, feedElement)

Post a rich-text feed element. Include mentions and hashtag topics, attach already uploaded files to a feed element, and associate action link groups with a feed element. You can also use this method to share a feed element and add a comment.

API Version

36.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement postFeedElement(String communityId, ConnectApi.FeedElementInput feedElement)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElement: Type: ConnectApi.FeedElementInput; Specify rich text, including mentions. Optionally, specify a link, a poll, or up to 10 existing files.

Return Value

Example for Posting a Feed Element with a Mention

You can post feed elements with mentions two ways. Use the ConnectApiHelper repository on GitHub to write a single line of code, or use this method example.

Example for Posting a Feed Element with Existing Content

Example for Posting a Rich-Text Feed Element with an Inline Image

You can post rich-text feed elements with inline images and mentions two ways. Use the ConnectApiHelper repository on GitHub to write a single line of code, or use this method example. In this example, the image file is existing content that has already been uploaded to Salesforce. The post also includes text and a mention.

Example for Posting a Rich-Text Feed Element with a Code Block

Example for Sharing a Feed Element (in Version 39.0 and Later)

Example for Sending a Direct Message

postFeedElementBatch(communityId, feedElements)

Post a list of feed elements.

API Version

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.BatchResult[] postFeedElementBatch(String communityId, List<ConnectApi.BatchInput> feedElements)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElements: Type: List<ConnectApi.BatchInput>; The list can contain up to 500 ConnectApi.BatchInput objects. In the ConnectApi.BatchInput constructor, the input object must be a concrete instance of the abstract ConnectApi.FeedElementInput class.

Return Value

Type: ConnectApi.BatchResult[]

The ConnectApi.BatchResult.getResult() method returns a ConnectApi.FeedElement object.

The returned objects correspond to each of the input objects and are returned in the same order as the input objects.

The method call fails only if an error occurs that affects the entire operation (such as a parsing failure). If an individual object causes an error, the error is embedded within the ConnectApi.BatchResult list.

Usage

Use this method to post a list of feed elements efficiently. Create a list containing up to 500 objects and insert them all for the cost of one DML statement.

In version 36.0 and later, you can attach only one already uploaded file to each post. The ConnectApi.BatchInput has three constructors, but the postFeedElementBatch method supports only ConnectApi.BatchInput(Object input) in version 35.0 and later. This constructor doesn’t support a binary input.

In version 32.0–35.0, this method supports both ConnectApi.BatchInput(Object input) and ConnectApi.BatchInput(Object input, ConnectApi.BinaryInput binary) constructors. The ConnectApi.BatchInput(Object input, ConnectApi.BinaryInput binary) constructor allows for a single binary input.

In each constructor, the input object must be an instance of ConnectApi.FeedElementInput.

Example

This trigger bulk posts to the feeds of newly inserted accounts.

publishDraftFeedElement(communityId, feedElementId, feedElement)

Publish a draft feed element.

API Version

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement publishDraftFeedElement(String communityId, String feedElementId, ConnectApi.FeedElementInput feedElement)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element to publish.
feedElement: Type: ConnectApi.FeedElementInput; Use this optional parameter to edit your draft before publishing.

Return Value

The published feed element has a new ID.

searchFeedElements(communityId, q)

Get the first page of feed elements that match the search criteria.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElements(communityId, q, sortParam)

Get the first page of sorted feed elements that match the search criteria.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElements(communityId, q, threadedCommentsCollapsed)

Get the feed elements and comments that match the search criteria.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, Boolean threadedCommentsCollapsed)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
threadedCommentsCollapsed: Type: Boolean; Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElements(communityId, q, pageParam, pageSize)

Get a page of feed elements that match the search criteria.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, String pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: String; The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElements(communityId, q, pageParam, pageSize, sortParam)

Get a page of sorted feed elements that match the search criteria.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElements(communityId, q, pageParam, pageSize, threadedCommentsCollapsed)

Get a page of feed elements with comments in a threaded style that match the search criteria.

API Version

44.0

Available to Guest Users

44.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, String pageParam, Integer pageSize, Boolean threadedCommentsCollapsed)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: String; The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
threadedCommentsCollapsed: Type: Boolean; Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElements(communityId, q, recentCommentCount, pageParam, pageSize, sortParam)

Get a page of sorted feed elements that match the search criteria. Each feed element includes no more than the specified number of comments.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, Integer recentCommentCount, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, q)

Get the feed elements from the Company, DirectMessageModeration, Home, Moderation, and PendingReview feeds that match the search criteria.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String q)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, Home, Moderation, and PendingReview.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, pageParam, pageSize, sortParam, q)

Get a page of sorted feed elements from the Company, DirectMessageModeration, Home, Moderation, and PendingReview feeds that match the search criteria.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, Home, Moderation, and PendingReview.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q)

Get a page of sorted feed elements from the Company, DirectMessageModeration, Home, Moderation, and PendingReview feeds that match the search criteria. Each feed element includes no more than the specified number of comments.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q, filter)

Get a page of sorted and filtered feed elements from the Home feed that match the search criteria. Each feed element includes no more than the specified number of comments.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. The only valid value is Home.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

When the sortParam is MostViewed, you must pass in null for the pageParam.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

When the sortParam is MostViewed, the pageSize must be a value from 1 to 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, subjectId, q)

Get the feed elements from a feed that match the search criteria.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String q)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.
subjectId: Type: String; If feedType is Record, subjectId can be any record ID, including a group ID. If feedType is Streams, subjectId must be a stream ID. If feedType is Topics, subjectId must be a topic ID. If feedType is UserProfile, subjectId can be any user ID. If the feedType is any other value, subjectId must be the ID of the context user or the alias me.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, q)

Get a page of sorted feed elements from a feed for a record or user that match the search criteria.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.

subjectId

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Order of feed items in the feed.

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Search term. Searches keywords in the user or group name. A minimum of one character is required. This parameter does not support wildcards. This parameter is required.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q)

Get a page of sorted feed elements from a feed that match the search criteria. Each feed element includes no more than the specified number of comments.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.

subjectId

Type: String

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, filter)

Get a page of sorted and filtered feed elements from a UserProfile feed that match the search criteria.

API Version

35.0

Available to Guest Users

35.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.UserProfile.

subjectId

Type: String

The ID of any user. To specify the context user, use the user ID or the alias me.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

One or more keywords to search for in the feed elements visible to the context user. The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See Wildcards.

filter

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, customFilter)

Get a page of sorted and filtered feed elements from a case feed that match the search criteria.

API Version

40.0

Available to Guest Users

40.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly)

Get a page of sorted feed elements from a feed for a record or user that match the search criteria. Each feed element includes no more than the specified number of comments. Specify whether to return feed elements posted by internal (non-community) users only.

API Version

31.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, filter)

Get a page of sorted and filtered feed elements from a feed for a record or user that match the search criteria. Each feed element includes no more than the specified number of comments. Specify whether to return feed elements posted by internal (non-community) users only.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, customFilter)

Get a page of sorted and filtered feed elements from a case feed that match the search criteria.

API Version

40.0

Available to Guest Users

40.0

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

filter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, q)

Get the feed elements from a feed filtered by a key prefix that match the search criteria.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, String q)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the context user or the alias me.
keyPrefix: Type: String; A key prefix that specifies record type. A key prefix is the first three characters in the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, q)

Get a page of sorted feed elements from a feed filtered by a key prefix that match the search criteria.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, q)

Get a page of sorted feed elements from a feed filtered by a key prefix that match the search criteria. Each feed element includes no more than the specified number of comments.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElementPage searchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchStreams(communityId, q)

Search the Chatter feed streams for the context user.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStreamPage searchStreams(String communityId, String q)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchStreams(communityId, q, sortParam)

Search and sort the Chatter feed streams for the context user.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStreamPage searchStreams(String communityId, String q, ConnectApi.SortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

sortParam

Type: ConnectApi.SortOrder

Specifies the sort order. Values are:

Ascending—Items are in ascending alphabetical order (A-Z).
Descending—Items are in descending alphabetical order (Z-A).
MostRecentlyViewed—Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.

If not specified, default value is Ascending.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchStreams(communityId, q, pageParam, pageSize)

Search the Chatter feed streams for the context user and return a page of results.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStreamPage searchStreams(String communityId, String q, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchStreams(communityId, q, pageParam, pageSize, sortParam)

Search the Chatter feed streams for the context user and return a sorted page of results.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStreamPage searchStreams(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

pageParam

Type: Integer

Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25.

sortParam

Type: ConnectApi.SortOrder

Specifies the sort order. Values are:

Ascending—Items are in ascending alphabetical order (A-Z).
Descending—Items are in descending alphabetical order (Z-A).
MostRecentlyViewed—Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.

If not specified, default value is Ascending.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchStreams(communityId, q, pageParam, pageSize, sortParam, globalScope)

Search the Chatter feed streams from all communities for the context user and return a sorted page of results.

API Version

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStreamPage searchStreams(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam, Boolean globalScope)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

pageParam

Type: Integer

Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25.

sortParam

Type: ConnectApi.SortOrder

Specifies the sort order. Values are:

Ascending—Items are in ascending alphabetical order (A-Z).
Descending—Items are in descending alphabetical order (Z-A).
MostRecentlyViewed—Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.

If not specified, default value is Ascending.

globalScope

Type: Boolean

Specifies whether to get streams from all the context user’s communities, regardless of the communityId value.

If you know the community ID for the streams, we recommend setting globalScope to false.

Tip

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

setCommentIsVerified(communityId, commentId, isVerified)

Mark a comment as verified or unverified.

API Version

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.VerifiedCapability setCommentIsVerified(String communityId, String commentId, Boolean isVerified)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; ID of the comment on a question post. Only one comment on a question post can be marked as verified.
isVerified: Type: Boolean; Specifies whether to mark the comment as verified (true) or unverified (false).
Only verified comments can be marked as unverified, and only unverified comments can be marked as verified.

Return Value

Type: ConnectApi.VerifiedCapability

If the comment doesn’t support this capability, the return value is ConnectApi.NotFoundException.

setCommentIsVerifiedByAnonymized(communityId, commentId, isVerified, isVerifiedByAnonymized)

Mark a comment as verified by an anonymous user.

API Version

43.0

Requires Chatter

Yes

Signature

public static ConnectApi.VerifiedCapability setCommentIsVerifiedByAnonymized(String communityId, String commentId, Boolean isVerified, Boolean isVerifiedByAnonymized)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

commentId

Type: String

ID of the comment on a question post. Only one comment on a question post can be marked as verified.

isVerified

Type: Boolean

Specifies whether to mark the comment as verified (true) or unverified (false).

Only verified comments can be marked as unverified, and only unverified comments can be marked as verified.

isVerifiedByAnonymized

Type: Boolean

Specifies whether to mark the comment as verified by an anonymous user (true).

If a user previously verified a comment and then requested the activity to be deleted, use isVerifiedByAnonymized to maintain the verification and anonymize the value of lastVerifiedByUser.

You can’t set isVerified and isVerifiedByAnonymized to true at the same time. isVerifiedByAnonymized can be set to true only if isVerified is already set to true.

You can’t set isVerifiedByAnonymized to false. After isVerifiedByAnonymized is set to true, it can be undone only when another user marks the comment as unverified and then reverifies the comment.

Return Value

Type: ConnectApi.VerifiedCapability

If the comment doesn’t support this capability, the return value is ConnectApi.NotFoundException.

setCommentVote(communityId, commentId, upDownVote)

Upvote or downvote a comment.

API Version

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.UpDownVoteCapability setCommentVote(String communityId, String commentId, ConnectApi.UpDownVoteCapabilityInput upDownVote)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; ID of the comment.
upDownVote: Type: ConnectApi.UpDownVoteCapabilityInput; A ConnectApi.UpDownVoteCapabilityInput object that includes your vote.

Return Value

Type: ConnectApi.UpDownVoteCapability

If the comment doesn’t support this capability, the return value is ConnectApi.NotFoundException.

setFeedCommentStatus(communityId, commentId, status)

Set the status of a comment.

API Version

38.0

Requires Chatter

Yes

Signature

public static ConnectApi.StatusCapability setFeedCommentStatus(String communityId, String commentId, ConnectApi.StatusCapabilityInput status)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; ID of the comment.
status: Type: ConnectApi.StatusCapabilityInput; A ConnectApi.StatusCapabilityInput object that includes the status you want to set.

Return Value

Type: ConnectApi.StatusCapability

If the comment doesn’t support this capability, the return value is ConnectApi.NotFoundException.

Usage

Only users with the Can Approve Feed Post and Comment permission can set the status of a feed post or comment.

setFeedElementIsClosed(communityId, feedElementId, isClosed)

Set a feed element to closed.

API Version

Users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. If the closed feed element is a poll, users can’t vote on it. Users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer.

Admins and moderators can edit and delete closed feed elements and comments on closed feed elements. Admins and moderators can select or remove the best answer status on comments on closed feed elements.

43.0

Requires Chatter

Yes

Signature

public static ConnectApi.CloseCapability setFeedElementIsClosed(String communityId, String feedElementId, Boolean isClosed)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
isClosed: Type: Boolean; Specifies whether to set the feed element to closed (true) or not (false).

Return Value

Type: ConnectApi.CloseCapability

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

setFeedElementVote(communityId, feedElementId, upDownVote)

Upvote or downvote a feed element.

API Version

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.UpDownVoteCapability setFeedElementVote(String communityId, String feedElementId, ConnectApi.UpDownVoteCapabilityInput upDownVote)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
upDownVote: Type: ConnectApi.UpDownVoteCapabilityInput; A ConnectApi.UpDownVoteCapabilityInput object that includes your vote.

Return Value

Type: ConnectApi.UpDownVoteCapability

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

setFeedEntityStatus(communityId, feedElementId, status)

Set the status of a feed post.

API Version

37.0

Requires Chatter

Yes

Signature

public static ConnectApi.StatusCapability setFeedEntityStatus(String communityId, String feedElementId, ConnectApi.StatusCapabilityInput status)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
status: Type: ConnectApi.StatusCapabilityInput; A ConnectApi.StatusCapabilityInput object that includes the status you want to set.

Return Value

Type: ConnectApi.StatusCapability

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

Usage

Only users with the Can Approve Feed Post and Comment permission can set the status of a feed post or comment.

setIsMutedByMe(communityId, feedElementId, isMutedByMe)

Mute or unmute a feed element.

API Version

35.0

Requires Chatter

Yes

Signature

public static ConnectApi.MuteCapability setIsMutedByMe(String communityId, String feedElementId, Boolean isMutedByMe)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
isMutedByMe: Type: Boolean; Indicates whether the feed element is muted for the context user. Default value is false.

Return Value

Type: ConnectApi.MuteCapability

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

setIsReadByMe(communityId, feedElementId, readBy)

Mark a feed element as read for the context user using an input class.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ReadByCapability setIsReadByMe(String communityId, String feedElementId, ConnectApi.ReadByCapabilityInput readBy)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element to mark as read.
readBy: Type: ConnectApi.ReadByCapabilityInput; A ConnectApi.ReadByCapabilityInput body indicating to mark the feed elements as read.

Return Value

Type: ConnectApi.ReadByCapability

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

setIsReadByMe(communityId, feedElementId, isReadByMe)

Mark a feed element as read for the context user.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.ReadByCapability setIsReadByMe(String communityId, String feedElementId, Boolean isReadByMe)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element to mark as read.
isReadByMe: Type: Boolean; Specifies to mark the feed element as read (true) for the context user.

Return Value

Type: ConnectApi.ReadByCapability

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

updateComment(communityId, commentId, comment)

Edit a comment.

API Version

34.0

Requires Chatter

Yes

Signature

public static ConnectApi.Comment updateComment(String communityId, String commentId, ConnectApi.CommentInput comment)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; ID of the comment to be edited.
comment: Type: ConnectApi.CommentInput; Information about the comment to be edited.

Return Value

Type: ConnectApi.Comment

If the comment doesn’t support the edit capability, the return value is ConnectApi.NotFoundException.

Example

updateDirectMessage(communityId, feedElementId, directMessage)

Update the members of a direct message.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.DirectMessageCapability updateDirectMessage(String communityId, String feedElementId, ConnectApi.DirectMessageCapabilityInput directMessage)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
directMessage: Type: ConnectApi.DirectMessageCapabilityInput; A ConnectApi.DirectMessageCapabilityInput body that includes the members to add and remove.

Return Value

Type: ConnectApi.DirectMessageCapability

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

updateFeedElement(communityId, feedElementId, feedElement)

Edit a feed element.

API Version

34.0

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement updateFeedElement(String communityId, String feedElementId, ConnectApi.FeedElementInput feedElement)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element to be edited. Feed items are the only type of feed element that can be edited.
feedElement: Type: ConnectApi.FeedElementInput; Information about the feed item to be edited.

Return Value

If the feed element doesn’t support the edit capability, the return value is ConnectApi.NotFoundException.

Example for Editing a Feed Post

Example for Editing a Question Title and Post

updateFeedElementBookmarks(communityId, feedElementId, bookmarks)

Bookmark a feed element or remove a bookmark from a feed element using an input class.

API Version

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.BookmarksCapability updateFeedElementBookmarks(String communityId, String feedElementId, ConnectApi.BookmarksCapabilityInput bookmarks)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
bookmarks: Type: ConnectApi.BookmarksCapabilityInput; Information about a bookmark.

Return Value

Type: ConnectApi.BookmarksCapability

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

updateFeedElementBookmarks(communityId, feedElementId, isBookmarkedByCurrentUser)

Bookmark a feed element or remove a bookmark from a feed element.

API Version

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.BookmarksCapability updateFeedElementBookmarks(String communityId, String feedElementId, Boolean isBookmarkedByCurrentUser)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
isBookmarkedByCurrentUser: Type: Boolean; Specify whether to bookmark the feed element (true) or not (false).

Return Value

Type: ConnectApi.BookmarksCapability

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

Example

updateFeedElementReadByCapabilityBatch(communityId, feedElementIds, readBy)

Mark multiple feed elements as read by the context user at the same time using an input class.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.BatchResult[] updateFeedElementReadByCapabilityBatch(String communityId, List<String> feedElementIds, ConnectApi.ReadByCapabilityInput readBy)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementIds: Type: List<String>; Up to 500 feed element IDs to mark as read.
readBy: Type: ConnectApi.ReadByCapabilityInput; A ConnectApi.ReadByCapabilityInput body indicating to mark the feed elements as read.

Return Value

Type: ConnectApi.BatchResult[]

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

The returned objects correspond to each of the input objects and are returned in the same order as the input objects.

updateFeedElementReadByCapabilityBatch(communityId, feedElementIds, isReadByMe)

Mark multiple feed elements as read by the context user at the same time.

API Version

40.0

Requires Chatter

Yes

Signature

public static ConnectApi.BatchResult[] updateFeedElementReadByCapabilityBatch(String communityId, List<String> feedElementIds, Boolean isReadByMe)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementIds: Type: List<String>; Up to 500 feed element IDs to mark as read.
isReadByMe: Type: Boolean; Specifies to mark the feed element as read (true) for the context user.

Return Value

Type: ConnectApi.BatchResult[]

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

updateLikeForComment(communityId, commentId, isLikedByCurrentUser)

Like or unlike a comment.

API Version

39.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLikePage updateLikeForComment(String communityId, String commentId, Boolean isLikedByCurrentUser)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
commentId: Type: String; ID of the comment.
isLikedByCurrentUser: Type: Boolean; Specifies if the context user likes (true) or unlikes (false) the comment.

Return Value

updateLikeForFeedElement(communityId, feedElementId, isLikedByCurrentUser)

Like or unlike a feed element.

API Version

39.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLikePage updateLikeForFeedElement(String communityId, String feedElementId, Boolean isLikedByCurrentUser)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
isLikedByCurrentUser: Type: Boolean; Specifies if the context user likes (true) or unlikes (false) the feed element.

Return Value

If the feed element doesn’t support the ChatterLikes capability, the return value is ConnectApi.NotFoundException.

updatePinnedFeedElements(communityId, feedType, subjectId, pin)

Pin or unpin feed elements to a group or topic feed.

API Version

41.0

Available to Guest Users

41.0

Requires Chatter

Yes

Signature

public static ConnectApi.PinCapability updatePinnedFeedElements(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.PinCapabilityInput pin)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Record and Topics.
subjectId: Type: String; If feedType is Record, subjectId must be a group ID. If feedType is Topics, subjectId must be a topic ID.
pin: Type: ConnectApi.PinCapabilityInput; A ConnectApi.PinCapabilityInput object indicating the feed element to pin or unpin.

Return Value

Type: ConnectApi.PinCapability

If the feed doesn’t support this capability, the return value is ConnectApi.NotFoundException.

updateStream(communityId, streamId, streamInput)

Update a Chatter feed stream.

API Version

39.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterStream updateStream(String communityId, String streamId, ConnectApi.ChatterStreamInput streamInput)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
streamId: Type: String; ID of the Chatter feed stream.
streamInput: Type: ConnectApi.ChatterStreamInput; A ConnectApi.ChatterStreamInput object.

Return Value

voteOnFeedElementPoll(communityId, feedElementId, myChoiceId)

Vote on a poll or change your vote on a poll.

API Version

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.PollCapability voteOnFeedElementPoll(String communityId, String feedElementId, String myChoiceId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElementId: Type: String; ID of the feed element.
myChoiceId: Type: String; ID of the poll item you’re voting for. The key prefix for poll items is 09A.

Return Value

Type: ConnectApi.PollCapability Class

If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.

Example

ChatterFeeds Test Methods

The following are the test methods for ChatterFeeds. All methods are static.

For information about using these methods to test your ConnectApi code, see Testing ConnectApi Code.

setTestGetFeedElementsFromFeed(communityId, feedType, result)

Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception.

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, pageParam, pageSize, sortParam, result)

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

The only valid value for this parameter is Company.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, result)

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, filter, result)

API Version

32.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. The only valid value is Home.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, filter, threadedCommentsCollapsed, result)

Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.getFeedElementsFromFeed method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

44.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

The type of feed. The only valid value is Home.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, result)

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The feed type.
subjectId: Type: String; The ID of the context user or the alias me.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, result)

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, result)

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, showInternalOnly, result)

API Version

31.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, filter, result)

Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsFromFeed is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.

API Version

35.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.UserProfile.

subjectId

Type: String

The ID of any user. To specify the context user, use the user ID or the alias me.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

filter

Value must be ConnectApi.FeedFilter.CommunityScoped. Filters the feed to include only feed elements that are scoped to communities. Feed elements that are always visible in all communities are filtered out. Currently, feed elements scoped to communities have a User or a Group parent record. However, other parent record types could be scoped to communities in the future.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, filter, threadedCommentsCollapsed, result)

API Version

44.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.UserProfile.

subjectId

Type: String

The ID of any user. To specify the context user, use the user ID or the alias me.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

filter

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, customFilter, result)

API Version

40.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, result)

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

result

Type: ConnectApi.FeedElementPage

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, filter, result)

API Version

32.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

result

Type: ConnectApi.FeedElementPage

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, filter, threadedCommentsCollapsed, result)

API Version

44.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

result

Type: ConnectApi.FeedElementPage

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, customFilter, result)

API Version

40.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

result

Type: ConnectApi.FeedElementPage

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, customFilter, threadedCommentsCollapsed, result)

API Version

44.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

threadedCommentsCollapsed

Type: Boolean

Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, result)

Register a ConnectApi.FeedElementPage object to be returned when the matching getFeedElementsFromFilterFeed method is called in a test context. Use the method with the same parameters or the code throws an exception.

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the context user or the alias me.
keyPrefix: Type: String; A key prefix that specifies record type. A key prefix is the first three characters in the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, result)

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, result)

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsFromFilterFeedUpdatedSince(communityId, subjectId, keyPrefix, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, result)

Register a ConnectApi.FeedElementPage object to be returned when the getFeedElementsFromFilterFeedUpdatedSince method is called in a test context.

API Version

31.0

Signature

public static Void setTestGetFeedElementsFromFilterFeedUpdatedSince(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

An opaque token defining the modification time stamp of the feed and the sort order.

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince, result)

Register a ConnectApi.FeedElementPage object to be returned when getFeedElementsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.

API Version

31.0

Signature

public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince, filter, result)

API Version

32.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, result)

API Version

31.0

Signature

public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

One of these values:

Files
Groups
News
People
Record

subjectId

Type: String

If feedType is ConnectApi.Record, subjectId can be any record ID, including a group ID. Otherwise, it must be the context user or the alias me.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, showInternalOnly, result)

API Version

31.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, filter, result)

API Version

35.0

Signature

public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.UserProfile.

subjectId

Type: String

The ID of any user. To specify the context user, use the user ID or the alias me.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

An opaque token defining the modification time stamp of the feed and the sort order.

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

filter

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, customFilter, result)

API Version

40.0

Signature

public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, String customFilter, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

An opaque token defining the modification time stamp of the feed and the sort order.

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, result)

API Version

31.0

Signature

public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Type: ConnectApi.FeedDensity

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

result

Type: ConnectApi.FeedElementPage

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, filter, result)

API Version

32.0

Signature

public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Type: ConnectApi.FeedDensity

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

result

Type: ConnectApi.FeedElementPage

The object containing test data.

Return Value

Type: Void

setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, customFilter, result)

API Version

40.0

Signature

public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, String customFilter, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

elementsPerBundle

Type: Integer

Maximum number of feed elements per bundle. The default and maximum value is 10.

density

Type: ConnectApi.FeedDensity

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

The updatedSince parameter doesn’t return feed elements that are created in the same second as the call.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

result

Type: ConnectApi.FeedElementPage

The object containing test data.

Return Value

Type: Void

setTestGetRelatedPosts(communityId, feedElementId, filter, maxResults, result)

Register a ConnectApi.RelatedFeedPosts object to be returned when the matching ConnectApi.getRelatedPosts(communityId, feedElementId, filter, maxResults) method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

37.0

Signature

public static Void setTestGetRelatedPosts(String communityId, String feedElementId, ConnectApi.RelatedFeedPostType filter, Integer maxResults, ConnectApi.RelatedFeedPosts result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedElementId

Type: String

ID of the feed element. The feed element must be a question.

filter

Type: ConnectApi.RelatedFeedPostType

Specifies the type of related feed post. Values are:

Answered—Related questions that have at least one answer.
BestAnswer—Related questions that have a best answer.
Generic—All types of related questions, including answered, with a best answer, and unanswered.
Unanswered—Related questions that don’t have answers.

Generic is the default value.

maxResults

Type: Integer

The maximum number of results to return. You can return up to 25 results; 5 is the default.

result

Type: ConnectApi.RelatedFeedPosts

The object containing test data.

In version 37.0 and later, related feed posts are questions.

Return Value

Type: Void

setTestGetTopUnansweredQuestions(communityId, result) (Pilot)

Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.getTopUnansweredQuestions method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

Note

42.0

Signature

public static Void setTestGetTopUnansweredQuestions(String communityId, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; ID of the community.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestGetTopUnansweredQuestions(communityId, filter, result) (Pilot)

API Version

Note

42.0

Signature

public static Void setTestGetTopUnansweredQuestions(String communityId, ConnectApi.TopUnansweredQuestionsFilterType filter, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; ID of the community.
filter: Type: ConnectApi.FeedFilter; Specifies the filter for the feed. UnansweredQuestionsWithCandidateAnswers is the only valid value.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestGetTopUnansweredQuestions(communityId, pageSize, result) (Pilot)

API Version

Note

42.0

Signature

public static Void setTestGetTopUnansweredQuestions(String communityId, Integer pageSize, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; ID of the community.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 0 through 10. If you pass in null, the default size is 5.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestGetTopUnansweredQuestions(communityId, filter, pageSize, result) (Pilot)

API Version

Note

42.0

Signature

public static Void setTestGetTopUnansweredQuestions(String communityId, ConnectApi.FeedFilter filter, Integer pageSize, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; ID of the community.
filter: Type: ConnectApi.FeedFilter; Specifies the filter for the feed. UnansweredQuestionsWithCandidateAnswers is the only valid value.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 0 through 10. If you pass in null, the default size is 5.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedElements(communityId, q, result)

Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElements method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

31.0

Signature

public static Void setTestSearchFeedElements(String communityId, String q, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedElements(communityId, q, sortParam, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElements(String communityId, String q, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElements(communityId, q, threadedCommentsCollapsed, result)

API Version

44.0

Signature

public static Void setTestSearchFeedElements(String communityId, String q, Boolean threadedCommentsCollapsed, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
threadedCommentsCollapsed: Type: Boolean; Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedElements(communityId, q, pageParam, pageSize, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElements(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.D
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: String; The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedElements(communityId, q, pageParam, pageSize, sortParam, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElements(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElements(communityId, q, pageParam, pageSize, threadedCommentsCollapsed, result)

API Version

44.0

Signature

public static Void setTestSearchFeedElements(String communityId, String q, String pageParam, Integer pageSize, Boolean threadedCommentsCollapsed, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: String; The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
threadedCommentsCollapsed: Type: Boolean; Specifies whether to return threaded comments in a collapsed style (true) or not (false). If you pass in null, the default is false.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedElements(communityId, q, recentCommentCount, pageParam, pageSize, sortParam, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElements(String communityId, String q, Integer recentCommentCount, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, q, result)

Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

31.0

Signature

public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String q, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, Home, Moderation, and PendingReview.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, pageParam, pageSize, sortParam, q, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, Home, Moderation, and PendingReview.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q, filter, result)

API Version

32.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. The only valid value is Home.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, q, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String q, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.
subjectId: Type: String; If feedType is Record, subjectId can be any record ID, including a group ID. If feed type is UserProfile, subjectId can be any user ID. If feedType is any other value, subjectId must be the ID of the context user or the alias me.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, q, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.

subjectId

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Order of feed items in the feed.

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Search term. Searches keywords in the user or group name. A minimum of one character is required. This parameter does not support wildcards. This parameter is required.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.

subjectId

Type: String

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, filter, result)

Register a ConnectApi.FeedElementPage object to be returned when searchFeedElementsInFeed is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.

API Version

35.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.UserProfile.

subjectId

Type: String

The ID of any user. To specify the context user, use the user ID or the alias me.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

The amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

Specifies the page token to be used to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

filter

result

Type: ConnectApi.FeedElementPage

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, customFilter, result)

API Version

40.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

The amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

customFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

result

Type: ConnectApi.FeedElementPage

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, result)

API Version

31.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, filter, result)

API Version

32.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

filter

Specifies the feed filters.

AllQuestions—Feed elements that are questions.
AuthoredBy—Feed elements authored by the user profile owner. This value is valid only for the UserProfile feed.
CommunityScoped—Feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
QuestionsWithCandidateAnswers—Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
QuestionsWithCandidateAnswersReviewedPublished—Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
Read—Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the Record feed of a group.
SolvedQuestions—Feed elements that are questions and that have a best answer.
UnansweredQuestions—Feed elements that are questions and that don’t have any answers.
UnansweredQuestionsWithCandidateAnswers—Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
Unread—Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the Record feed of a group.
UnsolvedQuestions—Feed elements that are questions and that don’t have a best answer.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, customFilter, result)

API Version

40.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

The ID of a case.

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

showInternalOnly

Type: Boolean

Specifies whether to show only feed elements from internal (non-community) users (true), or not (false). The default value is false.

cusotmFilter

Type: String

Custom filter that applies only to the case feed. See customFeedFilter in the Metadata API Developer Guide for supported values.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, q, result)

Register a ConnectApi.FeedElementPage object to be returned when the matching ConnectApi.searchFeedElementsInFilterFeed method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

31.0

Signature

public static Void setTestSearchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, String q, ConnectApi.FeedElementPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the context user or the alias me.
keyPrefix: Type: String; A key prefix that specifies record type. A key prefix is the first three characters in the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
result: Type: ConnectApi.FeedElementPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, q, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)

API Version

31.0

Signature

public static Void setTestSearchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

Maximum number of comments to return with each feed element. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result

The object containing test data.

Return Value

Type: Void

setTestSearchStreams(communityId, q, result)

Register a ConnectApi.ChatterStreamPage object to be returned when the matching ConnectApi.searchStream(communityId, q) method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

40.0

Signature

public static Void setTestSearchStreams(String communityId, String q, ConnectApi.ChatterStreamPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
result: Type: ConnectApi.ChatterStreamPage; The object containing test data.

Return Value

Type: Void

setTestSearchStreams(communityId, q, sortParam, result)

Register a ConnectApi.ChatterStreamPage object to be returned when the matching ConnectApi.searchStream(communityId, q, sortParam) method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

40.0

Signature

public static Void setTestSearchStreams(String communityId, String q, ConnectApi.SortOrder sortParam, ConnectApi.ChatterStreamPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

sortParam

Type: ConnectApi.SortOrder

Specifies the sort order. Values are:

Ascending—Items are in ascending alphabetical order (A-Z).
Descending—Items are in descending alphabetical order (Z-A).
MostRecentlyViewed—Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.

If not specified, default value is Ascending.

result

The object containing test data.

Return Value

Type: Void

setTestSearchStreams(communityId, q, pageParam, pageSize, result)

Register a ConnectApi.ChatterStreamPage object to be returned when the matching ConnectApi.searchStreams(communityId, q, pageParam, pageSize) method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

40.0

Signature

public static Void setTestSearchStreams(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.ChatterStreamPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25.
result: Type: ConnectApi.ChatterStreamPage; The object containing test data.

Return Value

Type: Void

setTestSearchStreams(communityId, q, pageParam, pageSize, sortParam, result)

Register a ConnectApi.ChatterStreamPage object to be returned when the matching ConnectApi.searchStreams(communityId, q, pageParam, pageSize, sortParam) method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

40.0

Signature

public static Void setTestSearchStreams(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam, ConnectApi.ChatterStreamPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

pageParam

Type: Integer

Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25.

sortParam

Type: ConnectApi.SortOrder

Specifies the sort order. Values are:

Ascending—Items are in ascending alphabetical order (A-Z).
Descending—Items are in descending alphabetical order (Z-A).
MostRecentlyViewed—Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.

If not specified, default value is Ascending.

result

The object containing test data.

Return Value

Type: Void

setTestSearchStreams(communityId, q, pageParam, pageSize, sortParam, globalScope, result)

Register a ConnectApi.ChatterStreamPage object to be returned when the matching ConnectApi.searchStreams(communityId, q, pageParam, pageSize, sortParam, globalScope) method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

41.0

Signature

public static Void setTestSearchStreams(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam, Boolean globalScope, ConnectApi.ChatterStreamPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

pageParam

Type: Integer

Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

pageSize

Type: Integer

Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25.

sortParam

Type: ConnectApi.SortOrder

Specifies the sort order. Values are:

Ascending—Items are in ascending alphabetical order (A-Z).
Descending—Items are in descending alphabetical order (Z-A).
MostRecentlyViewed—Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.

If not specified, default value is Ascending.

globalScope

Type: Boolean

Specifies whether to get streams from all the context user’s communities, regardless of the communityId value.

result

The object containing test data.

Return Value

Type: Void

Retired ChatterFeeds Methods

The following methods for ChatterFeeds are retired.

deleteFeedItem(communityId, feedItemId)

Delete a feed item.

API Version

28.0–31.0

In version 32.0 and later, use deleteFeedElement(communityId, feedElementId).

Important

Requires Chatter

Yes

Signature

public static Void deleteFeedItem(String communityId, String feedItemId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.

Return Value

Type: Void

getCommentsForFeedItem(communityId, feedItemId)

Get comments for a feed item.

API Version

28.0–31.0

In version 32.0 and later, use getCommentsForFeedElement(communityId, feedElementId).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.CommentPage getCommentsForFeedItem(String communityId, String feedItemId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.

Return Value

getCommentsForFeedItem(communityId, feedItemId, pageParam, pageSize)

Get a page of comments for a feed item.

API Version

28.0–31.0

In version 32.0 and later, use getCommentsForFeedElement(communityId, feedElementId, pageParam, pageSize).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.CommentPage getCommentsForFeedItem(String communityId, String feedItemId, String pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.
pageParam: Type: String; The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getFeedItem(communityId, feedItemId)

Get a feed item.

API Version

28.0–31.0

In version 32.0 and later, use getFeedElement(communityId, feedElementId).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItem getFeedItem(String communityId, String feedItemId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.

Return Value

Note

getFeedItemBatch(communityId, feedItemIds)

Get a list of feed items.

API Version

31.0–31.0

In version 32.0 and later, use getFeedElementBatch(communityId, feedElementIds).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.BatchResult[] getFeedItemBatch(String communityId, List<String> feedItemIds)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemIds: Type: List<String>; A list of up to 500 feed item IDs.

Return Value

Type: ConnectApi.BatchResult[]

The ConnectApi.BatchResult.getResult() method returns a ConnectApi.FeedItem object and errors for feed items that didn’t load.

Example

getFeedItemsFromFeed(communityId, feedType)

Get feed items from the Company, Home, and Moderation feeds.

API Version

28.0–31.0

In version 32.0 and later, use getFeedElementsFromFeed(communityId, feedType).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsFromFeed(communityId, feedType, pageParam, pageSize, sortParam)

Get a page of sorted feed items from the Company, Home, and Moderation feeds.

API Version

28.0–31.0

In version 32.0 and later, use getFeedElementsFromFeed(communityId, feedType, pageParam, pageSize, sortParam).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam)

Get a page of sorted feed items from the Company, Home, and Moderation feeds. Each feed item contains no more than the specified number of comments.

API Version

29.0–31.0

In version 32.0 and later, use getFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsFromFeed(communityId, feedType, subjectId)

Get feed items from a feed for a user or record.

API Version

28.0–31.0

In version 32.0 and later, use getFeedElementsFromFeed(communityId, feedType, subjectId).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.
subjectId: Type: String; If feedType is Record, subjectId can be any record ID, including a group ID. If feedType is Streams, subjectId must be a stream ID. If feedType is Topics, subjectId must be a topic ID. If feedType is UserProfile, subjectId can be any user ID. If the feedType is any other value, subjectId must be the ID of the context user or the alias me.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsFromFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam)

Get a page of sorted feed items from a feed for a user or record.

API Version

28.0–31.0

In version 32.0 and later, use getFeedElementsFromFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam)

Get a page of sorted feed items from a feed for a user or record. Each feed item includes no more than the specified number of comments.

API Version

29.0–31.0

In version 32.0 and later, use getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, showInternalOnly)

Get a page of sorted feed items from a record feed for a user or record. Each feed item includes no more than the specified number of comments. Specify whether to return feed items posted by internal (non-community) users only.

API Version

30.0–31.0

In version 32.0 and later, use getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, showInternalOnly).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix)

Get feed items from a feed filtered by a key prefix for a user.

API Version

28.0–31.0

In version 32.0 and later, use getFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the context user or the alias me.
keyPrefix: Type: String; A key prefix that specifies record type. A key prefix is the first three characters in the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam)

Get a page of sorted feed items from a feed filtered by a key prefix for a user.

API Version

28.0–31.0

In version 32.0 and later, use getFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam)

Get a page of sorted feed items from a feed filtered by a key prefix for a user. Each feed item contains no more than the specified number of comments.

API Version

29.0–31.0

In version 32.0 and later, use getFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsFromFilterFeedUpdatedSince(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, updatedSince)

Get a page of feed items from a feed filtered by a key prefix for a user. Include only feed items that have been updated since the time specified in the updatedSince parameter.

API Version

30.0–31.0

In version 32.0 and later, use getFeedElementsFromFilterFeedUpdatedSince(communityId, subjectId, keyPrefix, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsFromFilterFeedUpdatedSince(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

An opaque token containing information about the last modified date of the feed. Do not construct this token. To retrieve this token, call getFeedItemsFromFilterFeed and take the value from the updatesToken property of the ConnectApi.FeedItemPage response body.

Return Value

Usage

This method returns only feed items that have been updated since the time specified in the updatedSince argument. A feed item is considered to be updated if it was created since the last feed request, or if sort=LastModifiedDateDesc and a comment was added to the feed item since the last feed request. Adding likes and topics doesn’t update a feed item.

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

getFeedItemsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince)

Get a page of feed items from the Company, Home, and Moderation feeds. Include only feed items that have been updated since the time specified in the updatedSince parameter. Each feed item contains no more than the specified number of comments.

API Version

30.0–31.0

In version 32.0 and later, use getFeedElementsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsUpdatedSince(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

Example

This example gets the feed items in the company feed and grabs the updatesToken property from the returned object. It then passes the value of updatesToken to the getFeedItemsUpdatedSince method to get the feed items updated since the first call:

getFeedItemsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince)

Get a page of feed items from the Files, Groups, News, People, and Record feeds. Include only feed items that have been updated since the time specified in the updatedSince parameter. Each feed item contains no more than the specified number of comments.

API Version

30.0–31.0

In version 32.0 and later, use getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage getFeedItemsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

One of these values:

Files
Groups
News
People
Record

subjectId

Type: String

If feedType is ConnectApi.Record, subjectId can be any record ID, including a group ID. Otherwise, it must be the context user or the alias me.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

Example

This example gets the feed items in the news feed and grabs the updatesToken property from the returned object. It then passes the value of updatesToken to the getFeedItemsUpdatedSince method to get the feed items updated since the first call:

getFeedItemsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, showInternalOnly)

Get a page of feed items from a record feed. Include only feed items that have been updated since the time specified in the updatedSince parameter. Specify whether to return feed items posted by internal (non-community) users only.

API Version

30.0–31.0

In version 32.0 and later, use getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, showInternalOnly).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

Return Value

Usage

If showInternalOnly is true and Salesforce Communities is enabled, feed items from communities are included. Otherwise, only feed items from the internal community are included.

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

Example

getFeedPoll(communityId, feedItemId)

Get the poll associated with a feed item.

API Version

28.0–31.0

In version 32.0 and later, use getFeedElementPoll(communityId, feedElementId).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedPoll getFeedPoll(String communityId, String feedItemId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.

Return Value

Type: ConnectApi.FeedPoll

Note

getLikesForFeedItem(communityId, feedItemId)

Get likes for a feed item.

API Version

28.0–31.0

In version 32.0 and later, use getLikesForFeedElement(communityId, feedElementId).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLikePage getLikesForFeedItem(String communityId, String feedItemId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.

Return Value

getLikesForFeedItem(communityId, feedItemId, pageParam, pageSize)

Get a page of likes for a feed item.

API Version

28.0–31.0

In version 32.0 and later, use getLikesForFeedElement(communityId, feedElementId, pageParam, pageSize).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLikePage getLikesForFeedItem(String communityId, String feedItemId, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

likeFeedItem(communityId, feedItemId)

Like a feed item for the context user.

API Version

28.0–31.0

In version 32.0 and later, use likeFeedElement(communityId, feedElementId).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterLike likeFeedItem(String communityId, String feedItemId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.

Return Value

If the context user already liked the feed item, this method is a non-operation and returns the existing like.

postComment(communityId, feedItemId, text)

Post a plain-text comment to a feed item.

API Version

28.0–31.0

In version 32.0 and later, use postCommentToFeedElement(communityId, feedElementId, text).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.Comment postComment(String communityId, String feedItemId, String text)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.
text: Type: String; The text of the comment. Mentions are downgraded to plain text. To include a mention that links to a user, call postComment(communityId, feedItemId, comment, feedItemFileUpload) and pass the mention in a ConnectApi.CommentInput object.

Return Value

Type: ConnectApi.Comment

Usage

If hashtags or links are detected in text, they are included in the comment as hashtag and link segments. Mentions are not detected in text and are not separated out of the text.

Feed items and comments can contain up to 10,000 characters.

postComment(communityId, feedItemId, comment, feedItemFileUpload)

Post a rich-text comment to a feed item. Use this method to include mentions and to attach a file to a comment.

API Version

28.0–31.0

In version 32.0 and later, use postCommentToFeedElement(communityId, feedElementId, comment, feedElementFileUpload).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.Comment postComment(String communityId, String feedItemId, ConnectApi.CommentInput comment, ConnectApi.BinaryInput feedItemFileUpload)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.
comment: Type: ConnectApi.CommentInput; In the CommentInput object, specify rich text, including @mentions. Optionally, in the CommentInput.attachment property, specify an existing file or a new file
feedItemFileUpload: Type: ConnectApi.BinaryInput; If you specify a NewFileAttachmentInput object in the CommentInput.attachment property, specify the new binary file to attach in this argument. Otherwise, do not specify a value.

Return Value

Type: ConnectApi.Comment

Usage

Feed items and comments can contain up to 10,000 characters.

Sample: Posting a Comment with a New File Attachment

To post a comment and upload and attach a new file to the comment, create a ConnectApi.CommentInput object and a ConnectApi.BinaryInput object to pass to the ConnectApi.ChatterFeeds.postComment method.

postFeedElement(communityId, feedElement, feedElementFileUpload)

Post a rich-text feed element. Include mentions and hashtag topics, attach a file to a feed element, and associate action link groups with a feed element. You can also use this method to share a feed element and add a comment.

API Version

31.0–35.0

In version 36.0 and later, this method is no longer available because you can’t create a feed post and upload a binary file in the same call. Upload files to Salesforce first, and then use postFeedElement(communityId, feedElement) to create the feed post and attach the files.

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement postFeedElement(String communityId, ConnectApi.FeedElementInput feedElement, ConnectApi.BinaryInput feedElementFileUpload)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedElement: Type: ConnectApi.FeedElementInput; Specify rich text, including mentions. Optionally, specify a link, a poll, an existing file, or a new file.
feedElementFileUpload: Type: ConnectApi.BinaryInput; Specify the new binary file to attach to the post only if you also specify a NewFileAttachmentInput object in the feedElement parameter. Otherwise, pass null.

Return Value

Example for Posting a Feed Element with a New (Binary) File

postFeedItem(communityId, feedType, subjectId, text)

Post a plain-text feed item.

API Version

28.0–31.0

In version 32.0 and later, use postFeedElement(communityId, subjectId, feedElementType, text).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItem postFeedItem(String communityId, ConnectApi.FeedType feedType, String subjectId, String text)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

One of the following:

News
Record
UserProfile

Use Record to post to a group.

subjectId

Type: String

The value depends on the feedType:

News—ID of the context user or the keyword me.
Record—ID of any record with a feed, including groups.
UserProfile—ID of any user.

text

Type: String

Text of the feed item. Mentions are downgraded to plain text. To include a mention that links to the user, call the postFeedItem(communityId, feedType, subjectId, feedItemInput, feedItemFileUpload) method and pass the mention in a ConnectApi.FeedItemInput object.

Return Value

Note

Usage

Feed items and comments can contain up to 10,000 characters.

Posts to ConnectApi.FeedType.UserProfile in API versions 23.0 and 24.0 created user status updates, not feed items. For posts to the User Profile Feed in those API versions, the character limit is 1,000 characters.

postFeedItem(communityId, feedType, subjectId, feedItemInput, feedItemFileUpload)

Post a rich-text feed item to a feed. Use this method to include mentions and hashtag topics and to attach a file to a feed item. You can also use this method to share a feed item and add a comment.

API Version

28.0–31.0

In version 32.0 and later, use postFeedElement(communityId, feedElement, feedElementFileUpload).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItem postFeedItem(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.FeedItemInput feedItemInput, ConnectApi.BinaryInput feedItemFileUpload)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

One of the following:

News
Record
UserProfile

To post a feed item to a group, use Record and use a group ID as the subjectId.

subjectId

Type: String

feedItemInput

Type: ConnectApi.FeedItemInput

In the FeedItemInput object, specify rich text. Optionally, in the FeedItemInput.attachment property, specify a link, a poll, an existing file, or a new file.

feedItemFileUpload

Type: ConnectApi.BinaryInput

If you specify a NewFileAttachmentInput object in the FeedItemInput.attachment property, specify the new binary file to attach in this argument. Otherwise, do not specify a value.

Return Value

Note

Usage

Feed items and comments can contain up to 10,000 characters. Posts to ConnectApi.FeedType.UserProfile in API versions 23.0 and 24.0 created user status updates, not feed items. For posts to the User Profile Feed in those API versions, the character limit is 1,000 characters.

Example for Sharing a Feed Item and Adding a Comment

To share a feed item and add a comment, create a ConnectApi.FeedItemInput object containing the comment and the feed item to share. Then pass the object to ConnectApi.ChatterFeeds.postFeeditem in the feedItemInput argument. The message segments in the message body input are used as the comment.

Example for Posting a Mention to a User Profile Feed

To post to a user profile feed and include an @mention, call the ConnectApi.ChatterFeeds.postFeedItem method.

searchFeedItems(communityId, q)

Get the feed items that match the search criteria.

API Version

28.0–31.0

In version 32.0 and later, use searchFeedElements(communityId, q).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItems(String communityId, String q)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItems(communityId, q, sortParam)

Get the sorted feed items that match the search criteria.

API Version

28.0–31.0

In version 32.0 and later, use searchFeedElements(communityId, q, sortParam).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItems(String communityId, String q, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItems(communityId, q, pageParam, pageSize)

Get a page of feed items that match the search criteria.

API Version

28.0–31.0

In version 32.0 and later, use searchFeedElements(communityId, q, pageParam, pageSize).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItems(String communityId, String q, String pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: String; The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItems(communityId, q, pageParam, pageSize, sortParam)

Get a page of sorted feed items that match the search criteria.

API Version

28.0–31.0

In version 32.0 and later, use searchFeedElements(communityId, q, pageParam, pageSize, sortParam).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItems(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItems(communityId, q, recentCommentCount, pageParam, pageSize, sortParam)

Get a page of sorted feed items that match the search criteria.

API Version

29.0–31.0

In version 32.0 and later, use searchFeedElements(communityId, q, recentCommentCount, pageParam, pageSize, sortParam).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItems(String communityId, String q, Integer recentCommentCount, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItemsInFeed(communityId, feedType, q)

Get the feed items from the Company, Home, and Moderation feeds that match the search criteria.

API Version

28.0–31.0

In version 32.0 and later, use searchFeedElementsInFeed(communityId, feedType, q).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String q)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItemsInFeed(communityId, feedType, pageParam, pageSize, sortParam, q)

Get a page of sorted feed items from the Company, Home, and Moderation feeds that match the search criteria.

API Version

28.0–31.0

In version 32.0 and later, use searchFeedElementsInFeed(communityId, feedType, pageParam, pageSize, sortParam, q).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItemsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q)

Get a page of sorted feed items from the Company, Home, and Moderation feeds that match the search criteria. Each feed item includes no more than the specified number of comments.

API Version

29.0–31.0

In version 32.0 and later, use searchFeedElementsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItemsInFeed(communityId, feedType, subjectId, q)

Get the feed items from a feed that match the search criteria.

API Version

28.0–31.0

In version 32.0 and later, use searchFeedElementsInFeed(communityId, feedType, subjectId, q).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String q)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.
subjectId: Type: String; If feedType is Record, subjectId can be any record ID, including a group ID. If feed type is UserProfile, subjectId can be any user ID. If feedType is any other value, subjectId must be the ID of the context user or the alias me.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItemsInFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, q)

Get a page of sorted feed items from a feed for a user or record that match the search criteria.

API Version

28.0–31.0

In version 32.0 and later, use searchFeedElementsInFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, q).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.

subjectId

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Order of feed items in the feed.

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Search term. Searches keywords in the user or group name. A minimum of one character is required. This parameter does not support wildcards. This parameter is required.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItemsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q)

Get a page of sorted feed items from a feed that match the search criteria. Each feed item includes no more than the specified number of comments.

API Version

29.0–31.0

In version 32.0 and later, use searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.

subjectId

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItemsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly)

Get a page of sorted feed items from a feed for a user or record that match the search criteria. Each feed item includes no more than the specified number of comments. Specify whether to return feed items posted by internal (non-community) users only.

API Version

30.0–31.0

In version 32.0 and later, use searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly).

Important

Available to Guest Users

31.0 only

Requires Chatter

Yes

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Value must be ConnectApi.FeedType.Record.

subjectId

Type: String

Any record ID, including a group ID.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItemsInFilterFeed(communityId, subjectId, keyPrefix, q)

Get the feed items that match the search criteria from a feed filtered by a key prefix for a user.

API Version

28.0–31.0

In version 32.0 and later, use searchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, q).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItemsInFilterFeed(String communityId, String subjectId, String keyPrefix, String q)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the context user or the alias me.
keyPrefix: Type: String; A key prefix that specifies record type. A key prefix is the first three characters in the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItemsInFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, q)

Get a page of sorted feed items that match the search criteria from a feed filtered by a key prefix for a user.

API Version

28.0–31.0

In version 32.0 and later, use searchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, q).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItemsInFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchFeedItemsInFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, q)

Get a page of sorted feed items that match the search criteria from a feed filtered by a key prefix for a user. Each feed item includes no more than the specified number of comments.

API Version

29.0–31.0

In version 32.0 and later, use searchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, q).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItemPage searchFeedItemsInFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Type: ConnectApi.FeedElementType

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

shareFeedElement(communityId, subjectId, feedElementType, originalFeedElementId)

Share the originalFeedElementId as the context user.

API Version

31.0–38.0

In version 39.0 and later, use postFeedElement(communityId, feedElement) or updateFeedElement(communityId, feedElementId, feedElement) with the ConnectApi.FeedEntityShareCapabilityInput to share a feed entity with a feed element.

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedElement shareFeedElement(String communityId, String subjectId, ConnectApi.FeedElementType feedElementType, String originalFeedElementId)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the user or group with whom to share the feed element.

feedElementType

Values are:

Bundle—A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values.
FeedItem—A feed item has a single parent and is scoped to one community or across all communities. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values.
Recommendation—A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user.

originalFeedElementId

Type: String

The ID of the feed element to share.

Return Value

Example

shareFeedItem(communityId, feedType, subjectId, originalFeedItemId)

Share the originalFeedItemId to the feed specified by the feedType.

API Version

28.0–31.0

In version 32.0–38.0, use shareFeedElement(communityId, subjectId, feedElementType, originalFeedElementId).
In version 39.0 and later, use postFeedElement(communityId, feedElement) or updateFeedElement(communityId, feedElementId, feedElement) with the ConnectApi.FeedEntityShareCapabilityInput.

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItem shareFeedItem(String communityId, ConnectApi.FeedType feedType, String subjectId, String originalFeedItemId)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

One of the following:

News
Record
UserProfile

To share a feed item with a group, use Record and use a group ID as the subjectId.

subjectId

Type: String

The value depends on the value of feedType:

News—subjectId must be the ID of the context user or the keyword me.
Record—subjectId can be a group ID or the ID of the context user (or me).
UserProfile—subjectId can be any user ID.

originalFeedItemId

Type: String

The ID of the feed item to share.

Return Value

Example

To share a feed item with a group, pass in the community ID (or null), the feed type Record, the group ID, and the ID of the feed item to share.

updateBookmark(communityId, feedItemId, isBookmarkedByCurrentUser)

Bookmark a feed item or remove a bookmark from a feed item.

API Version

28.0–31.0

In version 32.0 and later, use updateFeedElementBookmarks(communityId, feedElementId, bookmarks) or updateFeedElementBookmarks(communityId, feedElementId, isBookmarkedByCurrentUser).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedItem updateBookmark(String communityId, String feedItemId, Boolean isBookmarkedByCurrentUser)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; The ID for a feed item.
isBookmarkedByCurrentUser: Type: Boolean; —Specifying true adds the feed item to the list of bookmarks for the context user. Specify false to remove a bookmark.

Return Value

voteOnFeedPoll(communityId, feedItemId, myChoiceId)

Vote or change your vote on a feed poll.

API Version

28.0–31.0

In version 32.0 and later, use voteOnFeedElementPoll(communityId, feedElementId, myChoiceId).

Important

Requires Chatter

Yes

Signature

public static ConnectApi.FeedPoll voteOnFeedPoll(String communityId, String feedItemId, String myChoiceId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedItemId: Type: String; ID of the feed item that is associated with the poll.
myChoiceId: Type: String; ID of the item in the poll you’re voting for.

Return Value

Type: ConnectApi.FeedPoll

setTestGetFeedItemsFromFeed(communityId, feedType, result)

Register a ConnectApi.FeedItemPage object to be returned when getFeedItemsFromFeed is called with matching parameters in a test context. Use the get feed method with the same parameters or the code throws an exception.

API Version

28.0–31.0

Signature

public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, ConnectApi.FeedItemPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.
result: Type: ConnectApi.FeedItemPage; The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsFromFeed(communityId, feedType, pageParam, pageSize, sortParam, result)

API Version

28.0–31.0

Signature

public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, result)

API Version

29.0–31.0

Signature

public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsFromFeed(communityId, feedType, subjectId, result)

API Version

28.0–31.0

Signature

public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.FeedItemPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.
subjectId: Type: String; If feedType is Record, subjectId can be any record ID, including a group ID. If feedType is Streams, subjectId must be a stream ID. If feedType is Topics, subjectId must be a topic ID. If feedType is UserProfile, subjectId can be any user ID. If the feedType is any other value, subjectId must be the ID of the context user or the alias me.
result: Type: ConnectApi.FeedItemPage; The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsFromFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, result)

API Version

28.0–31.0

Signature

public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, result)

API Version

29.0–31.0

Signature

public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, showInternalOnly, result)

API Version

30.0–31.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix, result)

Register a ConnectApi.FeedItemPage object to be returned when the matching getFeedItemsFromFilterFeed method is called in a test context. Use the method with the same parameters or the code throws an exception.

API Version

28.0–31.0

Signature

public static Void setTestGetFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix, ConnectApi.FeedItemPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the context user or the alias me.
keyPrefix: Type: String; A key prefix that specifies record type. A key prefix is the first three characters in the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.
result: Type: ConnectApi.FeedItemPage; The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, result)

API Version

28.0–31.0

Signature

public static Void setTestGetFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, result)

API Version

29.0–31.0

Signature

public static Void setTestGetFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsFromFilterFeedUpdatedSince(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, updatedSince, result)

Register a ConnectApi.FeedItemPage object to be returned when the getFeedItemsFromFilterFeedUpdatedSince method is called in a test context.

API Version

30.0–31.0

Signature

public static Void setTestGetFeedItemsFromFilterFeedUpdatedSince(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String updatedSince, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

updatedSince

Type: String

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince, ConnectApi.FeedItemPage, results)

Register a ConnectApi.FeedItemPage object to be returned when getFeedItemsUpdatedSince is called with matching parameters in a test context. Use the method with the same parameters or the code throws an exception.

API Version

30.0–31.0

Signature

public static Void setTestGetFeedItemsUpdatedSince(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedItemPage results)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, result)

API Version

30.0–31.0

Signature

public static Void setTestGetFeedItemsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

One of these values:

Files
Groups
News
People
Record

subjectId

Type: String

If feedType is ConnectApi.Record, subjectId can be any record ID, including a group ID. Otherwise, it must be the context user or the alias me.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

result

The object containing test data.

Return Value

Type: Void

setTestGetFeedItemsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, showInternalOnly, result)

API Version

30.0–31.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

One of these values:

Files
Groups
News
People
Record

subjectId

Type: String

If feedType is ConnectApi.Record, subjectId can be any record ID, including a group ID. Otherwise, it must be the context user or the alias me.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

updatedSince

Type: String

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedItems(communityId, q, result)

API Version

28.0–31.0

Signature

public static Void searchFeedItems(String communityId, String q, ConnectApi.FeedItemPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
result: Type: ConnectApi.FeedItemPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedItems(communityId, q, sortParam, result)

Register a test feed item page to be returned when searchFeedItems(String, String, ConnectApi.FeedSortOrder) is called during a test.

API Version

28.0–31.0

Signature

public static Void setTestSearchFeedItems(String communityId, String q, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

result

The feed item test page.

Return Value

Type: Void

setTestSearchFeedItems(communityId, q, pageParam, pageSize, result)

Register a test feed item page to be returned when searchFeedItems(String, String, String, Integer) is called during a test.

API Version

28.0–31.0

Signature

public static Void setTestSearchFeedItems(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedItemPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: String; The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.
pageSize: Type: Integer; Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.
result: Type: ConnectApi.FeedItemPage; The test feed item page.

Return Value

Type: Void

setTestSearchFeedItems(communityId, q, pageParam, pageSize, sortParam, result)

Register a test feed item page to be returned when searchFeedItems(String, String, String, Integer, ConnectApi.FeedSortOrder) is called during a test.

API Version

28.0–31.0

Signature

public static Void setTestSearchFeedItems(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

result

The test feed item page.

Return Value

Type: Void

setTestSearchFeedItems(communityId, q, recentCommentCount, pageParam, pageSize, sortParam, result)

Register a test feed item page to be returned when searchFeedItems(communityId, q, recentCommentCount, pageParam, pageSize, sortParam) is called during a test.

API Version

29.0–31.0

Signature

public static Void setTestSearchFeedItems(String communityId, String q, Integer recentCommentCount, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

result

The test feed item page.

Return Value

Type: Void

setTestSearchFeedItemsInFeed(communityId, feedType, q, result)

Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFeed method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

28.0–31.0

Signature

public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String q, ConnectApi.FeedItemPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values are Company, DirectMessageModeration, DirectMessages, Home, Moderation, and PendingReview.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
result: Type: ConnectApi.FeedItemPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedItemsInFeed(communityId, feedType, pageParam, pageSize, sortParam, q, result)

API Version

28.0–31.0

Signature

public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedItemsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)

API Version

29.0–31.0

Signature

public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedItemsInFeed(communityId, feedType, subjectId, q, result)

API Version

28.0–31.0

Signature

public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String q, ConnectApi.FeedItemPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
feedType: Type: ConnectApi.FeedType; The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.
subjectId: Type: String; If feedType is Record, subjectId can be any record ID, including a group ID. If feedType is Streams, subjectId must be a stream ID. If feedType is Topics, subjectId must be a topic ID. If feedType is UserProfile, subjectId can be any user ID. If the feedType is any other value, subjectId must be the ID of the context user or the alias me.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
result: Type: ConnectApi.FeedItemPage; The object containing test data.

Return Value

Type: Void

setTestSearchFeedItemsInFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, q, result)

API Version

28.0–31.0

Signature

public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.

subjectId

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedItemsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)

API Version

29.0–31.0

Signature

public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.

subjectId

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedItemsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, result)

API Version

29.0–31.0

Signature

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessages, Filter, Landing, and Streams.

subjectId

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

showInternalOnly

Type: Boolean

Specifies whether to show only feed items from internal (non-community) users (true), or not (false). The default value is false.

result

The object containing test data.

Return Value

Type: Void

setTestSearchFeedItemsInFilterFeed(communityId, subjectId, keyPrefix, q, result)

Register a ConnectApi.FeedItemPage object to be returned when the matching ConnectApi.searchFeedItemsInFilterFeed method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

28.0–31.0

Signature

public static Void setTestSearchFeedItemsInFilterFeed(String communityId, String subjectId, String keyPrefix, String q, ConnectApi.FeedItemPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
subjectId: Type: String; The ID of the context user or the alias me.
keyPrefix: Type: String; A key prefix that specifies record type. A key prefix is the first three characters in the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
result: Type: ConnectApi.FeedItemPage; Specify the test feed item page.

Return Value

Type: Void

setTestSearchFeedItemsInFilterFeed(communityId, feedType, subjectId, keyPrefix, pageParam, pageSize, sortParam, q, result)

API Version

28.0–31.0

Signature

public static Void setTestSearchFeedItemsInFilterFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result

Specify the test feed item page.

Return Value

Type: Void

setTestSearchFeedItemsInFilterFeed(communityId, feedType, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)

API Version

29.0–31.0

Signature

public static Void setTestSearchFeedItemsInFilterFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

feedType

Type: ConnectApi.FeedType

The type of feed. Valid values include every ConnectApi.FeedType except Company, DirectMessageModeration, DirectMessages, Filter, Home, Landing, Moderation, and PendingReview.

subjectId

Type: String

The ID of the context user or the alias me.

keyPrefix

Type: String

recentCommentCount

Type: Integer

The maximum number of comments to return with each feed item. The default value is 3.

density

Specify the amount of content in a feed.

AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

pageParam

Type: String

The page token to use to view the page. Page tokens are returned as part of the response class, for example, currentPageToken or nextPageToken. If you pass in null, the first page is returned.

pageSize

Type: Integer

Specifies the number of feed items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

sortParam

Values are:

CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Moderation, and PendingReview feeds.
CreatedDateDesc—Sorts by most recent creation date.
LastModifiedDateDesc—Sorts by most recent activity.
MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.

Sorts the returned feed by the most recently created feed item, or by the most recently modified feed item. If you pass in null, the default value CreatedDateDesc is used.

q

Type: String

Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

result