Apex Reference Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, 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.
Mentions Class
Namespace
Mentions Methods
All methods in this class require Chatter and are subject to the per user, per namespace, per hour rate limit.
getMentionCompletions(communityId, q, contextId)
API Version
29.0
Requires Chatter
Yes
Signature
public static ConnectApi.MentionCompletionPage getMentionCompletions (String communityId, String q, String contextId)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- q
- Type: String
- A search term for matching user and group names. Searching for a group requires a minimum of 2 characters. Searching for a user doesn’t require a minimum number of characters. This parameter does not support wildcards.
- contextId
- Type: String
- A feed item ID (for a mention in a comment) or a feed subject ID (for a mention in a feed item) that narrows search results, with more useful results listed first. Use a group ID for groups that allow customers to ensure mention completion results include customers.
Return Value
Usage
Call this method to generate a page of proposed mentions that a user can choose from when they enter characters after @ in a feed item body or a comment body.
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.
getMentionCompletions(communityId, q, contextId, type, pageParam, pageSize)
API Version
29.0
Requires Chatter
Yes
Signature
public static ConnectApi.Mentions getMentionCompletions (String communityId, String q, String contextId, ConnectApi.MentionCompletionType type, Integer pageParam, Integer pageSize)
Parameters
communityId
Type: String
ID for an Experience Cloud site, internal, or null.
q
Type: String
A search term for matching user and group names. Searching for a group requires a minimum of 2 characters. Searching for a user doesn’t require a minimum number of characters. This parameter does not support wildcards.
contextId
Type: String
A feed item ID (for a mention in a comment) or a feed subject ID (for a mention in a feed item) that narrows search results, with more useful results listed first. Use a group ID for groups that allow customers to ensure mention completion results include customers.
type
Type: ConnectApi.MentionCompletionType
Type of mention completion.
- All—All mention completions, regardless of the type of record to which the mention refers.
- Group—Mention completions for groups.
- User—Mention completions for users.
pageParam
Type: Integer
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
Usage
Call this method to generate a page of proposed mentions that a user can choose from when they enter characters after @ in a feed item body or a comment body.
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.
getMentionValidations(communityId, parentId, recordIds, visibility)
API Version
29.0
Requires Chatter
Yes
Signature
public static ConnectApi.Mentions getMentionValidations(String communityId, String parentId, List<String> recordIds, ConnectApi.FeedItemVisibilityType visibility)
Parameters
communityId
Type: String
ID for an Experience Cloud site, internal, or null.
parentId
Type: String
The feed item parent ID.
recordIds
Type: List<String>
A comma-separated list of IDs to be mentioned. The maximum value is 25.
visibility
Type: ConnectApi.FeedItemVisibilityType
Type of users who can see a feed item.
- AllUsers—Visibility is not limited to internal users.
- InternalUsers—Visibility is limited to internal users.
Return Value
Usage
Call this method to check whether the record IDs returned from a call to ConnectApi.Mentions.getMentionCompletions are valid for the context user. For example, the context users can’t mention private groups they don’t belong to. If such a group were included in the list of mention validations, the ConnectApi.MentionValidations.hasErrors property would be true and the group would have a ConnectApi.MentionValidation.valdiationStatus of Disallowed.
Mentions Test Methods
For information about using these methods to test your ConnectApi code, see Testing ConnectApi Code.
setTestGetMentionCompletions(communityId, q, contextId, result)
API Version
29.0
Signature
public static Void setTestGetMentionCompletions (String communityId, String q, String contextId, ConnectApi.MentionCompletionPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- q
- Type: String
- A search term for matching user and group names. Searching for a group requires a minimum of 2 characters. Searching for a user doesn’t require a minimum number of characters. This parameter does not support wildcards.
- contextId
- Type: String
- A feed item ID (for a mention in a comment) or a feed subject ID (for a mention in a feed item) that narrows search results, with more useful results listed first. Use a group ID for groups that allow customers to ensure mention completion results include customers.
- result
- Type: ConnectApi.MentionCompletionPage
- A ConnectApi.MentionCompletionPage object containing test data.
Return Value
Type: Void
setTestGetMentionCompletions(communityId, q, contextId, type, pageParam, pageSize, result)
API Version
29.0
Signature
public static Void setTestGetMentionCompletions (String communityId, String q, String contextId, ConnectApi.MentionCompletionType type, Integer pageParam, Integer pageSize, ConnectApi.MentionCompletionPage result)
Parameters
communityId
Type: String
ID for an Experience Cloud site, internal, or null.
q
Type: String
A search term for matching user and group names. Searching for a group requires a minimum of 2 characters. Searching for a user doesn’t require a minimum number of characters. This parameter does not support wildcards.
contextId
Type: String
A feed item ID (for a mention in a comment) or a feed subject ID (for a mention in a feed item) that narrows search results, with more useful results listed first. Use a group ID for groups that allow customers to ensure mention completion results include customers.
type
Type: ConnectApi.MentionCompletionType
Type of mention completion.
- All—All mention completions, regardless of the type of record to which the mention refers.
- Group—Mention completions for groups.
- User—Mention completions for users.
pageParam
Type: Integer
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.
result
Type: ConnectApi.MentionCompletionPage
A ConnectApi.MentionCompletionPage object containing test data.
Return Value
Type: Void