Force.com Apex コード開発者ガイド
jTopics クラス
名前空間
Topics メソッド
Topics のメソッドは次のとおりです。すべてのメソッドが静的です。
assignTopic(communityId, recordId, topicId)
API バージョン
29.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.Topic assignTopic(String communityId, String recordId, String topicId)
パラメータ
戻り値
assignTopicByName(communityId, recordId, topicName)
API バージョン
29.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.Topic assignTopicByName(String communityId, String recordId, String topicName)
パラメータ
戻り値
deleteTopic(communityId, topicId)
API バージョン
29.0
Chatter が必要かどうか
いいえ
署名
public static Void deleteTopic(String communityId, String topicId)
戻り値
型: Void
使用方法
トピックの削除は非同期です。削除の完了前にトピックを要求した場合、応答は 200: Successful になり、バージョン 33.0 以降では ConnectApi.Topic の isBeingDeleted プロパティが true になります。削除の完了後にトピックを要求した場合、応答は 404: NOT_FOUND になります。
getGroupsRecentlyTalkingAboutTopic(communityId, topicId)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterGroupSummaryPage getGroupsRecentlyTalkingAboutTopic(String communityId, String topicId)
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getRecentlyTalkingAboutTopicsForGroup(communityId, groupId)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.TopicPage getRecentlyTalkingAboutTopicsForGroup(String communityId, String groupId)
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getRecentlyTalkingAboutTopicsForUser(communityId, userId)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.TopicPage getRecentlyTalkingAboutTopicsForUser(String communityId, String userId)
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getRelatedTopics(communityId, topicId)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getRelatedTopics(String communityId, String topicId)
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getTopic(communityId, topicId)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.Topic getTopic(String communityId, String topicId)
戻り値
getTopics(communityId, recordId)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTopics(String communityId, String recordId)
パラメータ
戻り値
getTopics(communityId)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTopics(String communityId)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
戻り値
getTopics(communityId, sortParam)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTopics(String communityId, ConnectApi.TopicSort sortParam)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- sortParam
- 型: ConnectApi.TopicSort
- 値は次のとおりです。
- popularDesc: トピックを人気順に並び替えます。この値がデフォルトです。
- alphaAsc: トピックをアルファベット順に並び替えます。
戻り値
getTopics(communityId, pageParam, pageSize)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTopics(String communityId, Integer pageParam, Integer pageSize)
パラメータ
戻り値
getTopics(communityId, pageParam, pageSize, sortParam)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTopics(String communityId, Integer pageParam, Integer pageSize, ConnectApi.TopicSort sortParam)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- pageParam
- 型: Integer
- 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.TopicSort
- 値は次のとおりです。
- popularDesc: トピックを人気順に並び替えます。この値がデフォルトです。
- alphaAsc: トピックをアルファベット順に並び替えます。
戻り値
getTopics(communityId, q, sortParam)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTopics(String communityId, String q, ConnectApi.TopicSort sortParam)
パラメータ
戻り値
getTopics(communityId, q, pageParam, pageSize)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTopics(String communityId, String q, Integer pageParam, Integer pageSize)
パラメータ
戻り値
getTopics(communityId, q, pageParam, pageSize, sortParam)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTopics(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.TopicSort sortParam)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- q
- 型: String
- 検索する文字列を指定します。文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。
- pageParam
- 型: Integer
- 返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.TopicSort
- 値は次のとおりです。
- popularDesc: トピックを人気順に並び替えます。この値がデフォルトです。
- alphaAsc: トピックをアルファベット順に並び替えます。
戻り値
getTopics(communityId, q, exactMatch)
API バージョン
33.0
ゲストユーザが使用可能
33.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTopics(String communityId, String q, Boolean exactMatch)
パラメータ
戻り値
getTopicSuggestions(communityId, recordId, maxResults)
API バージョン
29.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicSuggestionPage getTopicSuggestions(String communityId, String recordId, Integer maxResults)
パラメータ
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getTopicSuggestions(communityId, recordId)
API バージョン
29.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicSuggestionPage getTopicSuggestions(String communityId, String recordId)
パラメータ
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getTopicSuggestionsForText(communityId, text, maxResults)
API バージョン
29.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicSuggestionPage getTopicSuggestionsForText(String communityId, String text, Integer maxResults)
パラメータ
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getTopicSuggestionsForText(communityId, text)
API バージョン
29.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicSuggestionPage getTopicSuggestionsForText(String communityId, String text)
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getTrendingTopics(communityId)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTrendingTopics(String communityId)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getTrendingTopics(communityId, maxResults)
API バージョン
29.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.TopicPage getTrendingTopics(String communityId, Integer maxResults)
パラメータ
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
mergeTopics(communityId, topicId, idsToMerge)
API バージョン
33.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.Topic mergeTopics(String communityId, String topicId, List<String> idsToMerge)
パラメータ
戻り値
使用方法
unassignTopic(communityId, recordId, topicId)
API バージョン
29.0
Chatter が必要かどうか
いいえ
署名
public static Void unassignTopic(String communityId, String recordId, String topicId)
パラメータ
戻り値
型: Void
updateTopic(communityId, topicId, topic)
API バージョン
29.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.Topic updateTopic(String communityId, String topicId, ConnectApi.TopicInput topic)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- topicId
- 型: String
- トピックの ID。
- topic
- 型: ConnectApi.TopicInput
- トピックの名前と説明、またはトピックにマージする最大 5 個のカンマ区切りのトピック ID が含まれる ConnectApi.TopicInput オブジェクト。
戻り値
使用方法
Topics テストメソッド
Topics のテストメソッドを次に示します。すべてのメソッドが静的です。
これらのメソッドを使用して ConnectApi コードをテストする方法の詳細は、「ConnectApi コードのテスト」を参照してください。
setTestGetGroupsRecentlyTalkingAboutTopic(communityId, topicId, result)
API バージョン
29.0
署名
public static Void setTestGetGroupsRecentlyTalkingAboutTopic(String communityId, String topicId, ConnectApi.ChatterGroupSummaryPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- topicId
- 型: String
- トピックの ID。
- result
- 型: ConnectApi.ChatterGroupSummaryPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetRecentlyTalkingAboutTopicsForGroup(communityId, groupId, result)
API バージョン
29.0
署名
public static Void setTestGetRecentlyTalkingAboutTopicsForGroup(String communityId, String groupId, ConnectApi.TopicPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- groupId
- 型: String
- グループの ID。
- result
- 型: ConnectApi.TopicPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetRecentlyTalkingAboutTopicsForUser(communityId, userId, result)
API バージョン
29.0
署名
public static Void setTestGetRecentlyTalkingAboutTopicsForUser(String communityId, String userId, ConnectApi.TopicPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- userId
- 型: String
- ユーザの ID。
- result
- 型: ConnectApi.TopicPage
- テストトピックページを指定します。
戻り値
型: Void
setTestGetRelatedTopics(communityId, topicId, result)
API バージョン
29.0
署名
public static Void setTestGetRelatedTopics(String communityId, String topicId, ConnectApi.TopicPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- topicId
- 型: String
- トピックの ID。
- result
- 型: ConnectApi.TopicPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetTopicSuggestions(communityId, recordId, maxResults, result)
API バージョン
29.0
署名
public static Void setTestGetTopicSuggestions(String communityId, String recordId, Integer maxResults, ConnectApi.TopicSuggestionPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- recordId
- 型: String
- レコードまたはフィード項目の ID。
- maxResults
- 型: Integer
- 返される推奨トピックの最大数。デフォルト値は 5 です。値は 1 以上 25 以下で指定する必要があります。
- result
- 型: ConnectApi.TopicSuggestionPage
- テストトピックの提案ページを指定します。
戻り値
型: Void
setTestGetTopicSuggestions(communityId, recordId, result)
API バージョン
29.0
署名
public static Void setTestGetTopicSuggestions(String communityId, String recordId, ConnectApi.TopicSuggestionPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- recordId
- 型: String
- レコードまたはフィード項目の ID。
- result
- 型: ConnectApi.TopicSuggestionPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetTopicSuggestionsForText(communityId, text, maxResults, result)
API バージョン
29.0
署名
public static Void setTestGetTopicSuggestionsForText(String communityId, String text, Integer maxResults, ConnectApi.TopicSuggestionPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- text
- 型: String
- テキスト文字列。
- maxResults
- 型: Integer
- 返される推奨トピックの最大数。デフォルト値は 5 です。値は 1 以上 25 以下で指定する必要があります。
- result
- 型: ConnectApi.TopicSuggestionPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetTopicSuggestionsForText(communityId, text, result)
API バージョン
29.0
署名
public static Void setTestGetTopicSuggestionsForText(String communityId, String text, ConnectApi.TopicSuggestionPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- text
- 型: String
- テキスト文字列。
- result
- 型: ConnectApi.TopicSuggestionPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetTrendingTopics(communityId, result)
API バージョン
29.0
署名
public static Void setTestGetTrendingTopics(String communityId, ConnectApi.TopicPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- result
- 型: ConnectApi.TopicPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetTrendingTopics(communityId, maxResults, result)
API バージョン
29.0
署名
public static Void setTestGetTrendingTopics(String communityId, Integer maxResults, ConnectApi.TopicPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- maxResults
- 型: Integer
- 返される推奨トピックの最大数。デフォルト値は 5 です。値は 1 以上 25 以下で指定する必要があります。
- result
- 型: ConnectApi.TopicPage
- テストデータを含むオブジェクト。
戻り値
型: Void