ChatterFavorites クラス

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedFavorite addFavorite(String communityId, String subjectId, String searchText)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

searchText

型: String

お気に入りとして保存する検索のテキストを指定します。このメソッドでは、リストビューのお気に入りまたはトピックではなく、フィード検索のお気に入りのみを作成できます。

戻り値

型: ConnectApi.FeedFavorite

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedFavorite addRecordFavorite(String communityId, String subjectId, String targetId)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

targetId

型: String

お気に入りとして追加するトピックの ID。

戻り値

型: ConnectApi.FeedFavorite

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static Void deleteFavorite(String communityId, String subjectId, String favoriteId)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

戻り値

型: Void

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedFavorite getFavorite(String communityId, String subjectId, String favoriteId)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

戻り値

型: ConnectApi.FeedFavorite

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedFavorites getFavorites(String communityId, String subjectId)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

戻り値

型: ConnectApi.FeedFavorites

API バージョン

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedElementPage getFeedElements(String communityId, String subjectId, String favoriteId)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

戻り値

型: ConnectApi.FeedElementPage

使用方法

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

API バージョン

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedElementPage getFeedElements(String communityId, String subjectId, String favoriteId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

pageParam

型: String

ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

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

sortParam

型: ConnectApi.FeedSortOrder

値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
• MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
• Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。

null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

戻り値

型: ConnectApi.FeedElementPage

使用方法

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

API バージョン

31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedElementPage getFeedElements(String communityId, String subjectId, String favoriteId, Integer recentCommentCount, Integer elementsPerBundle, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

recentCommentCount

型: Integer

フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。

elementsPerBundle

型: Integer

バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。

pageParam

型: String

ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

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

sortParam

型: ConnectApi.FeedSortOrder

値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
• MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
• Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。

null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

戻り値

型: ConnectApi.FeedElementPage

使用方法

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

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedFavorite updateFavorite(String communityId, String subjectId, String favoriteId, Boolean updateLastViewDate)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

updateLastViewDate

型: Boolean

指定されたお気に入りの最終参照日付を現在のシステム時間に更新するか (true)、否か (false) を指定します。

戻り値

型: ConnectApi.FeedFavorite

API バージョン

31.0

署名

public static Void setTestGetFeedElements(String communityId, String subjectId, String favoriteId, ConnectApi.FeedElementPage result)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

result

型: ConnectApi.FeedElementPage

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

戻り値

型: Void

API バージョン

31.0

署名

public static Void setTestGetFeedElements(String communityId, String subjectId, String favoriteId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

pageParam

型: String

ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

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

sortParam

型: ConnectApi.FeedSortOrder

値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
• MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
• Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。

null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

result

型: ConnectApi.FeedElementPage

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

戻り値

型: Void

API バージョン

31.0

署名

public static Void setTestGetFeedElements(String communityId, String subjectId, String favoriteId, Integer recentCommentCount, Integer elementsPerBundle, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

recentCommentCount

型: Integer

フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。

elementsPerBundle

型: Integer

バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。

pageParam

型: String

ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

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

sortParam

型: ConnectApi.FeedSortOrder

値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
• MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
• Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。

null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

result

型: ConnectApi.FeedElementPage

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

戻り値

型: Void

API バージョン

28.0 ～ 31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedItemPage getFeedItems(String communityId, String subjectId, String favoriteId)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

戻り値

型: ConnectApi.FeedItemPage

使用方法

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

API バージョン

28.0 ～ 31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedItemPage getFeedItems(String communityId, String subjectId, String favoriteId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

pageParam

型: String

ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

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

sortParam

型: ConnectApi.FeedSortOrder

値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
• MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
• Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。

最近作成されたフィード項目、または最近変更されたフィード項目ごとに、返されたフィードが並べ替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

戻り値

型: ConnectApi.FeedItemPage

使用方法

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

API バージョン

29.0 ～ 31.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FeedItemPage getFeedItems(String communityId, String subjectId, String favoriteId, Integer recentCommentCount, String pageParam, Integer pageSize, FeedSortOrder sortParam)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

recentCommentCount

型: Integer

フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。

pageParam

型: String

ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

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

sortParam

型: ConnectApi.FeedSortOrder

値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
• MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
• Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。

最近作成されたフィード項目、または最近変更されたフィード項目ごとに、返されたフィードが並べ替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

戻り値

型: ConnectApi.FeedItemPage

使用方法

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

API バージョン

28.0 ～ 31.0

署名

public static Void setTestGetFeedItems(String communityId, String subjectId, String favoriteId, ConnectApi.FeedItemPage result)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

result

型: ConnectApi.FeedItemPage

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

戻り値

型: Void

API バージョン

28.0 ～ 31.0

署名

public static Void setTestGetFeedItems(String communityId, String subjectId, String favoriteId, String pageParam, Integer pageSize, FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

pageParam

型: String

ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

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

sortParam

型: ConnectApi.FeedSortOrder

値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
• MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
• Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。

最近作成されたフィード項目、または最近変更されたフィード項目ごとに、返されたフィードが並べ替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

result

型: ConnectApi.FeedItemPage

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

戻り値

型: Void

API バージョン

29.0 ～ 31.0

署名

public static Void setTestGetFeedItems(String communityId, String subjectId, String favoriteId, Integer recentCommentCount, String pageParam, Integer pageSize, FeedSortOrder sortParam, ConnectApi.FeedItemPage result)

パラメーター

communityId

型: String

Experience Cloud サイトの ID、internal、または null。

subjectId

型: String

コンテキストユーザーの ID または別名 me。

favoriteId

型: String

お気に入りの ID。

recentCommentCount

型: Integer

フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。

pageParam

型: String

ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。

pageSize

型: Integer

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

sortParam

型: ConnectApi.FeedSortOrder

値は次のとおりです。

• CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
• CreatedDateDesc — 作成日の新しい順に並べ替えます。
• LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
• MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
• Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。

最近作成されたフィード項目、または最近変更されたフィード項目ごとに、返されたフィードが並べ替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

result

型: ConnectApi.FeedItemPage

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

戻り値

型: Void