Newer Version Available
QuestionAndAnswers Class
Namespace
QuestionAndAnswers Methods
All methods in this class require Chatter and are subject to the per user, per namespace, per hour rate limit.
getSuggestions(communityId, q, subjectId, includeArticles, maxResults)
API Version
32.0
Requires Chatter
Yes
Signature
public static ConnectApi.QuestionAndAnswersSuggestions getSuggestions(String communityId, String q, String subjectId, Boolean includeArticles, Integer maxResults)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- q
- Type: String
- Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
- subjectId
- Type: String
- Specify a subject ID to search only questions on that object. If the ID is a topic or a user, the ID is ignored.
- includeArticles
- Type: Boolean
- Specify true to include knowledge articles in the search results. To return only questions, specify false.
- maxResults
- Type: Integer
- The maximum number of results to return for each type of item. Possible values are 1–10. The default value 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.
setTestGetSuggestions(communityId, q, subjectId, includeArticles, maxResults, result)
API Version
32.0
Signature
public static Void setTestGetSuggestions(String communityId, String q, String subjectId, Boolean includeArticles, Integer maxResults, ConnectApi.QuestionAndAnswersSuggestions result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- q
- Type: String
- Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
- subjectId
- Type: String
- Specify a subject ID to search only questions on that object. If the ID is a topic or a user, the ID is ignored.
- includeArticles
- Type: Boolean
- Specify true to include knowledge articles in the search results. To return only questions, specify false.
- maxResults
- Type: Integer
- The maximum number of results to return for each type of item. Possible values are 1–10. The default value is 5.
- result
- Type: ConnectApi.QuestionAndAnswersSuggestions
- Object containing test data.
Return Value
Type: Void
updateQuestionAndAnswers(communityId, feedElementId, questionAndAnswersCapability)
API Version
32.0
Requires Chatter
Yes
Signature
public static ConnectApi.QuestionAndAnswersCapability updateQuestionAndAnswers(String communityId, String feedElementId, ConnectApi.QuestionAndAnswersCapabilityInput questionAndAnswersCapability)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- feedElementId
- Type: String
- ID of the feed element.
- questionAndAnswersCapability
- Type: ConnectApi.QuestionAndAnswersCapabilityInput
- Specify the best answer (comment ID) for the question.
Return Value
Type: ConnectApi.QuestionAndAnswersCapability
If the feed element doesn’t support this capability, the return value is ConnectApi.NotFoundException.
Example
1ConnectApi.QuestionAndAnswersCapabilityInput qaInput = new ConnectApi.QuestionAndAnswersCapabilityInput();
2qaInput.bestAnswerId = '0D7D00000000lMAKAY';
3
4ConnectApi.QuestionAndAnswersCapability qa = ConnectApi.QuestionAndAnswers.updateQuestionAndAnswers(null, '0D5D0000000XZjJ', qaInput);