Topics Class
Namespace
Topics Methods
- getGroupsRecentlyTalkingAboutTopic(communityId, topicId)
- getRecentlyTalkingAboutTopicsForGroup(communityId, groupId)
- getRecentlyTalkingAboutTopicsForUser(communityId, userId)
assignTopic(communityId, recordId, topicId)
API Version
29.0
Requires Chatter
No
Signature
public static ConnectApi.Topic assignTopic(String communityId, String recordId, String topicId)
Parameters
Return Value
Type: ConnectApi.Topic
Usage
assignTopicByName(communityId, recordId, topicName)
API Version
29.0
Requires Chatter
No
Signature
public static ConnectApi.Topic assignTopicByName(String communityId, String recordId, String topicName)
Parameters
Return Value
Type: ConnectApi.Topic
Usage
createTopic(communityId, name, description)
API Version
36.0
Requires Chatter
No
Signature
public static ConnectApi.Topic createTopic(String communityId, String name, String description)
Parameters
Return Value
Type: ConnectApi.Topic
Usage
createTopicDataCategoryRules(communityId, dataCategoryGroup, dataCategory, topicNames)
API Version
40.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage createTopicDataCategoryRules(String communityId, String dataCategoryGroup, String dataCategory, ConnectApi.TopicNamesInput topicNames)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- dataCategoryGroup
- Type: String
- The data category group used by articles.
- dataCategory
- Type: String
- The data category used by articles.
- topicNames
- Type: ConnectApi.TopicNamesInput
- A ConnectApi.TopicNamesInput object with the names of topics to assign to articles in a data category.
Return Value
Type: ConnectApi.TopicPage
deleteTopic(communityId, topicId)
API Version
29.0
Requires Chatter
No
Signature
public static Void deleteTopic(String communityId, String topicId)
Parameters
Return Value
Type: Void
Usage
Topic deletion is asynchronous. If a topic is requested before the deletion completes, the response is successful and the isBeingDeleted property of ConnectApi.Topic is true in version 33.0 and later. If a topic is requested after the deletion completes, the response is ConnectApi.NotFoundException.
getGroupsRecentlyTalkingAboutTopic(communityId, topicId)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
Yes
Signature
public static ConnectApi.ChatterGroupSummaryPage getGroupsRecentlyTalkingAboutTopic(String communityId, String topicId)
Parameters
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.
getRecentlyTalkingAboutTopicsForGroup(communityId, groupId)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
Yes
Signature
public static ConnectApi.TopicPage getRecentlyTalkingAboutTopicsForGroup(String communityId, String groupId)
Parameters
Return Value
Type: ConnectApi.TopicPage
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.
getRecentlyTalkingAboutTopicsForUser(communityId, userId)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
Yes
Signature
public static ConnectApi.TopicPage getRecentlyTalkingAboutTopicsForUser(String communityId, String userId)
Parameters
Return Value
Type: ConnectApi.TopicPage
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.
getRelatedTopics(communityId, topicId)
Two topics that are assigned to the same feed item at least three times are related.
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getRelatedTopics(String communityId, String topicId)
Parameters
Return Value
Type: ConnectApi.TopicPage
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.
getTopic(communityId, topicId)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.Topic getTopic(String communityId, String topicId)
Parameters
Return Value
Type: ConnectApi.Topic
getTopicDataCategoryRules(communityId, dataCategoryGroup, dataCategory)
API Version
40.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopicDataCategoryRules(String communityId, String dataCategoryGroup, String dataCategory)
Parameters
Return Value
Type: ConnectApi.TopicPage
getTopics(communityId, recordId)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopics(String communityId, String recordId)
Parameters
Return Value
Type: ConnectApi.TopicPage
Usage
getTopics(communityId)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopics(String communityId)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
Return Value
Type: ConnectApi.TopicPage
getTopics(communityId, sortParam)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopics(String communityId, ConnectApi.TopicSort sortParam)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- sortParam
- Type: ConnectApi.TopicSort
- Values are:
- popularDesc—Sorts topics by popularity with the most popular first. This value is the default.
- alphaAsc—Sorts topics alphabetically.
Return Value
Type: ConnectApi.TopicPage
getTopics(communityId, pageParam, pageSize)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopics(String communityId, Integer pageParam, Integer pageSize)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- 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
Type: ConnectApi.TopicPage
getTopics(communityId, pageParam, pageSize, sortParam)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopics(String communityId, Integer pageParam, Integer pageSize, ConnectApi.TopicSort sortParam)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- 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.
- sortParam
- Type: ConnectApi.TopicSort
- Values are:
- popularDesc—Sorts topics by popularity with the most popular first. This value is the default.
- alphaAsc—Sorts topics alphabetically.
Return Value
Type: ConnectApi.TopicPage
getTopics(communityId, q, sortParam)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopics(String communityId, String q, ConnectApi.TopicSort sortParam)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- q
- Type: String
- Specifies the string to search. The string must contain at least two characters, not including wildcards.
- sortParam
- Type: ConnectApi.TopicSort
- Values are:
- popularDesc—Sorts topics by popularity with the most popular first. This value is the default.
- alphaAsc—Sorts topics alphabetically.
Return Value
Type: ConnectApi.TopicPage
getTopics(communityId, q, pageParam, pageSize)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopics(String communityId, String q, Integer pageParam, Integer pageSize)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- q
- Type: String
- Specifies the string to search. The string must contain at least two characters, not including wildcards.
- 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
Type: ConnectApi.TopicPage
getTopics(communityId, q, pageParam, pageSize, sortParam)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopics(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.TopicSort sortParam)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- q
- Type: String
- Specifies the string to search. The string must contain at least two characters, not including wildcards.
- 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.
- sortParam
- Type: ConnectApi.TopicSort
- Values are:
- popularDesc—Sorts topics by popularity with the most popular first. This value is the default.
- alphaAsc—Sorts topics alphabetically.
Return Value
Type: ConnectApi.TopicPage
getTopics(communityId, q, exactMatch)
API Version
33.0
Available to Guest Users
33.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopics(String communityId, String q, Boolean exactMatch)
Parameters
Return Value
Type: ConnectApi.TopicPage
getTopicsOrFallBackToRenamedTopics(communityId, q, exactMatch, fallBackToRenamedTopics)
API Version
35.0
Available to Guest Users
35.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTopicsOrFallBackToRenamedTopics(String communityId, String q, Boolean exactMatch, Boolean fallBackToRenamedTopics)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- q
- Type: String
- Specifies the string to search. The string must contain at least two characters, not including wildcards.
- exactMatch
- Type: Boolean
- Specify true to find a topic by its exact, case-insensitive name or to find the most recent renamed topic match if there isn’t an exact match.
- fallBackToRenamedTopics
- Type: Boolean
- Specify true and if there isn’t an exact match, the most recent renamed topic match is returned. If there are multiple renamed topic matches, only the most recent is returned. If there are no renamed topic matches, an empty collection is returned.
Return Value
Type: ConnectApi.TopicPage
getTopicSuggestions(communityId, recordId, maxResults)
API Version
29.0
Requires Chatter
No
Signature
public static ConnectApi.TopicSuggestionPage getTopicSuggestions(String communityId, String recordId, Integer maxResults)
Parameters
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.
getTopicSuggestions(communityId, recordId)
API Version
29.0
Requires Chatter
No
Signature
public static ConnectApi.TopicSuggestionPage getTopicSuggestions(String communityId, String recordId)
Parameters
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.
getTopicSuggestionsForText(communityId, text, maxResults)
API Version
29.0
Requires Chatter
No
Signature
public static ConnectApi.TopicSuggestionPage getTopicSuggestionsForText(String communityId, String text, Integer maxResults)
Parameters
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.
getTopicSuggestionsForText(communityId, text)
API Version
29.0
Requires Chatter
No
Signature
public static ConnectApi.TopicSuggestionPage getTopicSuggestionsForText(String communityId, String text)
Parameters
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.
getTrendingTopics(communityId)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTrendingTopics(String communityId)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
Return Value
Type: ConnectApi.TopicPage
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.
getTrendingTopics(communityId, maxResults)
API Version
29.0
Available to Guest Users
32.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage getTrendingTopics(String communityId, Integer maxResults)
Parameters
Return Value
Type: ConnectApi.TopicPage
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.
mergeTopics(communityId, topicId, idsToMerge)
API Version
33.0
Requires Chatter
No
Signature
public static ConnectApi.Topic mergeTopics(String communityId, String topicId, List<String> idsToMerge)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- topicId
- Type: String
- The ID for the primary topic for the merge. If this topic is a managed topic, it retains its topic type, topic images, and children topics.
- idsToMerge
- Type: List<String>
- A list of up to five comma-separated secondary topic IDs to merge with the primary topic. If any of the secondary topics are navigational or featured topics, they lose their topic type, topic images, and children topics. Their feed items are reassigned to the primary topic. If you merge a topic with a content topic, the content associations are preserved. If you merge a topic with an inactive endorsee, the endorsement isn’t mapped to the primary topic.
Return Value
Type: ConnectApi.Topic
Usage
reassignTopicDataCategoryRules(communityId, dataCategoryGroup, dataCategory, topicNames)
API Version
40.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage reassignTopicDataCategoryRules(String communityId, String dataCategoryGroup, String dataCategory, ConnectApi.TopicNamesInput topicNames)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- dataCategoryGroup
- Type: String
- The data category group used by articles.
- dataCategory
- Type: String
- The data category used by articles.
- topicNames
- Type: ConnectApi.TopicNamesInput
- A ConnectApi.TopicNamesInput object with the names of topics to reassign to articles in a data category.
Return Value
Type: ConnectApi.TopicPage
reassignTopicsByName(communityId, recordId, topicNames)
API Version
35.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage reassignTopicsByName(String communityId, String recordId, ConnectApi.TopicNamesInput topicNames)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- recordId
- Type: String
- The ID of the record or feed item to which to assign the topic.
- topicNames
- Type: ConnectApi.TopicNamesInput
- A list of topics to replace the currently assigned topics. Optionally, a list of suggested topics to assign to improve future topic suggestions.
Return Value
Type: ConnectApi.TopicPage
Usage
unassignTopic(communityId, recordId, topicId)
API Version
29.0
Requires Chatter
No
Signature
public static Void unassignTopic(String communityId, String recordId, String topicId)
Parameters
Return Value
Type: Void
Usage
updateTopic(communityId, topicId, topic)
API Version
29.0
Requires Chatter
No
Signature
public static ConnectApi.Topic updateTopic(String communityId, String topicId, ConnectApi.TopicInput topic)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- topicId
- Type: String
- ID for a topic.
- topic
- Type: ConnectApi.TopicInput
- A ConnectApi.TopicInput object containing the name and description of the topic or up to five comma-separated secondary topic IDs to merge with the primary topic.
Return Value
Type: ConnectApi.Topic
Usage
updateTopicsForArticlesInDataCategory(communityId, dataCategoryGroup, dataCategory, articleTopicAssignmentJob)
API Version
40.0
Requires Chatter
No
Signature
public static ConnectApi.TopicPage updateTopicsForArticlesInDataCategory(String communityId, String dataCategoryGroup, String dataCategory, ConnectApi.ArticleTopicAssignmentJobInput articleTopicAssignmentJob)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- dataCategoryGroup
- Type: String
- The data category group used by articles.
- dataCategory
- Type: String
- The data category used by articles.
- articleTopicAssignmentJob
- Type: ConnectApi.ArticleTopicAssignmentJobInput
- A ConnectApi.ArticleTopicAssignmentJobInput object that indicates the operation to take on which topics.
Return Value
Type: ConnectApi.TopicPage
Topics Test Methods
For information about using these methods to test your ConnectApi code, see Testing ConnectApi Code.
setTestGetGroupsRecentlyTalkingAboutTopic(communityId, topicId, result)
API Version
29.0
Signature
public static Void setTestGetGroupsRecentlyTalkingAboutTopic(String communityId, String topicId, ConnectApi.ChatterGroupSummaryPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- topicId
- Type: String
- ID for a topic.
- result
- Type: ConnectApi.ChatterGroupSummaryPage
- Object containing test data.
Return Value
Type: Void
setTestGetRecentlyTalkingAboutTopicsForGroup(communityId, groupId, result)
API Version
29.0
Signature
public static Void setTestGetRecentlyTalkingAboutTopicsForGroup(String communityId, String groupId, ConnectApi.TopicPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- groupId
- Type: String
- ID for a group.
- result
- Type: ConnectApi.TopicPage
- Object containing test data.
Return Value
Type: Void
setTestGetRecentlyTalkingAboutTopicsForUser(communityId, userId, result)
API Version
29.0
Signature
public static Void setTestGetRecentlyTalkingAboutTopicsForUser(String communityId, String userId, ConnectApi.TopicPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- userId
- Type: String
- ID for a user.
- result
- Type: ConnectApi.TopicPage
- Specify the test topics page.
Return Value
Type: Void
setTestGetRelatedTopics(communityId, topicId, result)
API Version
29.0
Signature
public static Void setTestGetRelatedTopics(String communityId, String topicId, ConnectApi.TopicPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- topicId
- Type: String
- ID for a topic.
- result
- Type: ConnectApi.TopicPage
- Object containing test data.
Return Value
Type: Void
setTestGetTopicSuggestions(communityId, recordId, maxResults, result)
API Version
29.0
Signature
public static Void setTestGetTopicSuggestions(String communityId, String recordId, Integer maxResults, ConnectApi.TopicSuggestionPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- recordId
- Type: String
- ID for a record or feed item.
- maxResults
- Type: Integer
- Maximum number of topic suggestions that get returned. The default is 5. Value must be greater than 0 and less than or equal to 25.
- result
- Type: ConnectApi.TopicSuggestionPage
- Specify the test topic suggestions page.
Return Value
Type: Void
setTestGetTopicSuggestions(communityId, recordId, result)
API Version
29.0
Signature
public static Void setTestGetTopicSuggestions(String communityId, String recordId, ConnectApi.TopicSuggestionPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- recordId
- Type: String
- ID for a record or feed item.
- result
- Type: ConnectApi.TopicSuggestionPage
- Object containing test data.
Return Value
Type: Void
setTestGetTopicSuggestionsForText(communityId, text, maxResults, result)
API Version
29.0
Signature
public static Void setTestGetTopicSuggestionsForText(String communityId, String text, Integer maxResults, ConnectApi.TopicSuggestionPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- text
- Type: String
- String of text.
- maxResults
- Type: Integer
- Maximum number of topic suggestions that get returned. The default is 5. Value must be greater than 0 and less than or equal to 25.
- result
- Type: ConnectApi.TopicSuggestionPage
- Object containing test data.
Return Value
Type: Void
setTestGetTopicSuggestionsForText(communityId, text, result)
API Version
29.0
Signature
public static Void setTestGetTopicSuggestionsForText(String communityId, String text, ConnectApi.TopicSuggestionPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- text
- Type: String
- String of text.
- result
- Type: ConnectApi.TopicSuggestionPage
- Object containing test data.
Return Value
Type: Void
setTestGetTrendingTopics(communityId, result)
API Version
29.0
Signature
public static Void setTestGetTrendingTopics(String communityId, ConnectApi.TopicPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- result
- Type: ConnectApi.TopicPage
- Object containing test data.
Return Value
Type: Void
setTestGetTrendingTopics(communityId, maxResults, result)
API Version
29.0
Signature
public static Void setTestGetTrendingTopics(String communityId, Integer maxResults, ConnectApi.TopicPage result)
Parameters
- communityId
- Type: String
- ID for an Experience Cloud site, internal, or null.
- maxResults
- Type: Integer
- Maximum number of topic suggestions that get returned. The default is 5. Value must be greater than 0 and less than or equal to 25.
- result
- Type: ConnectApi.TopicPage
- Object containing test data.
Return Value
Type: Void