Topics クラス

API バージョン

29.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Topic assignTopic(String communityId, String recordId, String topicId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

recordId

型: String

レコードまたはフィード項目の ID。

topicId

型: String

トピックの ID。

戻り値

型: ConnectApi.​Topic

API バージョン

29.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Topic assignTopicByName(String communityId, String recordId, String topicName)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

recordId

型: String

トピックが割り当てられるレコードまたはフィード項目の ID。

topicName

型: String

新規または既存のトピックの名前。

戻り値

型: ConnectApi.​Topic

API バージョン

36.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Topic createTopic(String communityId, String name, String description)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

name

型: String

トピックの名前。

description

型: String

トピックの説明。

戻り値

型: ConnectApi.​Topic

API バージョン

29.0

Chatter が必要かどうか

いいえ

署名

public static Void deleteTopic(String communityId, String topicId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

topicId

型: String

トピックの ID。

戻り値

型: Void

使用方法

トピックの削除は非同期です。削除の完了前にトピックを要求した場合、応答は 200: Successful になり、バージョン 33.0 以降では ConnectApi.Topic の isBeingDeleted プロパティが true になります。削除の完了後にトピックを要求した場合、応答は 404: NOT_FOUND になります。

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.ChatterGroupSummaryPage getGroupsRecentlyTalkingAboutTopic(String communityId, String topicId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

topicId

型: String

トピックの ID。

戻り値

型: ConnectApi.​Chatter​Group​SummaryPage

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.TopicPage getRecentlyTalkingAboutTopicsForGroup(String communityId, String groupId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

groupId

型: String

グループの ID。

戻り値

型: ConnectApi.​TopicPage

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.TopicPage getRecentlyTalkingAboutTopicsForUser(String communityId, String userId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

userId

型: String

ユーザの ID。

戻り値

型: ConnectApi.​TopicPage

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

同じフィード項目に 3 回以上割り当てられている 2 つのトピックが関連付けられます。

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage getRelatedTopics(String communityId, String topicId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

topicId

型: String

トピックの ID。

戻り値

型: ConnectApi.​TopicPage

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Topic getTopic(String communityId, String topicId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

topicId

型: String

トピックの ID。

戻り値

型: ConnectApi.​Topic

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage getTopics(String communityId, String recordId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

recordId

型: String

レコードまたはフィード項目の ID。

戻り値

型: ConnectApi.​TopicPage

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage getTopics(String communityId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

戻り値

型: ConnectApi.​TopicPage

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: トピックをアルファベット順に並び替えます。

戻り値

型: ConnectApi.​TopicPage

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage getTopics(String communityId, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.​TopicPage

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: トピックをアルファベット順に並び替えます。

戻り値

型: ConnectApi.​TopicPage

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage getTopics(String communityId, String q, ConnectApi.TopicSort sortParam)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

q

型: String

検索する文字列を指定します。文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。

sortParam

型: ConnectApi.​TopicSort

値は次のとおりです。

• popularDesc: トピックを人気順に並び替えます。この値がデフォルトです。
• alphaAsc: トピックをアルファベット順に並び替えます。

戻り値

型: ConnectApi.​TopicPage

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage getTopics(String communityId, String q, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

q

型: String

検索する文字列を指定します。文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。

pageParam

型: Integer

返すページのページ番号を指定します。0 から開始します。null または 0 を渡すと、最初のページが返されます。

pageSize

型: Integer

ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.​TopicPage

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: トピックをアルファベット順に並び替えます。

戻り値

型: ConnectApi.​TopicPage

API バージョン

33.0

ゲストユーザが使用可能

33.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage getTopics(String communityId, String q, Boolean exactMatch)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

q

型: String

検索する文字列を指定します。文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。

exactMatch

型: Boolean

大文字と小文字を含め、完全一致する名前でトピックを検索する場合は、true を指定します。

戻り値

型: ConnectApi.​TopicPage

API バージョン

35.0

ゲストユーザが使用可能

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage getTopicsOrFallBackToRenamedTopics(String communityId, String q, Boolean exactMatch, Boolean fallBackToRenamedTopics)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

q

型: String

検索する文字列を指定します。文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。

exactMatch

型: Boolean

大文字と小文字を含め、完全一致する名前でトピックを検索する場合、または完全一致がない場合に最近名前が変更されたトピックから一致するものを検索する場合は、true を指定します。

fallBackToRenamedTopics

型: Boolean

true を指定します。完全一致がない場合は、最近名前が変更されたトピックから一致するものが返されます。一致する名前が変更されたトピックが複数ある場合は、最新のもののみが返されます。名前が変更されたトピックに一致するものがない場合は、空のコレクションが返されます。

戻り値

型: ConnectApi.​TopicPage

API バージョン

29.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicSuggestionPage getTopicSuggestions(String communityId, String recordId, Integer maxResults)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

recordId

型: String

レコードまたはフィード項目の ID。

maxResults

型: Integer

返される推奨トピックの最大数。デフォルト値は 5 です。値は 1 以上 25 以下で指定する必要があります。

戻り値

型: ConnectApi.​TopicSuggestionPage

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

29.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicSuggestionPage getTopicSuggestions(String communityId, String recordId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

recordId

型: String

レコードまたはフィード項目の ID。

戻り値

型: ConnectApi.​TopicSuggestionPage

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

29.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicSuggestionPage getTopicSuggestionsForText(String communityId, String text, Integer maxResults)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

text

型: String

テキスト文字列。

maxResults

型: Integer

返される推奨トピックの最大数。デフォルト値は 5 です。値は 1 以上 25 以下で指定する必要があります。

戻り値

型: ConnectApi.​TopicSuggestionPage

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

29.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicSuggestionPage getTopicSuggestionsForText(String communityId, String text)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

text

型: String

テキスト文字列。

戻り値

型: ConnectApi.​TopicSuggestionPage

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage getTrendingTopics(String communityId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

戻り値

型: ConnectApi.​TopicPage

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

29.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage getTrendingTopics(String communityId, Integer maxResults)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

maxResults

型: Integer

返される推奨トピックの最大数。デフォルト値は 5 です。値は 1 以上 25 以下で指定する必要があります。

戻り値

型: ConnectApi.​TopicPage

使用方法

このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。

API バージョン

33.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Topic mergeTopics(String communityId, String topicId, List<String> idsToMerge)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

topicId

型: String

マージのプライマリトピックの ID。このトピックが管理トピックの場合は、トピック種別、トピック画像、および子トピックが保持されます。

idsToMerge

型: List<String>

プライマリトピックにマージする最大 5 個のセカンダリトピック ID のカンマ区切りリスト。これらのセカンダリトピックのいずれかが管理トピックの場合、そのトピック種別、トピック画像、および子トピックを失います。フィード項目はプライマリトピックに再割り当てされます。

戻り値

型: ConnectApi.​Topic

使用方法

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.TopicPage reassignTopicsByName(String communityId, String recordId, ConnectApi.TopicNamesInput topicNames)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

recordId

型: String

トピックが割り当てられるレコードまたはフィード項目の ID。

topicNames

型: ConnectApi.TopicNamesInput

現在割り当てられているトピックと置き換えるトピックのリスト。必要に応じて、今後の推奨トピックを改善するために割り当てる推奨トピックのリスト。

戻り値

型: ConnectApi.​TopicPage

API バージョン

29.0

Chatter が必要かどうか

いいえ

署名

public static Void unassignTopic(String communityId, String recordId, String topicId)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

recordId

型: String

レコードまたはフィード項目の ID。

topicId

型: String

トピックの ID。

戻り値

型: Void

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 オブジェクト。

戻り値

型: ConnectApi.​Topic

使用方法

API バージョン

29.0

署名

public static Void setTestGetGroupsRecentlyTalkingAboutTopic(String communityId, String topicId, ConnectApi.ChatterGroupSummaryPage result)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

topicId

型: String

トピックの ID。

result

型: ConnectApi.​Chatter​Group​SummaryPage

テストデータを含むオブジェクト。

戻り値

型: Void

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

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

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

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

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

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

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

API バージョン

29.0

署名

public static Void setTestGetTrendingTopics(String communityId, ConnectApi.TopicPage result)

パラメータ

communityId

型: String

コミュニティの ID、internal、または null のいずれかを使用します。

result

型: ConnectApi.​TopicPage

テストデータを含むオブジェクト。

戻り値

型: Void

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