ManagedTopics クラス

API バージョン

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopic createManagedTopic(String communityId, String recordId, ConnectApi.ManagedTopicType managedTopicType)

パラメータ

communityId

型: String

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

recordId

型: String

トピックの ID。

managedTopicType

型: ConnectApi.ManagedTopicType

管理トピックの種別を指定します。

• Content — ネイティブコンテンツに関連付けられたトピック。
• Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。
• Navigational — コミュニティのナビゲーションメニューに表示されるトピック。

1 つのトピックは 3 つのすべての種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピック、Navigational トピック、Content トピックにすることができます。

最大 25 個の Featured トピックと 5,000 個の Content トピックを作成できます。最大 8 レベルの Navigational 管理トピックを作成できます。最上位トピックは 25 個、レベルごとの子トピックは 10 個、Navigational トピックの最大数は 2,775 個です。

戻り値

型: ConnectApi.ManagedTopic

使用方法

コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) のみが、管理トピックを作成できます。

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopic createManagedTopic(String communityId, String recordId, ConnectApi.ManagedTopicType managedTopicType, String parentId)

パラメータ

communityId

型: String

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

recordId

型: String

トピックの ID。

managedTopicType

型: ConnectApi.ManagedTopicType

子管理トピックを作成する管理トピックの種別の Navigational を指定します。

最大 25 個の Featured トピックと 5,000 個の Content トピックを作成できます。最大 8 レベルの Navigational 管理トピックを作成できます。最上位トピックは 25 個、レベルごとの子トピックは 10 個、Navigational トピックの最大数は 2,775 個です。

parentId

型: String

親管理トピックの ID。

最大 8 レベル (親、直接の子、その子など) の管理トピックを作成でき、管理トピックにつき最大 10 個の子管理トピックを作成できます。

戻り値

型: ConnectApi.ManagedTopic

使用方法

コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) のみが、管理トピックを作成できます。

API バージョン

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopic createManagedTopicByName(String communityId, String name, ConnectApi.ManagedTopicType managedTopicType)

パラメータ

communityId

型: String

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

name

型: String

トピックの名前。

managedTopicType

型: ConnectApi.ManagedTopicType

管理トピックの種別を指定します。

• Content — ネイティブコンテンツに関連付けられたトピック。
• Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。
• Navigational — コミュニティのナビゲーションメニューに表示されるトピック。

1 つのトピックは 3 つのすべての種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピック、Navigational トピック、Content トピックにすることができます。

最大 25 個の Featured トピックと 5,000 個の Content トピックを作成できます。最大 8 レベルの Navigational 管理トピックを作成できます。最上位トピックは 25 個、レベルごとの子トピックは 10 個、Navigational トピックの最大数は 2,775 個です。

戻り値

型: ConnectApi.ManagedTopic

使用方法

コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) のみが、管理トピックを作成できます。

API バージョン

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopic createManagedTopicByName(String communityId, String name, ConnectApi.ManagedTopicType managedTopicType, String parentId)

パラメータ

communityId

型: String

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

name

型: String

トピックの名前。

managedTopicType

型: ConnectApi.ManagedTopicType

子管理トピックを作成する管理トピックの種別の Navigational を指定します。

最大 25 個の Featured トピックと 5,000 個の Content トピックを作成できます。最大 8 レベルの Navigational 管理トピックを作成できます。最上位トピックは 25 個、レベルごとの子トピックは 10 個、Navigational トピックの最大数は 2,775 個です。

parentId

型: String

親管理トピックの ID。

最大 8 レベル (親、直接の子、その子など) の管理トピックを作成でき、管理トピックにつき最大 10 個の子管理トピックを作成できます。

戻り値

型: ConnectApi.ManagedTopic

使用方法

コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) のみが、管理トピックを作成できます。

API バージョン

32.0

Chatter が必要かどうか

いいえ

署名

public static deleteManagedTopic(String communityId, String managedTopicId)

パラメータ

communityId

型: String

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

managedTopicId

型: String

管理トピックの ID。

戻り値

型: Void

使用方法

コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) のみが、管理トピックを削除できます。

API バージョン

32.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopic getManagedTopic(String communityId, String managedTopicId)

パラメータ

communityId

型: String

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

managedTopicId

型: String

管理トピックの ID。

戻り値

型: ConnectApi.ManagedTopic

API バージョン

35.0

ゲストユーザが使用可能

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopic getManagedTopic(String communityId, String managedTopicId, Integer depth)

パラメータ

communityId

型: String

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

managedTopicId

型: String

管理トピックの ID。

depth

型: Integer

整数 1 ～ 8 を指定します。1 を指定すると、ConnectApi.ManagedTopic 出力クラスの children プロパティが null になります。2 を指定すると、ConnectApi.ManagedTopic 出力クラスの children プロパティに、管理トピックの直接の子である管理トピック (存在する場合) が含まれます。3 ～ 8 を指定すると、直接の子である管理トピックとその子管理トピック (存在する場合) が取得されます。depth が指定されていない場合、デフォルトは 1 です。

戻り値

型: ConnectApi.ManagedTopic

API バージョン

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopicCollection getManagedTopics(String communityId)

パラメータ

communityId

型: String

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

戻り値

型: ConnectApi.ManagedTopicCollection

API バージョン

32.0

ゲストユーザが使用可能

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopicCollection getManagedTopics(String communityId, ConnectApi.ManagedTopicType managedTopicType)

パラメータ

communityId

型: String

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

managedTopicType

型: ConnectApi.ManagedTopicType

管理トピックの種別。

• Content — ネイティブコンテンツに関連付けられたトピック。
• Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。
• Navigational — コミュニティのナビゲーションメニューに表示されるトピック。

1 つのトピックは 3 つのすべての種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピック、Navigational トピック、Content トピックにすることができます。

Content を指定する場合、最大 50 個のトピックが返されます。50 個を超える Content トピックが必要な場合、getManagedTopics(communityId, managedTopicType, pageParam, pageSize) を使用します。

戻り値

型: ConnectApi.ManagedTopicCollection

API バージョン

35.0

ゲストユーザが使用可能

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopicCollection getManagedTopics(String communityId, ConnectApi.ManagedTopicType managedTopicType, Integer depth)

パラメータ

communityId

型: String

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

managedTopicType

型: ConnectApi.ManagedTopicType

管理トピックの種別。

• Content — ネイティブコンテンツに関連付けられたトピック。
• Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。
• Navigational — コミュニティのナビゲーションメニューに表示されるトピック。

1 つのトピックは 3 つのすべての種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピック、Navigational トピック、Content トピックにすることができます。

depth

型: Integer

整数 1 ～ 8 を指定します。1 を指定すると、ConnectApi.ManagedTopic 出力クラスの children プロパティが null になります。2 を指定すると、ConnectApi.ManagedTopic 出力クラスの children プロパティに、管理トピックの直接の子である管理トピック (存在する場合) が含まれます。3 ～ 8 を指定すると、直接の子である管理トピックとその子管理トピック (存在する場合) が取得されます。depth が指定されていない場合、デフォルトは 1 です。

戻り値

型: ConnectApi.ManagedTopicCollection

API バージョン

35.0 ～ 37.0

ゲストユーザが使用可能

35.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopicCollection getManagedTopics(String communityId, ConnectApi.ManagedTopicType managedTopicType, String recordId, Integer depth)

パラメータ

communityId

型: String

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

managedTopicType

型: ConnectApi.ManagedTopicType

管理トピックの種別。

• Content — ネイティブコンテンツに関連付けられたトピック。
• Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。
• Navigational — コミュニティのナビゲーションメニューに表示されるトピック。

1 つのトピックは 3 つのすべての種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピック、Navigational トピック、Content トピックにすることができます。

recordId

型: String

管理トピックに関連付けられたトピックの ID。

depth

型: Integer

整数 1 ～ 8 を指定します。1 を指定すると、ConnectApi.ManagedTopic 出力クラスの children プロパティが null になります。2 を指定すると、ConnectApi.ManagedTopic 出力クラスの children プロパティに、管理トピックの直接の子である管理トピック (存在する場合) が含まれます。3 ～ 8 を指定すると、直接の子である管理トピックとその子管理トピック (存在する場合) が取得されます。depth が指定されていない場合、デフォルトは 1 です。

戻り値

型: ConnectApi.ManagedTopicCollection

API バージョン

38.0

ゲストユーザが使用可能

38.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopicCollection getManagedTopics(String communityId, ConnectApi.ManagedTopicType managedTopicType, List<String> recordIds, Integer depth)

パラメータ

communityId

型: String

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

managedTopicType

型: ConnectApi.ManagedTopicType

管理トピックの種別。

• Content — ネイティブコンテンツに関連付けられたトピック。
• Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。
• Navigational — コミュニティのナビゲーションメニューに表示されるトピック。

1 つのトピックは 3 つのすべての種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピック、Navigational トピック、Content トピックにすることができます。

recordIds

型: List<String>

管理トピックに関連付けられた最大 100 件のトピック ID のリスト。

10 を超えるトピック ID を含める場合、depth に 2 ～ 8 は指定できません。

depth

型: Integer

整数 1 ～ 8 を指定します。1 を指定すると、ConnectApi.ManagedTopic 出力クラスの children プロパティが null になります。2 を指定すると、ConnectApi.ManagedTopic 出力クラスの children プロパティに、管理トピックの直接の子である管理トピック (存在する場合) が含まれます。3 ～ 8 を指定すると、直接の子である管理トピックとその子管理トピック (存在する場合) が取得されます。depth が指定されていない場合、デフォルトは 1 です。

戻り値

型: ConnectApi.ManagedTopicCollection

API バージョン

44.0

ゲストユーザが使用可能

44.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopicCollection getManagedTopics(String communityId, ConnectApi.ManagedTopicType managedTopicType, Integer pageParam, Integer pageSize)

パラメータ

communityId

型: String

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

managedTopicType

型: ConnectApi.ManagedTopicType

管理トピックの種別。

• Content — ネイティブコンテンツに関連付けられたトピック。
• Featured — コミュニティホームページなどの主要トピック。ただし、全体的なナビゲーションは提供しません。
• Navigational — コミュニティのナビゲーションメニューに表示されるトピック。

1 つのトピックは 3 つのすべての種別の管理トピックに関連付けることができるため、1 つのトピックを Featured トピック、Navigational トピック、Content トピックにすることができます。

pageParam

型: Integer

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

pageSize

型: Integer

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

戻り値

型: ConnectApi.ManagedTopicCollection

API バージョン

32.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ManagedTopicCollection reorderManagedTopics(String communityId, ConnectApi.ManagedTopicPositionCollectionInput managedTopicPositionCollection)

パラメータ

communityId

型: String

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

managedTopicPositionCollection

型: ConnectApi.ManagedTopicPositionCollectionInput

管理トピックの相対位置のコレクション。このコレクションには、Featured および Navigational トピックのみを含めることができます。すべての管理トピックを含める必要はありません。

戻り値

型: ConnectApi.ManagedTopicCollection

使用方法

コミュニティマネージャ (「コミュニティの作成および設定」または「コミュニティの管理」権限を持つユーザ) のみが、管理トピックを並び替えできます。

親管理トピックまたは同じ親を持つ子管理トピックを並び替えできます。すべての管理トピックを ConnectApi.ManagedTopicPositionCollectionInput に含めない場合、管理トピックはまず ConnectApi.ManagedTopicPositionCollectionInput で指定されている位置に従って並び替えられ、その後で ConnectApi.ManagedTopicPositionCollectionInput に含まれていない管理トピックを次に使用可能な位置に下げて、並び替えられます。

例

次の管理トピックがあるとします。

ConnectApi.ManagedTopicPositionCollectionInput で次の情報を指定して、管理トピックを並び替えます。

結果は次のとおりです。