Apex リファレンスガイド
jChatterFeeds クラス
フィード要素の取得、フィード要素の投稿、フィード要素の削除、いいね!、コメント、ブックマークを実行します。フィード要素の検索、フィード要素の共有、アンケートの投票を行うこともできます。
名前空間
使用方法
Chatter フィードは、フィード要素のコンテナです。抽象クラス ConnectApi.FeedElement は、フィード投稿を表す ConnectApi.FeedItem クラスと、フィードのバンドルおよびおすすめを表す ConnectApi.GenericFeedElement クラスの親クラスです。詳細は、「フィードおよびフィード要素の使用」を参照してください。
フィード項目のメッセージセグメントは、ConnectApi.MessageSegment 型です。フィード項目機能は ConnectApi.FeedItemCapability 型です。レコード項目は、ConnectApi.AbstractRecordField 型です。これらはすべて抽象クラスで、複数の具象サブクラスがあります。実行時、instanceof を使用すると、これらのオブジェクトの具象型をチェックして、対応するダウンキャストを確実に実行することができます。ダウンキャスト時には、不明なサブクラスを処理するデフォルトの case が必要です。
ChatterFeeds のメソッド
ChatterFeeds のメソッドは次のとおりです。すべてのメソッドが静的です。
createStream(communityId, streamInput)
API バージョン
39.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStream createStream(String communityId, ConnectApi.ChatterStreamInput streamInput)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- streamInput
- 型: ConnectApi.ChatterStreamInput
- ConnectApi.ChatterStreamInput 本文。
戻り値
getComment(communityId, commentId)
コメントを取得します。
API バージョン
28.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Comment getComment(String communityId, String commentId)
パラメーター
戻り値
getCommentBatch(communityId, commentIds)
API バージョン
42.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BatchResult[] getCommentBatch(String communityId, List<String> commentIds)
パラメーター
戻り値
ConnectApi.BatchResult.getResult() メソッドは、読み込まれなかったコメントの ConnectApi.Comment オブジェクトとエラーを返します。
getCommentInContext(communityId, commentId, pageSize)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement getCommentInContext(String communityId, String commentId, Integer pageSize)
パラメーター
戻り値
コメントが comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getCommentsForFeedElement(communityId, feedElementId)
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId)
パラメーター
戻り値
フィード要素が Comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getCommentsForFeedElement(communityId, feedElementId, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId, Boolean threadedCommentsCollapsed)
パラメーター
戻り値
フィード要素が Comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getCommentsForFeedElement(communityId, feedElementId, pageParam, pageSize)
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId, String pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのコメント数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
戻り値
フィード要素が Comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getCommentsForFeedElement(communityId, feedElementId, pageParam, pageSize, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId, String pageParam, Integer pageSize, Boolean threadedCommentsCollapsed)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのコメント数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
戻り値
フィード要素が Comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getCommentsForFeedElement(communityId, feedElementId, threadedCommentsCollapsed, sortParam)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentsCapability getCommentsForFeedElement(String communityId, String feedElementId, Boolean threadedCommentsCollapsed, ConnectApi.FeedCommentSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
- sortParam
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序。値は次のとおりです。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並べ替えます。
- CreatedDateOldestAsc — コメントを古い順に並べ替えます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。
戻り値
フィード要素が Comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getCommentsForFeedElement(communityId, feedElementId, pageParam, pageSize, threadedCommentsCollapsed, sortParam)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId, String pageParam, Integer pageSize, Boolean threadedCommentsCollapsed, ConnectApi.FeedCommentSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのコメント数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
- sortParam
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序。値は次のとおりです。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並べ替えます。
- CreatedDateOldestAsc — コメントを古い順に並べ替えます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。
戻り値
フィード要素が Comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getCommentsForFeedElement(communityId, feedElementId, sortParam)
API バージョン
41.0
ゲストユーザーが使用可能
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentsCapability getCommentsForFeedElement(String communityId, String feedElementId, ConnectApi.FeedCommentSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- sortParam
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序。値は次のとおりです。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並べ替えます。
- CreatedDateOldestAsc — コメントを古い順に並べ替えます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。
戻り値
型: ConnectApi.CommentsCapability
フィード要素が Comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getCommentsForFeedElement(communityId, feedElementId, sortParam, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentsCapability getCommentsForFeedElement(String communityId, String feedElementId, ConnectApi.FeedCommentSortOrder sortParam, Boolean threadedCommentsCollapsed)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- sortParam
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序。値は次のとおりです。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並べ替えます。
- CreatedDateOldestAsc — コメントを古い順に並べ替えます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
戻り値
型: ConnectApi.CommentsCapability
フィード要素が Comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getExtensions(communityId, pageParam, pageSize)
API バージョン
40.0
ゲストユーザーが使用可能
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ExtensionDefinitions getExtensions(String communityId, String pageParam, Integer pageSize)
パラメーター
getFeed(communityId, feedType)
フィードを取得します。
API バージョン
28.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Feed getFeed(String communityId, ConnectApi.FeedType feedType)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
戻り値
getFeed(communityId, feedType, sortParam)
並べ替えたフィードを取得します。
API バージョン
28.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Feed getFeed(String communityId, ConnectApi.FeedType feedType, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並べ替えます。
- LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、お��び Topics フィードでのみ使用できます。
feedType が DirectMessages の場合、sortParam は LastModifiedDateDesc である必要があります。
戻り値
getFeed(communityId, feedType, subjectId)
レコードまたはユーザーのフィードを取得します。
API バージョン
28.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Feed getFeed(String communityId, ConnectApi.FeedType feedType, String subjectId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
戻り値
getFeed(communityId, feedType, subjectId, sortParam)
レコードまたはユーザーの並べ替えたフィードを取得します。
API バージョン
28.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Feed getFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並べ替えます。
- LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。
戻り値
getFeedDirectory(String)
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedDirectory getFeedDirectory(String communityId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
戻り値
getFeedElement(communityId, feedElementId)
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId)
パラメーター
戻り値
getFeedElement(communityId, feedElementId, commentSort)
API バージョン
41.0
ゲストユーザーが使用可能
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, ConnectApi.FeedCommentSortOrder commentSort)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- commentSort
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並べ替えます。
- CreatedDateOldestAsc — コメントを古い順に並べ替えます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。
降順で並べ替えはサポートされません。
戻り値
getFeedElement(communityId, feedElementId, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Boolean threadedCommentsCollapsed)
パラメーター
戻り値
getFeedElement(communityId, feedElementId, threadedCommentsCollapsed, commentSort)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Boolean threadedCommentsCollapsed, ConnectApi.FeedCommentSortOrder commentSort)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
- commentSort
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並べ替えます。
- CreatedDateOldestAsc — コメントを古い順に並べ替えます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。
戻り値
getFeedElement(communityId, feedElementId, recentCommentCount, elementsPerBundle)
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Integer recentCommentCount, Integer elementsPerBundle)
パラメーター
戻り値
getFeedElement(communityId, feedElementId, recentCommentCount, elementsPerBundle, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Integer recentCommentCount, Integer elementsPerBundle, Boolean threadedCommentsCollapsed)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
戻り値
getFeedElement(communityId, feedElementId, recentCommentCount, elementsPerBundle, threadedCommentsCollapsed, commentSort)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Integer recentCommentCount, Integer elementsPerBundle, Boolean threadedCommentsCollapsed, ConnectApi.FeedCommentSortOrder commentSort)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
- commentSort
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並べ替えます。
- CreatedDateOldestAsc — コメントを古い順に並べ替えます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。
戻り値
getFeedElement(communityId, feedElementId, recentCommentCount, elementsPerBundle, commentSort)
API バージョン
41.0
ゲストユーザーが使用可能
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement getFeedElement(String communityId, String feedElementId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedCommentSortOrder commentSort)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- commentSort
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並べ替えます。
- CreatedDateOldestAsc — コメントを古い順に並べ替えます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。
降順で並べ替えはサポートされません。
戻り値
getFeedElementBatch(communityId, feedElementIds)
API バージョン
31.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BatchResult[] getFeedElementBatch(String communityId, List<String> feedElementIds)
パラメーター
戻り値
ConnectApi.BatchResult.getResult() メソッドは、読み込まれなかったフィード要素の ConnectApi.FeedElement オブジェクトとエラーを返します。
getFeedElementPoll(communityId, feedElementId)
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.PollCapability getFeedElementPoll(String communityId, String feedElementId)
パラメーター
getFeedElementsFromBundle(communityId, feedElementId)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromBundle(String communityId, String feedElementId)
パラメーター
戻り値
getFeedElementsFromBundle(communityId, feedElementId, pageParam, pageSize, elementsPerBundle, recentCommentCount)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromBundle(String communityId, String feedElementId, String pageParam, Integer pageSize, Integer elementsPerBundle, Integer recentCommentCount)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
戻り値
getFeedElementsFromFeed(communityId, feedType)
Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview フィードからフィード要素を取得します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じ���ないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, pageParam, pageSize, sortParam)
Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview フィードからフィード要素を並べ替えたページを取得します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- 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 フィードでのみ使用できます。
feedType が DirectMessages の場合、sortParam は LastModifiedDateDesc である必要があります。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam)
Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview フィードからフィード要素を並べ替えたページを取得します。各フィード要素には、指定された数以内のコメント数が含まれます。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
feedType が DirectMessages の場合、sortParam は LastModifiedDateDesc である必要があります。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, filter)
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedFilter filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は Home のみです。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, filter, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedFilter filter, Boolean threadedCommentsCollapsed)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は Home のみです。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
sortParam が MostViewed の場合、pageParam に null を渡す必要があります。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
sortParam が MostViewed の場合、pageSize の値は 1 ～ 25 である必要があります。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並べ替えます。
- LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId)
ユーザーまたはレコードで、Company、DirectMessageModeration、DirectMessages、Filter、Home、Isolated、Moderation、Moderation、および PendingReview 以外のフィードからフィード要素を取得します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
コンテキストユーザーのニュースフィードの取得の例
1ConnectApi.FeedElementPage fep = ConnectApi.ChatterFeeds.getFeedElementsFromFeed(Network.getNetworkId(), ConnectApi.FeedType.News, 'me');別のユーザーのプロファイルフィードの取得���例
1ConnectApi.FeedElementPage fep = ConnectApi.ChatterFeeds.getFeedElementsFromFeed(Network.getNetworkId(), ConnectApi.FeedType.UserProfile, '005R0000000HwMA');別のユーザーのレコードフィードの取得の例
1ConnectApi.FeedElementPage fep = ConnectApi.ChatterFeeds.getFeedElementsFromFeed(Network.getNetworkId(), ConnectApi.FeedType.Record, '005R0000000HwMA');getFeedElementsFromFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam)
Company、DirectMessageModeration、DirectMessages、Filter、Home、Isolated、Landing、Moderation、および PendingReview 以外のフィードからフィード要素を並べ替えたページを取得します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並べ替えます。
- LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam)
Company、DirectMessageModeration、DirectMessages、Filter、Home、Isolated、Landing、Moderation、および PendingReview 以外のフィードからフィード要素を並べ替えたページを取得します。各フィード要素には、指定された数以内のコメント数が含まれます。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, showInternalOnly)
レコードフィードからフィード要素を並べ替えたページを取得します。各フィード要素には、指定された数以内のコメント数が含まれます。内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード要素を返すかどうかを指定します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, filter)
API バージョン
35.0
ゲストユーザーが使用可能
35.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedFilter filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.UserProfile である必要があります。
- subjectId
- 型: String
- ユーザーの ID。コンテキストユーザーを指定するには、ユーザー ID または別名 me を使用します。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped または ConnectApi.FeedFilter.AuthoredBy である必要があります。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
例
次の例は、コミュニティ固有のフィード要素のみを取得します。
1ConnectApi.FeedElementPage fep = ConnectApi.ChatterFeeds.getFeedElementsFromFeed(Network.getNetworkId(), ConnectApi.FeedType.UserProfile, 'me', 3, ConnectApi.FeedDensity.FewerUpdates, null, null, ConnectApi.FeedSortOrder.LastModifiedDateDesc, ConnectApi.FeedFilter.CommunityScoped);getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, filter, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedFilter filter, Boolean threadedCommentsCollapsed)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.UserProfile である必要があります。
- subjectId
- 型: String
- ユーザーの ID。コンテキストユーザーを指定するには、ユーザー ID または別名 me を使用します。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped または ConnectApi.FeedFilter.AuthoredBy である必要があります。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, customFilter)
API バージョン
40.0
ゲストユーザーが使用可能
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String customFilter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly)
レコードフィードからフィード要素を並べ替えたページを取得します。バンドルごとの要素数を指定し、フィード要素ごとに指定された数以内のコメント数を含めます。内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード要素を返すかどうかを指定します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, filter)
レコードフィードからフィード要素を並べ替え、絞り込んだページを取得します。バンドルごとの要素数を指定し、フィード要素ごとに指定された数以内のコメント数を含めます。内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード要素を返すかどうかを指定します。
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, ConnectApi.FeedFilter filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, filter, threadedCommentsCollapsed)
レコードフィードからスレッドスタイルでのコメントを含むフィード要素を並べ替え、絞り込んだページを取得します。バンドルごとの要素数を指定し、フィード要素ごとに指定された数以内のコメント数を含めます。内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード要素を返すかどうかを指定します。
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, ConnectApi.FeedFilter filter, Boolean threadedCommentsCollapsed)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザー��らのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, customFilter)
API バージョン
40.0
ゲストユーザーが使用可能
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, String customFilter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, customFilter, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, String customFilter, Boolean threadedCommentsCollapsed)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix)
パラメーター
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsFromFilterFeedUpdatedSince(communityId, subjectId, keyPrefix, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFilterFeedUpdatedSince(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの変更タイムスタンプと並べ替え順を定義する不透明トークン。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince)
Company、DirectMessageModeration、Home、および Moderation フィードからフィード要素のページを取得します。updatedSince パラメーターで指定された時刻以降に更新されたフィード要素のみが含まれます。各フィード要素には、指定された数以内のコメント数が含まれます。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、および Moderation です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince, filter)
Home フィードからフィード要素を絞り込んだページを取得します。updatedSince パラメーターで指定された時刻以降に更新されたフィード要素のみが含まれます。各フィード要素には、指定された数以内のコメント数が含まれます。
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedFilter filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は Home のみです。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince)
Files、Groups、News、People、および Record フィードからフィード要素のページを取得します。updatedSince パラメーターで指定された時刻以降に更新されたフィード要素のみが含まれます。各フィード要素には、指定された数以内のコメント数が含まれます。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかの値になります。
- Files
- Groups
- News
- People
- Record
- subjectId
- 型: String
- feedType が ConnectApi.Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。それ以外の場合は、コンテキストユーザーまたは別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとな���ているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, showInternalOnly)
レコードフィードからフィード要素のページを取得します。updatedSince パラメーターで指定された時刻以降に更新されたフィード要素のみが含まれます。内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード要素を返すかどうかを指定します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, filter)
API バージョン
35.0
ゲストユーザーが使用可能
35.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedFilter filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.UserProfile である必要があります。
- subjectId
- 型: String
- ユーザーの ID。コンテキストユーザーを指定するには、ユーザー ID または別名 me を使用します。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの変更タイムスタンプと並べ替え順を定義する不透明トークン。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped である必要があります。Experience Cloud サイトを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのサイトで常に表示されるフィード要素は除外されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, customFilter)
API バージョン
40.0
ゲストユーザーが使用可能
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, String customFilter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの変更タイムスタンプと並べ替え順を定義する不透明トークン。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly)
レコードフィードからフィード要素のページを取得します。updatedSince パラメーターで指定された時刻以降に更新されたフィード要素のみが含まれます。バンドル内の最大フィード要素数と、内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード要素を返すかどうかを指定します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, filter)
レコードフィードからフィード要素を絞り込んだページを取得します。updatedSince パラメーターで指定された時刻以降に更新されたフィード要素のみが含まれます。バンドル内の最大フィード要素数と、内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード要素を返すかどうかを指定します。
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, ConnectApi.FeedFilter filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, customFilter)
API バージョン
40.0
ゲストユーザーが使用可能
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, String customFilter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedWithFeedElements(communityId, feedType, pageSize)
API バージョン
40.0
ゲストユーザーが使用可能
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Feed getFeedWithFeedElements(String communityId, ConnectApi.FeedType feedType, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Landing、Moderation、および PendingReview です。Landing が有効なのは、communityId が internal のときのみです。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。0 を渡した場合、フィード要素はフィードと共に返されません。
戻り値
getFeedWithFeedElements(communityId, feedType, pageSize, recentCommentCount)
API バージョン
40.0
ゲストユーザーが使用可能
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Feed getFeedWithFeedElements(String communityId, ConnectApi.FeedType feedType, Integer pageSize, Integer recentCommentCount)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Landing、Moderation、および PendingReview です。Landing が有効なのは、communityId が internal のときのみです。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。0 を渡した場合、フィード要素はフィードと共に返されません。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
戻り値
getFilterFeed(communityId, subjectId, keyPrefix)
ユーザーのキープレフィックスで絞り込まれたフィードを取得します。
API バージョン
28.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Feed getFilterFeed(String communityId, String subjectId, String keyPrefix)
パラメーター
戻り値
getFilterFeed(communityId, subjectId, keyPrefix, sortParam)
ユーザーのキープレフィックスで絞り込まれたフィードを並べ替えて取得します。
API バージョン
28.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Feed getFilterFeed(String communityId, String subjectId, String keyPrefix, ConnectApi.FeedType sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- sortParam
- 型: ConnectApi.FeedType
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並べ替えます。
- LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。
戻り値
getFilterFeedDirectory(communityId, subjectId)
コンテキストユーザーが使用できるフィルターフィードのフィードディレクトリを取得します。
API バージョン
30.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedDirectory getFilterFeedDirectory(String communityId, String subjectId)
パラメーター
戻り値
このフィードディレクトリには、フィルターフィードのリストが含まれます。フィルターフィードは、特定のエンティティ種別の親を持つフィード項目のみが表示されるように絞り込まれたニュースフィードです。
使用方法
このメソッドをコールして、ConnectApi.FeedDirectoryItem オブジェクトのリストを含むディレクトリを返します。各オブジェクトには、コンテキストユーザーがフォローするエンティティ種別に関連付けられたキープレフィックスが含まれます。キープレフィックスは、レコード ID の先頭 3 文字で、オブジェクト種別を示します。
キープレフィックスに関連付けられたエンティティ種別の親を持つフィード項目のみがニュースフィードに含まれるようにキープレフィックスを使用してニュースフィードを絞り込みます。たとえば、取引先を親に持つすべてのフィード項目を取得します。フィード項目を取得するには、キープレフィックスを ConnectApi.getFeedItemsFromFilterFeed メソッドに渡します。
フィルターフィードに関する情報には、ユーザー (005) またはグループ (0F9) のキープレフィックスが含まれることはありません。ただし、すべてのユーザーがキープレフィックスを検索条件として使用することができます。
ニュースフィードをお気に入りで絞り込めないため、getFilterFeedDirectory へのコールで返されたときの ConnectApi.FeedDirectory.favorites プロパティは必ず空白です。
例
この例は、getFilterFeedDirectory をコールし、返された FeedDirectoryItem オブジェクトをループ処理して、コンテキストユーザーがニュースフィードを絞り込むときに使用できるキープレフィックスを検索します。その後、各 keyPrefix の値をリストにコピ���します。最後に、リストから getFeedItemsFromFilterFeed メソッドにキープレフィックスの 1 つを渡します。返されたフィード項目には、渡されたキープレフィックスによって指定されたエンティティ種別を親に持つニュースフィードからのすべてのフィード項目が含まれます。
1String communityId = null;
2String subjectId = 'me';
3
4// Create a list to populate with key prefixes.
5List<String> keyPrefixList = new List<String>();
6
7// Prepopulate with User and Group record types
8// which are available to all users.
9keyPrefixList.add('005');
10keyPrefixList.add('0F9');
11
12System.debug(keyPrefixList);
13
14// Get the key prefixes available to the context user.
15ConnectApi.FeedDirectory myFeedDirectory =
16 ConnectApi.ChatterFeeds.getFilterFeedDirectory(null, 'me');
17
18// Loop through the returned feeds list.
19for (ConnectApi.FeedDirectoryItem i : myFeedDirectory.feeds) {
20
21 // Grab each key prefix and add it to the list.
22 keyPrefixList.add(i.keyPrefix);
23}
24System.debug(keyPrefixList);
25
26// Use a key prefix from the list to filter the feed items in the news feed.
27ConnectApi.FeedItemPage myFeedItemPage =
28 ConnectApi.ChatterFeeds.getFeedItemsFromFilterFeed(communityId, subjectId, keyPrefixList[0]);
29System.debug(myFeedItemPage);getLike(communityId, likeId)
投稿またはコメントに対するいいね! を取得します。
API バージョン
28.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLike getLike(String communityId, String likeId)
パラメーター
戻り値
getLikesForComment(communityId, commentId)
コメントへのいいね! を取得します。
API バージョン
28.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLikePage getLikesForComment(String communityId, String commentId)
パラメーター
getLikesForComment(communityId, commentId, pageParam, pageSize)
コメントへのいいね! のページを取得します。
API バージョン
28.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLikePage getLikesForComment(String communityId, String commentId, Integer pageParam, Integer pageSize)
パラメーター
getLikesForFeedElement(communityId, feedElementId)
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLikePage getLikesForFeedElement(String communityId, String feedElementId)
パラメーター
戻り値
フィード要素が ChatterLikes 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getLikesForFeedElement(communityId, feedElementId, pageParam, pageSize)
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLikePage getLikesForFeedElement(String communityId, String feedElementId, Integer pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
戻り値
フィード要素が ChatterLikes 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getLinkMetadata(communityId, urls)
API バージョン
42.0
ゲストユーザーが使用可能
42.0
Chatter が必要かどうか
いいえ
署名
public static ConnectApi.LinkMetadataCollection getLinkMetadata(String communityId, String urls)
パラメーター
getPinnedFeedElementsFromFeed(communityId, feedType, subjectId)
API バージョン
41.0
ゲストユーザーが使用可能
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.PinnedFeedElements getPinnedFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Record および Topics です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId はグループ ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。
戻り値
型: ConnectApi.PinnedFeedElements
フィードがこの機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。getReadByForFeedElement(communityId, feedElementId)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ReadByPage getReadByForFeedElement(String communityId, String feedElementId)
パラメーター
getReadByForFeedElement(communityId, feedElementId, pageParam, pageSize)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ReadByPage getReadByForFeedElement(String communityId, String feedElementId, Integer pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
getRelatedPosts(communityId, feedElementId, filter, maxResults)
API バージョン
37.0
ゲストユーザーが使用可能
37.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.RelatedFeedPosts getRelatedPosts(String communityId, String feedElementId, ConnectApi.RelatedFeedPostType filter, Integer maxResults)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。フィード要素は質問である必要があります。
- filter
- 型: ConnectApi.RelatedFeedPostType
- 関連投稿の種別を指定します。値は次のとおりです。
- Answered — 1 つ以上の回答がある関連質問。
- BestAnswer — 最良の回答がある関連質問。
- Generic — 回答がある関連質問、最良の回答がある関連質問、回答がない関連質問を含む、すべての種別の関連質問。
- Unanswered — 回答がない関連質問。
- maxResults
- 型: Integer
- 返す結果の最大数。最大 25 件の結果を返すことができます。デフォルト値は 5 です。
戻り値
型: ConnectApi.RelatedFeedPosts
バージョン 37.0 以降では、関連するフィード投稿は質問です。
各関連フィード投稿には、コンテキストフィード投稿にどれくらい関連しているかを示すスコアが含まれます。関連フィード投稿はスコアによって並べ替えられ、最高スコアが先頭になります。
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getStream(communityId, streamId)
API バージョン
39.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStream getStream(String communityId, String streamId)
パラメーター
戻り値
getStream(communityId, streamId, globalScope)
API バージョン
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStream getStream(String communityId, String streamId, Boolean globalScope)
パラメーター
戻り値
getStreams(communityId)
API バージョン
39.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStreamPage getStreams(String communityId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
戻り値
getStreams(communityId, sortParam)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStreamPage getStreams(String communityId, ConnectApi.SortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- sortParam
- 型: ConnectApi.SortOrder
-
並べ替え順を指定します。値は次のとおりです。
- Ascending — 項目はアルファベットの昇順 (A ～ Z) で並べられる。
- Descending — 項目はアルファベットの降順 (Z ～ A) で並べられる。
- MostRecentlyViewed — 項目は、最近参照されたものから順番に並べられる。この並べ替え順は、Chatter フィードストリームでのみ有効です。
戻り値
getStreams(communityId, pageParam, pageSize)
API バージョン
39.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStreamPage getStreams(String communityId, Integer pageParam, Integer pageSize)
パラメーター
戻り値
getStreams(communityId, pageParam, pageSize, sortParam)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStreamPage getStreams(String communityId, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- pageParam
- 型: Integer
- 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。デフォルトサイズは 25 です。
- sortParam
- 型: ConnectApi.SortOrder
-
並べ替え順を指定します。値は次のとおりです。
- Ascending — 項目はアルファベットの昇順 (A ～ Z) で並べられる。
- Descending — 項目はアルファベットの降順 (Z ～ A) で並べられる。
- MostRecentlyViewed — 項目は、最近参照されたものから順番に並べられる。この並べ替え順は、Chatter フィードストリームでのみ有効です。
戻り値
getStreams(communityId, pageParam, pageSize, sortParam, globalScope)
API バージョン
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStreamPage getStreams(String communityId, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam, Boolean globalScope)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- pageParam
- 型: Integer
- 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。デフォルトサイズは 25 です。
- sortParam
- 型: ConnectApi.SortOrder
-
並べ替え順を指定します。値は次のとおりです。
- Ascending — 項目はアルファベットの昇順 (A ～ Z) で並べられる。
- Descending — 項目はアルファベットの降順 (Z ～ A) で並べられる。
- MostRecentlyViewed — 項目は、最近参照されたものから順番に並べられる。この並べ替え順は、Chatter フィードストリームでのみ有効です。
- globalScope
- 型: Boolean
- communityId 値に関係なく、すべてのコンテキストユーザーの Experience Cloud サイトからのストリームを取得するかどうかを指定します。
戻り値
getSupportedEmojis()
API バージョン
39.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.SupportedEmojis getSupportedEmojis()
戻り値
getThreadsForFeedComment(communityId, commentId)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentPage getThreadsForFeedComment(String communityId, String commentId)
パラメーター
戻り値
コメントが comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getThreadsForFeedComment(communityId, commentId, pageParam, pageSize)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentPage getThreadsForFeedComment(String communityId, String commentId, String pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- commentId
- 型: String
- コメントの ID。
- pageParam
- 型: String
- 情報ページの表示に使用するページトークンを指定します。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
戻り値
コメントが comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getThreadsForFeedComment(communityId, commentId, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentsCapability getThreadsForFeedComment(String communityId, String commentId, Boolean threadedCommentsCollapsed)
パラメーター
戻り値
型: ConnectApi.CommentsCapability
コメントが comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
getTopUnansweredQuestions(communityId) (パイロット)
API バージョン
42.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getTopUnansweredQuestions(String communityId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getTopUnansweredQuestions(communityId, filter) (パイロット)
API バージョン
42.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getTopUnansweredQuestions(String communityId, ConnectApi.TopUnansweredQuestionsFilterType filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID。
- filter
- 型: ConnectApi.FeedFilter
- フィードの検索条件を指定します。有効な値は UnansweredQuestionsWithCandidateAnswers のみです。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getTopUnansweredQuestions(communityId, pageSize) (パイロット)
API バージョン
42.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getTopUnansweredQuestions(String communityId, Integer pageSize)
パラメーター
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getTopUnansweredQuestions(communityId, filter, pageSize) (パイロット)
API バージョン
42.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getTopUnansweredQuestions(String communityId, ConnectApi.FeedFilter filter, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID。
- filter
- 型: ConnectApi.FeedFilter
- フィードの検索条件を指定します。有効な値は UnansweredQuestionsWithCandidateAnswers のみです。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 0 ～ 10 です。null を渡すと、デフォルトサイズの 5 に設定されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getVotesForComment(communityId, commentId, vote)
API バージョン
42.0
ゲストユーザーが使用可能
42.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.VotePage getVotesForComment(String communityId, String commentId, ConnectApi.UpDownVoteValue vote)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- commentId
- 型: String
- コメントの ID。
- vote
- 型: ConnectApi.UpDownVoteValue
- フィード要素の投票の値を指定します。値は次のとおりです。
- Down
- Up
getVotesForComment(communityId, commentId, vote, pageParam, pageSize)
API バージョン
42.0
ゲストユーザーが使用可能
42.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.VotePage getVotesForComment(String communityId, String commentId, ConnectApi.UpDownVoteValue vote, Integer pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- commentId
- 型: String
- コメントの ID。
- vote
- 型: ConnectApi.UpDownVoteValue
- フィード要素の投票の値を指定します。値は次のとおりです。
- Down
- Up
- pageParam
- 型: Integer
- 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
getVotesForFeedElement(communityId, feedElementId, vote)
API バージョン
42.0
ゲストユーザーが使用可能
42.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.VotePage getVotesForFeedElement(String communityId, String feedElementId, ConnectApi.UpDownVoteValue vote)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- vote
- 型: ConnectApi.UpDownVoteValue
-
フィード要素の投票の値を指定します。値は次のとおりです。
- Down
- Up
getVotesForFeedElement(communityId, feedElementId, vote, pageParam, pageSize)
API バージョン
42.0
ゲストユーザーが使用可能
42.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.VotePage getVotesForFeedElement(String communityId, String feedElementId, ConnectApi.UpDownVoteValue vote, Integer pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- vote
- 型: ConnectApi.UpDownVoteValue
- フィード要素の投票の値を指定します。値は次のとおりです。
- Down
- Up
- pageParam
- 型: Integer
- 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
isCommentEditableByMe(communityId, commentId)
API バージョン
34.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedEntityIsEditable isCommentEditableByMe(String communityId, String commentId)
パラメーター
戻り値
型: ConnectApi.FeedEntityIsEditable
コメントが edit 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
isFeedElementEditableByMe(communityId, feedElementId)
API バージョン
34.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedEntityIsEditable isFeedElementEditableByMe(String communityId, String feedElementId)
パラメーター
戻り値
型: ConnectApi.FeedEntityIsEditable
フィード要素が edit 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
isModified(communityId, feedType, subjectId, since)
ニュースフィードが更新または変更されたかどうかを確認します。このメソッドは、ニュースフィードをポーリングして更新するために使用します。
API バージョン
28.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedModifiedInfo isModified(String communityId, ConnectApi.FeedType feedType, String subjectId, String since)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別を指定します。サポートされている種別は News のみです。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- since
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。FeedElementPage.isModifiedToken プロパティからこのトークンを取得します。
戻り値
likeComment(communityId, commentId)
コンテキストユーザーのコメントにいいね! と言います。
API バージョン
28.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLike likeComment(String communityId, String commentId)
パラメーター
likeFeedElement(communityId, feedElementId)
API バージョン
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLike likeFeedElement(String communityId, String feedElementId)
パラメーター
戻り値
フィード要素が ChatterLikes 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
例
1ConnectApi.ChatterLike chatterLike = ConnectApi.ChatterFeeds.likeFeedElement(null, '0D5D0000000KuGh');postCommentToFeedElement(communityId, feedElementId, text)
API バージョン
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Comment postCommentToFeedElement(String communityId, String feedElementId, String text)
パラメーター
例
1ConnectApi.Comment comment = ConnectApi.ChatterFeeds.postCommentToFeedElement(null, '0D5D0000000KuGh', 'I agree with the proposal.' );postCommentToFeedElement(communityId, feedElementId, comment, feedElementFileUpload)
API バージョン
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Comment postCommentToFeedElement(String communityId, String feedElementId, ConnectApi.CommentInput comment, ConnectApi.BinaryInput feedElementFileUpload)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- comment
- 型: ConnectApi.CommentInput
- 添付ファイルに関する情報など、テキスト、メンション、機能などを含む、コメント本文。コメントには 10,000 文字まで使用できます。
- feedElementFileUpload
- 型: ConnectApi.BinaryInput
- コメントに添付する新しいバイナリファイル、または null。バイナリファイルを指定した場合、comment パラメーターにファイルのタイトルと説明を指定します。
メンションを含むコメントの投稿の例
メンションを含むコメントを投稿する方法は 2 つあります。GitHub の ConnectApiHelper リポジトリを使用して 1 行のコードを記述するか、次のメソッド例を使用します。
1String communityId = null;
2String feedElementId = '0D5D0000000KtW3';
3
4ConnectApi.CommentInput commentInput = new ConnectApi.CommentInput();
5ConnectApi.MentionSegmentInput mentionSegmentInput = new ConnectApi.MentionSegmentInput();
6ConnectApi.MessageBodyInput messageBodyInput = new ConnectApi.MessageBodyInput();
7ConnectApi.TextSegmentInput textSegmentInput = new ConnectApi.TextSegmentInput();
8
9messageBodyInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
10
11textSegmentInput.text = 'Does anyone in this group have an idea? ';
12messageBodyInput.messageSegments.add(textSegmentInput);
13
14mentionSegmentInput.id = '005D00000000oOT';
15messageBodyInput.messageSegments.add(mentionSegmentInput);
16
17commentInput.body = messageBodyInput;
18
19ConnectApi.Comment commentRep = ConnectApi.ChatterFeeds.postCommentToFeedElement(communityId, feedElementId, commentInput, null);既存のファイルを添付したコメントの投稿の例
1String feedElementId = '0D5D0000000KtW3';
2
3ConnectApi.CommentInput commentInput = new ConnectApi.CommentInput();
4
5ConnectApi.MessageBodyInput messageBodyInput = new ConnectApi.MessageBodyInput();
6ConnectApi.TextSegmentInput textSegmentInput = new ConnectApi.TextSegmentInput();
7
8textSegmentInput.text = 'I attached this file from Salesforce Files.';
9
10messageBodyInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
11messageBodyInput.messageSegments.add(textSegmentInput);
12commentInput.body = messageBodyInput;
13
14ConnectApi.CommentCapabilitiesInput commentCapabilitiesInput = new ConnectApi.CommentCapabilitiesInput();
15ConnectApi.ContentCapabilityInput contentCapabilityInput = new ConnectApi.ContentCapabilityInput();
16
17commentCapabilitiesInput.content = contentCapabilityInput;
18contentCapabilityInput.contentDocumentId = '069D00000001rNJ';
19
20commentInput.capabilities = commentCapabilitiesInput;
21
22ConnectApi.Comment commentRep = ConnectApi.ChatterFeeds.postCommentToFeedElement(Network.getNetworkId(), feedElementId, commentInput, null);新しいファイルを添付したコメントの投稿の例
1String feedElementId = '0D5D0000000KtW3';
2
3ConnectApi.CommentInput commentInput = new ConnectApi.CommentInput();
4
5ConnectApi.MessageBodyInput messageBodyInput = new ConnectApi.MessageBodyInput();
6ConnectApi.TextSegmentInput textSegmentInput = new ConnectApi.TextSegmentInput();
7
8textSegmentInput.text = 'Enjoy this new file.';
9
10messageBodyInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
11messageBodyInput.messageSegments.add(textSegmentInput);
12commentInput.body = messageBodyInput;
13
14ConnectApi.CommentCapabilitiesInput commentCapabilitiesInput = new ConnectApi.CommentCapabilitiesInput();
15ConnectApi.ContentCapabilityInput contentCapabilityInput = new ConnectApi.ContentCapabilityInput();
16
17commentCapabilitiesInput.content = contentCapabilityInput;
18contentCapabilityInput.title = 'Title';
19
20commentInput.capabilities = commentCapabilitiesInput;
21
22String text = 'These are the contents of the new file.';
23Blob myBlob = Blob.valueOf(text);
24ConnectApi.BinaryInput binInput = new ConnectApi.BinaryInput(myBlob, 'text/plain', 'fileName');
25
26ConnectApi.Comment commentRep = ConnectApi.ChatterFeeds.postCommentToFeedElement(Network.getNetworkId(), feedElementId, commentInput, binInput);インライン画像を含むリッチテキストコメントの投稿の例
インライン画像とメンションを含むリッチテキストコメントを投稿する方法は 2 つあります。GitHub の ConnectApiHelper リポジトリを使用して 1 行のコードを記述するか、次のメソッド例を使用します。この例の画像ファイルは、Salesforce にアップロード済みの既存のコンテンツです。
1String communityId = null;
2String feedElementId = '0D5R0000000SBEr';
3String imageId = '069R00000000IgQ';
4String mentionedUserId = '005R0000000DiMz';
5
6ConnectApi.CommentInput input = new ConnectApi.CommentInput();
7ConnectApi.MessageBodyInput messageInput = new ConnectApi.MessageBodyInput();
8ConnectApi.TextSegmentInput textSegment;
9ConnectApi.MentionSegmentInput mentionSegment;
10ConnectApi.MarkupBeginSegmentInput markupBeginSegment;
11ConnectApi.MarkupEndSegmentInput markupEndSegment;
12ConnectApi.InlineImageSegmentInput inlineImageSegment;
13
14messageInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
15
16
17markupBeginSegment = new ConnectApi.MarkupBeginSegmentInput();
18markupBeginSegment.markupType = ConnectApi.MarkupType.Bold;
19messageInput.messageSegments.add(markupBeginSegment);
20
21textSegment = new ConnectApi.TextSegmentInput();
22textSegment.text = 'Hello ';
23messageInput.messageSegments.add(textSegment);
24
25mentionSegment = new ConnectApi.MentionSegmentInput();
26mentionSegment.id = mentionedUserId;
27messageInput.messageSegments.add(mentionSegment);
28
29textSegment = new ConnectApi.TextSegmentInput();
30textSegment.text = '!';
31messageInput.messageSegments.add(textSegment);
32
33markupEndSegment = new ConnectApi.MarkupEndSegmentInput();
34markupEndSegment.markupType = ConnectApi.MarkupType.Bold;
35messageInput.messageSegments.add(markupEndSegment);
36
37inlineImageSegment = new ConnectApi.InlineImageSegmentInput();
38inlineImageSegment.altText = 'image one';
39inlineImageSegment.fileId = imageId;
40messageInput.messageSegments.add(inlineImageSegment);
41
42input.body = messageInput;
43
44ConnectApi.ChatterFeeds.postCommentToFeedElement(communityId, feedElementId, input, null);コードブロックを含むリッチテキストコメントの投稿の例
1String communityId = null;
2String feedElementId = '0D5R0000000SBEr';
3String codeSnippet = '<html>\n\t<body>\n\t\tHello, world!\n\t</body>\n</html>';
4
5ConnectApi.CommentInput input = new ConnectApi.CommentInput();
6ConnectApi.MessageBodyInput messageInput = new ConnectApi.MessageBodyInput();
7ConnectApi.TextSegmentInput textSegment;
8ConnectApi.MarkupBeginSegmentInput markupBeginSegment;
9ConnectApi.MarkupEndSegmentInput markupEndSegment;
10
11messageInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
12
13markupBeginSegment = new ConnectApi.MarkupBeginSegmentInput();
14markupBeginSegment.markupType = ConnectApi.MarkupType.Code;
15messageInput.messageSegments.add(markupBeginSegment);
16
17textSegment = new ConnectApi.TextSegmentInput();
18textSegment.text = codeSnippet;
19messageInput.messageSegments.add(textSegment);
20
21markupEndSegment = new ConnectApi.MarkupEndSegmentInput();
22markupEndSegment.markupType = ConnectApi.MarkupType.Code;
23messageInput.messageSegments.add(markupEndSegment);
24
25input.body = messageInput;
26
27ConnectApi.ChatterFeeds.postCommentToFeedElement(communityId, feedElementId, input, null);postFeedElement(communityId, subjectId, feedElementType, text)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement postFeedElement(String communityId, String subjectId, ConnectApi.FeedElementType feedElementType, String text)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- このフィード要素が投稿された親の ID。この値は、ユーザー、グループ、レコードの ID、またはコンテキストユーザーを示す文字列 me になります。
- feedElementType
- 型: ConnectApi.FeedElementType
- 使用可能な値は FeedItem のみです。
- text
- 型: String
- フィード要素のテキスト。フィード要素には 10,000 文字まで使用できます。
戻り値
例
1ConnectApi.FeedElement feedElement = ConnectApi.ChatterFeeds.postFeedElement(Network.getNetworkId(), '0F9d0000000TreH', ConnectApi.FeedElementType.FeedItem, 'On vacation this week.');postFeedElement(communityId, feedElement)
リッチテキストフィード要素を投稿します。メンションやハッシュタグトピックを含めたり、すでにアップロードされているファイルをフィード要素に添付したり、アクションリンクグループとフィード要素を関連付けたりします。また、このメソッドを使用して、フィード要素の共有やコメントの追加を行うこともできます。
API バージョン
36.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement postFeedElement(String communityId, ConnectApi.FeedElementInput feedElement)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElement
- 型: ConnectApi.FeedElementInput
- メンションなどのリッチテキストを指定します。必要に応じて、リンク、アンケート、または最大 10 個の既存のファイルを指定します。
戻り値
メンションを含むフィード要素の投稿の例
メンションを含むフィード要素を投稿する方法は 2 つあります。GitHub の ConnectApiHelper リポジトリを使用して 1 行のコードを記述するか、次のメソッド例を使用します。
1ConnectApi.FeedItemInput feedItemInput = new ConnectApi.FeedItemInput();
2ConnectApi.MentionSegmentInput mentionSegmentInput = new ConnectApi.MentionSegmentInput();
3ConnectApi.MessageBodyInput messageBodyInput = new ConnectApi.MessageBodyInput();
4ConnectApi.TextSegmentInput textSegmentInput = new ConnectApi.TextSegmentInput();
5
6messageBodyInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
7
8mentionSegmentInput.id = '005RR000000Dme9';
9messageBodyInput.messageSegments.add(mentionSegmentInput);
10
11textSegmentInput.text = 'Could you take a look?';
12messageBodyInput.messageSegments.add(textSegmentInput);
13
14feedItemInput.body = messageBodyInput;
15feedItemInput.feedElementType = ConnectApi.FeedElementType.FeedItem;
16feedItemInput.subjectId = '0F9RR0000004CPw';
17
18ConnectApi.FeedElement feedElement = ConnectApi.ChatterFeeds.postFeedElement(Network.getNetworkId(), feedItemInput);既存のコンテンツが添付されたフィード要素の投稿の例
1// Define the FeedItemInput object to pass to postFeedElement
2ConnectApi.FeedItemInput feedItemInput = new ConnectApi.FeedItemInput();
3feedItemInput.subjectId = 'me';
4
5ConnectApi.TextSegmentInput textSegmentInput = new ConnectApi.TextSegmentInput();
6textSegmentInput.text = 'Would you please review these docs?';
7
8// The MessageBodyInput object holds the text in the post
9ConnectApi.MessageBodyInput messageBodyInput = new ConnectApi.MessageBodyInput();
10messageBodyInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
11messageBodyInput.messageSegments.add(textSegmentInput);
12feedItemInput.body = messageBodyInput;
13
14// The FeedElementCapabilitiesInput object holds the capabilities of the feed item.
15// For this feed item, we define a files capability to hold the file(s).
16
17List<String> fileIds = new List<String>();
18fileIds.add('069xx00000000QO');
19fileIds.add('069xx00000000QT');
20fileIds.add('069xx00000000Qn');
21fileIds.add('069xx00000000Qi');
22fileIds.add('069xx00000000Qd');
23
24ConnectApi.FilesCapabilityInput filesInput = new ConnectApi.FilesCapabilityInput();
25filesInput.items = new List<ConnectApi.FileIdInput>();
26
27for (String fileId : fileIds) {
28 ConnectApi.FileIdInput idInput = new ConnectApi.FileIdInput();
29 idInput.id = fileId;
30 filesInput.items.add(idInput);
31}
32
33ConnectApi.FeedElementCapabilitiesInput feedElementCapabilitiesInput = new ConnectApi.FeedElementCapabilitiesInput();
34feedElementCapabilitiesInput.files = filesInput;
35
36feedItemInput.capabilities = feedElementCapabilitiesInput;
37
38// Post the feed item.
39ConnectApi.FeedElement feedElement = ConnectApi.ChatterFeeds.postFeedElement(Network.getNetworkId(), feedItemInput);インライン画像を含むリッチテキストフィード要素の投稿の例
インライン画像とメンションを含むリッチテキストフィード要素を投稿する方法は 2 つあります。GitHub の ConnectApiHelper リポジトリを使用して 1 行のコードを記述するか、次のメソッド例を使用します。この例の画像ファイルは、Salesforce にアップロード済みの既存のコンテンツです。投稿には、テキストとメンションも含まれます。
1String communityId = null;
2String imageId = '069D00000001INA';
3String mentionedUserId = '005D0000001QNpr';
4String targetUserOrGroupOrRecordId = '005D0000001Gif0';
5ConnectApi.FeedItemInput input = new ConnectApi.FeedItemInput();
6input.subjectId = targetUserOrGroupOrRecordId;
7input.feedElementType = ConnectApi.FeedElementType.FeedItem;
8
9ConnectApi.MessageBodyInput messageInput = new ConnectApi.MessageBodyInput();
10ConnectApi.TextSegmentInput textSegment;
11ConnectApi.MentionSegmentInput mentionSegment;
12ConnectApi.MarkupBeginSegmentInput markupBeginSegment;
13ConnectApi.MarkupEndSegmentInput markupEndSegment;
14ConnectApi.InlineImageSegmentInput inlineImageSegment;
15
16messageInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
17
18markupBeginSegment = new ConnectApi.MarkupBeginSegmentInput();
19markupBeginSegment.markupType = ConnectApi.MarkupType.Bold;
20messageInput.messageSegments.add(markupBeginSegment);
21
22textSegment = new ConnectApi.TextSegmentInput();
23textSegment.text = 'Hello ';
24messageInput.messageSegments.add(textSegment);
25
26mentionSegment = new ConnectApi.MentionSegmentInput();
27mentionSegment.id = mentionedUserId;
28messageInput.messageSegments.add(mentionSegment);
29
30textSegment = new ConnectApi.TextSegmentInput();
31textSegment.text = '!';
32messageInput.messageSegments.add(textSegment);
33
34markupEndSegment = new ConnectApi.MarkupEndSegmentInput();
35markupEndSegment.markupType = ConnectApi.MarkupType.Bold;
36messageInput.messageSegments.add(markupEndSegment);
37
38inlineImageSegment = new ConnectApi.InlineImageSegmentInput();
39inlineImageSegment.altText = 'image one';
40inlineImageSegment.fileId = imageId;
41messageInput.messageSegments.add(inlineImageSegment);
42
43input.body = messageInput;
44
45ConnectApi.ChatterFeeds.postFeedElement(communityId, input);コードブロックを含むリッチテキストフィード要素の投稿の例
1String communityId = null;
2String targetUserOrGroupOrRecordId = 'me';
3String codeSnippet = '<html>\n\t<body>\n\t\tHello, world!\n\t</body>\n</html>';
4ConnectApi.FeedItemInput input = new ConnectApi.FeedItemInput();
5input.subjectId = targetUserOrGroupOrRecordId;
6input.feedElementType = ConnectApi.FeedElementType.FeedItem;
7
8ConnectApi.MessageBodyInput messageInput = new ConnectApi.MessageBodyInput();
9ConnectApi.TextSegmentInput textSegment;
10ConnectApi.MarkupBeginSegmentInput markupBeginSegment;
11ConnectApi.MarkupEndSegmentInput markupEndSegment;
12
13messageInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
14
15markupBeginSegment = new ConnectApi.MarkupBeginSegmentInput();
16markupBeginSegment.markupType = ConnectApi.MarkupType.Code;
17messageInput.messageSegments.add(markupBeginSegment);
18
19textSegment = new ConnectApi.TextSegmentInput();
20textSegment.text = codeSnippet;
21messageInput.messageSegments.add(textSegment);
22
23markupEndSegment = new ConnectApi.MarkupEndSegmentInput();
24markupEndSegment.markupType = ConnectApi.MarkupType.Code;
25messageInput.messageSegments.add(markupEndSegment);
26
27input.body = messageInput;
28
29ConnectApi.ChatterFeeds.postFeedElement(communityId, input);フィード要素の共有の例 (バージョン 39.0 以降)
1// Define the FeedItemInput object to pass to postFeedElement
2ConnectApi.FeedItemInput feedItemInput = new ConnectApi.FeedItemInput();
3feedItemInput.subjectId = 'me';
4ConnectApi.TextSegmentInput textSegmentInput = new ConnectApi.TextSegmentInput();
5textSegmentInput.text = 'Look at this post I'm sharing.';
6// The MessageBodyInput object holds the text in the post
7ConnectApi.MessageBodyInput messageBodyInput = new ConnectApi.MessageBodyInput();
8messageBodyInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
9messageBodyInput.messageSegments.add(textSegmentInput);
10feedItemInput.body = messageBodyInput;
11
12ConnectApi.FeedEntityShareCapabilityInput shareInput = new ConnectApi.FeedEntityShareCapabilityInput();
13shareInput.feedEntityId = '0D5R0000000SEbc';
14ConnectApi.FeedElementCapabilitiesInput feedElementCapabilitiesInput = new
15ConnectApi.FeedElementCapabilitiesInput();
16feedElementCapabilitiesInput.feedEntityShare = shareInput;
17feedItemInput.capabilities = feedElementCapabilitiesInput;
18// Post the feed item.
19ConnectApi.FeedElement feedElement =
20ConnectApi.ChatterFeeds.postFeedElement(Network.getNetworkId(), feedItemInput);ダイレクトメッセージを送信する例
1// Define the FeedItemInput object to pass to postFeedElement
2ConnectApi.FeedItemInput feedItemInput = new ConnectApi.FeedItemInput();
3
4ConnectApi.TextSegmentInput textSegmentInput = new ConnectApi.TextSegmentInput();
5textSegmentInput.text = 'Thanks for attending my presentation test run this morning. Send me any feedback.';
6
7// The MessageBodyInput object holds the text in the post
8ConnectApi.MessageBodyInput messageBodyInput = new ConnectApi.MessageBodyInput();
9messageBodyInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
10messageBodyInput.messageSegments.add(textSegmentInput);
11feedItemInput.body = messageBodyInput;
12
13// The FeedElementCapabilitiesInput object holds the capabilities of the feed item.
14// For this feed item, we define a direct message capability to hold the member(s) and the subject.
15
16List<String> memberIds = new List<String>();
17memberIds.add('005B00000016OUQ');
18memberIds.add('005B0000001rIN6');
19
20ConnectApi.DirectMessageCapabilityInput dmInput = new ConnectApi.DirectMessageCapabilityInput();
21dmInput.subject = 'Thank you!';
22dmInput.membersToAdd = memberIds;
23
24ConnectApi.FeedElementCapabilitiesInput feedElementCapabilitiesInput = new ConnectApi.FeedElementCapabilitiesInput();
25feedElementCapabilitiesInput.directMessage = dmInput;
26
27feedItemInput.capabilities = feedElementCapabilitiesInput;
28
29// Post the feed item.
30ConnectApi.FeedElement feedElement = ConnectApi.ChatterFeeds.postFeedElement(Network.getNetworkId(), feedItemInput);postFeedElementBatch(communityId, feedElements)
API バージョン
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BatchResult[] postFeedElementBatch(String communityId, List<ConnectApi.BatchInput> feedElements)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElements
- 型: List<ConnectApi.BatchInput>
- リストには最大 500 個の ConnectApi.BatchInput オブジェクトを含めることができます。ConnectApi.BatchInput コンストラクターでは、入力オブジェクトは ConnectApi.FeedElementInput 抽象クラスの具象インスタンスである必要があります。
戻り値
ConnectApi.BatchResult.getResult() メソッドは ConnectApi.FeedElement オブジェクトを返します。
返されるオブジェクトは、各入力オブジェクトに対応し、入力オブジェクトと同じ順序で返されます。
メソッドコールは、操作全体に影響を与えるエラー (解析エラーなど) が発生した場合にのみ失敗します。個々のオブジェクトでエラーが発生した場合、エラーは ConnectApi.BatchResult リスト内に埋め込まれます。
使用方法
このメソッドを使用すると、フィード要素のリストを効率よく投稿できます。最大 500 オブジェクトを含むリストを作成し、1 つの DML ステートメントでそのすべてを挿入します。
バージョン 36.0 以降では、投稿ごとにアップロード済みのファイルを 1 つだけ添付できます��ConnectApi.BatchInput クラスには 3 つのコンストラクターがありますが、バージョン 35.0 以降の場合、postFeedElementBatch メソッドでサポートされるのは ConnectApi.BatchInput(Object input) のみです。このコンストラクターでは、バイナリ入力はサポートされません。
バージョン 32.0 ～ 35.0 では、このメソッドで ConnectApi.BatchInput(Object input) および ConnectApi.BatchInput(Object input, ConnectApi.BinaryInput binary) コンストラクターの両方がサポートされます。ConnectApi.BatchInput(Object input, ConnectApi.BinaryInput binary) コンストラクターには、1 つのバイナリ入力しか使用できません。
各コンストラクターで、入力オブジェクトは ConnectApi.FeedElementInput のインスタンスである必要があります。
例
このトリガーは、新たに挿入された取引先のフィードに一括投稿します。
1trigger postFeedItemToAccount on Account (after insert) {
2 Account[] accounts = Trigger.new;
3
4 // Bulk post to the account feeds.
5
6 List<ConnectApi.BatchInput> batchInputs = new List<ConnectApi.BatchInput>();
7
8 for (Account a : accounts) {
9 ConnectApi.FeedItemInput input = new ConnectApi.FeedItemInput();
10
11 input.subjectId = a.id;
12
13 ConnectApi.MessageBodyInput body = new ConnectApi.MessageBodyInput();
14 body.messageSegments = new List<ConnectApi.MessageSegmentInput>();
15
16 ConnectApi.TextSegmentInput textSegment = new ConnectApi.TextSegmentInput();
17 textSegment.text = 'Let\'s win the ' + a.name + ' account.';
18
19 body.messageSegments.add(textSegment);
20 input.body = body;
21
22 ConnectApi.BatchInput batchInput = new ConnectApi.BatchInput(input);
23 batchInputs.add(batchInput);
24 }
25
26 ConnectApi.ChatterFeeds.postFeedElementBatch(Network.getNetworkId(), batchInputs);
27}publishDraftFeedElement(communityId, feedElementId, feedElement)
API バージョン
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement publishDraftFeedElement(String communityId, String feedElementId, ConnectApi.FeedElementInput feedElement)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- 公開するフィード要素の ID。
- feedElement
- 型: ConnectApi.FeedElementInput
- この省略可能なパラメーターを使用して、公開前にドラフトを編集します。
searchFeedElements(communityId, q)
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q)
パラメーター
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElements(communityId, q, sortParam)
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並べ替えます。
- LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElements(communityId, q, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, Boolean threadedCommentsCollapsed)
パラメーター
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElements(communityId, q, pageParam, pageSize)
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, String pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElements(communityId, q, pageParam, pageSize, sortParam)
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElements(communityId, q, pageParam, pageSize, threadedCommentsCollapsed)
API バージョン
44.0
ゲストユーザーが使用可能
44.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, String pageParam, Integer pageSize, Boolean threadedCommentsCollapsed)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElements(communityId, q, recentCommentCount, pageParam, pageSize, sortParam)
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElements(String communityId, String q, Integer recentCommentCount, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, q)
Company、DirectMessageModeration、Home、Isolated、Moderation、および PendingReview フィードから検索条件に一致するフィード要素を取得します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、Isolated、Moderation、および PendingReview です。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, pageParam, pageSize, sortParam, q)
Company、DirectMessageModeration、Home、Isolated、Moderation、および PendingReview フィードから検索条件に一致するフィード要素を並べ替えたページを取得します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、Isolated、Moderation、および PendingReview です。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q)
Company、DirectMessageModeration、Home、Isolated、Moderation、および PendingReview フィードから検索条件に一致するフィード要素を並べ替えたページを取得します。各フィード要素には、指定された数以内のコメント数が含まれます。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q, filter)
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedFilter filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サ���トの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は Home のみです。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
sortParam が MostViewed の場合、pageParam に null を渡す必要があります。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
sortParam が MostViewed の場合、pageSize の値は 1 ～ 25 である必要があります。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並べ替えます。
- LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, subjectId, q)
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、Streams、および Topics を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, q)
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、Streams、および Topics を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 検索語。ユーザー名またはグループ名でキーワードを検索します。1 文字以上を指定する必要があります。このパラメーターではワイルドカードは使用できません。このパラメーターは必須です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q)
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、Streams、および Topics を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, filter)
API バージョン
35.0
ゲストユーザーが使用可能
35.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedFilter filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.UserProfile である必要があります。
- subjectId
- 型: String
- ユーザーの ID。コンテキストユーザーを指定するには、ユーザー ID または別名 me を使用します。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- コンテキストユーザーに表示されるフィード要素に含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped である必要があります。Experience Cloud サイトを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのサイトで常に表示されるフィード要素は除外されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, customFilter)
API バージョン
40.0
ゲストユーザーが使用可能
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, String customFilter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新���非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- コンテキストユーザーに表示されるフィード要素に含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly)
レコードまたはユーザーのフィードから検索条件に一致するフィード要素を並べ替えたページを取得します。各フィード要素には、指定された数以内のコメント数が含まれます。内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード要素を返すかどうかを指定します。
API バージョン
31.0
ゲストユーザーが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, Boolean showInternalOnly)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, filter)
レコードまたはユーザーのフィードから検索条件に一致するフィード要素を並べ替え、絞り込んだページを取得します。各フィード要素には、指定された数以内のコメント数が含まれます。内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード要素を返すかどうかを指定します。
API バージョン
32.0
ゲストユーザーが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, Boolean showInternalOnly, ConnectApi.FeedFilter filter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。���フォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, customFilter)
API バージョン
40.0
ゲストユーザーが使用可能
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, Boolean showInternalOnly, String customFilter)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレ��ード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, q)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, q)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, q)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchStreams(communityId, q)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStreamPage searchStreams(String communityId, String q)
パラメーター
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchStreams(communityId, q, sortParam)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStreamPage searchStreams(String communityId, String q, ConnectApi.SortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- sortParam
- 型: ConnectApi.SortOrder
-
並べ替え順を指定します。値は次のとおりです。
- Ascending — 項目はアルファベットの昇順 (A ～ Z) で並べられる。
- Descending — 項目はアルファベットの降順 (Z ～ A) で並べられる。
- MostRecentlyViewed — 項目は、最近参照されたものから順番に並べられる。この並べ替え順は、Chatter フィードストリームでのみ有効です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchStreams(communityId, q, pageParam, pageSize)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStreamPage searchStreams(String communityId, String q, Integer pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: Integer
- 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。デフォルトサイズは 25 です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchStreams(communityId, q, pageParam, pageSize, sortParam)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStreamPage searchStreams(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定し���す。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: Integer
- 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。デフォルトサイズは 25 です。
- sortParam
- 型: ConnectApi.SortOrder
-
並べ替え順を指定します。値は次のとおりです。
- Ascending — 項目はアルファベットの昇順 (A ～ Z) で並べられる。
- Descending — 項目はアルファベットの降順 (Z ～ A) で並べられる。
- MostRecentlyViewed — 項目は、最近参照されたものから順番に並べられる。この並べ替え順は、Chatter フィードストリームでのみ有効です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchStreams(communityId, q, pageParam, pageSize, sortParam, globalScope)
API バージョン
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStreamPage searchStreams(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam, Boolean globalScope)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: Integer
- 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。デフォルトサイズは 25 です。
- sortParam
- 型: ConnectApi.SortOrder
-
並べ替え順を指定します。値は次のとおりです。
- Ascending — 項目はアルファベットの昇順 (A ～ Z) で並べられる。
- Descending — 項目はアルファベットの降順 (Z ～ A) で並べられる。
- MostRecentlyViewed — 項目は、最近参照されたものから順番に並べられる。この並べ替え順は、Chatter フィードストリームでのみ有効です。
- globalScope
- 型: Boolean
- communityId 値に関係なく、すべてのコンテキストユーザーの Experience Cloud サイトからのストリームを取得するかどうかを指定します。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
setCommentIsVerified(communityId, commentId, isVerified)
API バージョン
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.VerifiedCapability setCommentIsVerified(String communityId, String commentId, Boolean isVerified)
パラメーター
setCommentIsVerifiedByAnonymized(communityId, commentId, isVerified, isVerifiedByAnonymized)
API バージョン
43.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.VerifiedCapability setCommentIsVerifiedByAnonymized(String communityId, String commentId, Boolean isVerified, Boolean isVerifiedByAnonymized)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- commentId
- 型: String
- 質問の投稿に対するコメントの ID。検証済みとマークできるのは、質問の投稿の 1 つのコメントのみです。
- isVerified
- 型: Boolean
- コメントを検証済み (true) または未検証 (false) とマークするように指定します。
未検証とマークできるのは検証済みのコメントのみで、検証済みとマークできるのは未検証のコメントのみです。
- isVerifiedByAnonymized
- 型: Boolean
- コメントを匿名ユーザーによって検証済み (true) とマークするかどうかを指定します。
以前にコメントを検証したユーザーが活動の削除を要求した場合、isVerifiedByAnonymized を使用して検証を維持し、lastVerifiedByUser の値を匿名化します。
isVerified と isVerifiedByAnonymized を同時に true に設定することはできません。isVerifiedByAnonymized を true に設定できるのは、isVerified がすでに true に設定されている場合に限られます。
isVerifiedByAnonymized を false に設定することはできません。true に設定された isVerifiedByAnonymized は、別のユーザーがコメントを未検証とマークしてからコメントを再検証した場合にのみ元に戻すことができます。
setCommentVote(communityId, commentId, upDownVote)
API バージョン
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.UpDownVoteCapability setCommentVote(String communityId, String commentId, ConnectApi.UpDownVoteCapabilityInput upDownVote)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- commentId
- 型: String
- コメントの ID。
- upDownVote
- 型: ConnectApi.UpDownVoteCapabilityInput
- 各自の投票を含む ConnectApi.UpDownVoteCapabilityInput オブジェクト。
戻り値
型: ConnectApi.UpDownVoteCapability
コメントがこの機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
setFeedCommentStatus(communityId, commentId, status)
API バージョン
38.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.StatusCapability setFeedCommentStatus(String communityId, String commentId, ConnectApi.StatusCapabilityInput status)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- commentId
- 型: String
- コメントの ID。
- status
- 型: ConnectApi.StatusCapabilityInput
- 設定する状況が含まれる ConnectApi.StatusCapabilityInput オブジェクト。
使用方法
フィード投稿またはコメントの状況を設定できるのは、「フィード投稿とコメントの承認」権限のあるユーザーのみです。
setFeedElementIsClosed(communityId, feedElementId, isClosed)
ユーザーはクローズされたフィード要素を編集 (具体的にはフィード項目本文またはタイトル) または削除したり、クローズされたフィード要素にコメントしたりできません。クローズされたフィード要素がアンケートの場合、ユーザーはそのアンケートに投票できません。ユーザーはクローズされたフィード要素へのコメントを編集 (具体的にはコメント本文) または削除できません。また、そのコメントを最良の回答として選択したり、最良の解答状況を削除したりできません。
システム管理者とモデレーターは、クローズされたフィード要素の編集、削除、コメントができます。システム管理者とモデレーターは、クローズされたフィード要素に対するコメントの最良の回答状況を選択または削除できます。
API バージョン
43.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CloseCapability setFeedElementIsClosed(String communityId, String feedElementId, Boolean isClosed)
パラメーター
setFeedElementVote(communityId, feedElementId, upDownVote)
API バージョン
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.UpDownVoteCapability setFeedElementVote(String communityId, String feedElementId, ConnectApi.UpDownVoteCapabilityInput upDownVote)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- upDownVote
- 型: ConnectApi.UpDownVoteCapabilityInput
- 各自の投票を含む ConnectApi.UpDownVoteCapabilityInput オブジェクト。
戻り値
型: ConnectApi.UpDownVoteCapability
フィード要素がこの機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
setFeedEntityStatus(communityId, feedElementId, status)
API バージョン
37.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.StatusCapability setFeedEntityStatus(String communityId, String feedElementId, ConnectApi.StatusCapabilityInput status)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- status
- 型: ConnectApi.StatusCapabilityInput
- 設定する状況が含まれる ConnectApi.StatusCapabilityInput オブジェクト。
使用方法
フィード投稿またはコメントの状況を設定できるのは、「フィード投稿とコメントの承認」権限のあるユーザーのみです。
setIsMutedByMe(communityId, feedElementId, isMutedByMe)
API バージョン
35.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.MuteCapability setIsMutedByMe(String communityId, String feedElementId, Boolean isMutedByMe)
パラメーター
setIsReadByMe(communityId, feedElementId, readBy)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ReadByCapability setIsReadByMe(String communityId, String feedElementId, ConnectApi.ReadByCapabilityInput readBy)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- 既読としてマークするフィード要素の ID。
- readBy
- 型: ConnectApi.ReadByCapabilityInput
- フィード要素を既読としてマークすることを示す ConnectApi.ReadByCapabilityInput ボディ。
setIsReadByMe(communityId, feedElementId, isReadByMe)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ReadByCapability setIsReadByMe(String communityId, String feedElementId, Boolean isReadByMe)
パラメーター
updateComment(communityId, commentId, comment)
API バージョン
34.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Comment updateComment(String communityId, String commentId, ConnectApi.CommentInput comment)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- commentId
- 型: String
- 編集するコメントの ID。
- comment
- 型: ConnectApi.CommentInput
- 編集するコメントに関する情報。
例
1String commentId;
2String communityId = Network.getNetworkId();
3
4// Get the last feed item created by the context user.
5List<FeedItem> feedItems = [SELECT Id FROM FeedItem WHERE CreatedById = :UserInfo.getUserId() ORDER BY CreatedDate DESC];
6if (feedItems.isEmpty()) {
7 // Return null within anonymous apex.
8 return null;
9}
10String feedElementId = feedItems[0].id;
11
12ConnectApi.CommentPage commentPage = ConnectApi.ChatterFeeds.getCommentsForFeedElement(communityId, feedElementId);
13if (commentPage.items.isEmpty()) {
14 // Return null within anonymous apex.
15 return null;
16}
17commentId = commentPage.items[0].id;
18
19ConnectApi.FeedEntityIsEditable isEditable = ConnectApi.ChatterFeeds.isCommentEditableByMe(communityId, commentId);
20
21if (isEditable.isEditableByMe == true){
22 ConnectApi.CommentInput commentInput = new ConnectApi.CommentInput();
23 ConnectApi.MessageBodyInput messageBodyInput = new ConnectApi.MessageBodyInput();
24 ConnectApi.TextSegmentInput textSegmentInput = new ConnectApi.TextSegmentInput();
25
26 messageBodyInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
27
28 textSegmentInput.text = 'This is my edited comment.';
29 messageBodyInput.messageSegments.add(textSegmentInput);
30
31 commentInput.body = messageBodyInput;
32
33 ConnectApi.Comment editedComment = ConnectApi.ChatterFeeds.updateComment(communityId, commentId, commentInput);
34}updateDirectMessage(communityId, feedElementId, directMessage)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.DirectMessageCapability updateDirectMessage(String communityId, String feedElementId, ConnectApi.DirectMessageCapabilityInput directMessage)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- directMessage
- 型: ConnectApi.DirectMessageCapabilityInput
- 追加や削除を行うメンバーが含まれる ConnectApi.DirectMessageCapabilityInput ボディ。
戻り値
型: ConnectApi.DirectMessageCapability
フィード要素がこの機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
updateFeedElement(communityId, feedElementId, feedElement)
API バージョン
34.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement updateFeedElement(String communityId, String feedElementId, ConnectApi.FeedElementInput feedElement)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- 編集するフィード要素の ID。フィード要素の種類のうち、編集可能なのはフィード項目のみです。
- feedElement
- 型: ConnectApi.FeedElementInput
- 編集するフィード項目に関する情報。
フィード投稿を編集する例
1String communityId = Network.getNetworkId();
2
3// Get the last feed item created by the context user.
4List<FeedItem> feedItems = [SELECT Id FROM FeedItem WHERE CreatedById = :UserInfo.getUserId() ORDER BY CreatedDate DESC];
5if (feedItems.isEmpty()) {
6 // Return null within anonymous apex.
7 return null;
8}
9String feedElementId = feedItems[0].id;
10
11ConnectApi.FeedEntityIsEditable isEditable = ConnectApi.ChatterFeeds.isFeedElementEditableByMe(communityId, feedElementId);
12
13if (isEditable.isEditableByMe == true){
14 ConnectApi.FeedItemInput feedItemInput = new ConnectApi.FeedItemInput();
15 ConnectApi.MessageBodyInput messageBodyInput = new ConnectApi.MessageBodyInput();
16 ConnectApi.TextSegmentInput textSegmentInput = new ConnectApi.TextSegmentInput();
17
18 messageBodyInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
19
20 textSegmentInput.text = 'This is my edited post.';
21 messageBodyInput.messageSegments.add(textSegmentInput);
22
23 feedItemInput.body = messageBodyInput;
24
25 ConnectApi.FeedElement editedFeedElement = ConnectApi.ChatterFeeds.updateFeedElement(communityId, feedElementId, feedItemInput);
26}質問のタイトルと投稿を編集する例
1String communityId = Network.getNetworkId();
2
3// Get the last feed item created by the context user.
4List<FeedItem> feedItems = [SELECT Id FROM FeedItem WHERE CreatedById = :UserInfo.getUserId() ORDER BY CreatedDate DESC];
5if (feedItems.isEmpty()) {
6 // Return null within anonymous apex.
7 return null;
8}
9String feedElementId = feedItems[0].id;
10
11ConnectApi.FeedEntityIsEditable isEditable = ConnectApi.ChatterFeeds.isFeedElementEditableByMe(communityId, feedElementId);
12
13if (isEditable.isEditableByMe == true){
14
15 ConnectApi.FeedItemInput feedItemInput = new ConnectApi.FeedItemInput();
16 ConnectApi.FeedElementCapabilitiesInput feedElementCapabilitiesInput = new ConnectApi.FeedElementCapabilitiesInput();
17 ConnectApi.QuestionAndAnswersCapabilityInput questionAndAnswersCapabilityInput = new ConnectApi.QuestionAndAnswersCapabilityInput();
18 ConnectApi.MessageBodyInput messageBodyInput = new ConnectApi.MessageBodyInput();
19 ConnectApi.TextSegmentInput textSegmentInput = new ConnectApi.TextSegmentInput();
20
21 messageBodyInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
22
23 textSegmentInput.text = 'This is my edited question.';
24 messageBodyInput.messageSegments.add(textSegmentInput);
25
26 feedItemInput.body = messageBodyInput;
27 feedItemInput.capabilities = feedElementCapabilitiesInput;
28
29 feedElementCapabilitiesInput.questionAndAnswers = questionAndAnswersCapabilityInput;
30 questionAndAnswersCapabilityInput.questionTitle = 'Where is my edited question?';
31
32 ConnectApi.FeedElement editedFeedElement = ConnectApi.ChatterFeeds.updateFeedElement(communityId, feedElementId, feedItemInput);
33}updateFeedElementBookmarks(communityId, feedElementId, bookmarks)
API バージョン
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BookmarksCapability updateFeedElementBookmarks(String communityId, String feedElementId, ConnectApi.BookmarksCapabilityInput bookmarks)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。
- bookmarks
- 型: ConnectApi.BookmarksCapabilityInput
- ブックマークに関する情報。
戻り値
型: ConnectApi.BookmarksCapability
フィード要素がこの機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
updateFeedElementBookmarks(communityId, feedElementId, isBookmarkedByCurrentUser)
API バージョン
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BookmarksCapability updateFeedElementBookmarks(String communityId, String feedElementId, Boolean isBookmarkedByCurrentUser)
パラメーター
戻り値
型: ConnectApi.BookmarksCapability
フィード要素がこの機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
例
1ConnectApi.BookmarksCapability bookmark = ConnectApi.ChatterFeeds.updateFeedElementBookmarks(null, '0D5D0000000KuGh', true);updateFeedElementReadByCapabilityBatch(communityId, feedElementIds, readBy)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BatchResult[] updateFeedElementReadByCapabilityBatch(String communityId, List<String> feedElementIds, ConnectApi.ReadByCapabilityInput readBy)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementIds
- 型: List<String>
- 既読としてマークするフィード要素の ID (最大 500)。
- readBy
- 型: ConnectApi.ReadByCapabilityInput
- フィード要素を既読としてマークすることを示す ConnectApi.ReadByCapabilityInput ボディ。
戻り値
フィード要素がこの機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
返されるオブジェクトは、各入力オブジェクトに対応し、入力オブジェクトと同じ順序で返されます。
メソッドコールは、操作全体に影響を与えるエラー (解析エラーなど) が発生した場合にのみ失敗します。個々のオブジェクトでエラーが発生した場合、エラーは ConnectApi.BatchResult リスト内に埋め込まれます。
updateFeedElementReadByCapabilityBatch(communityId, feedElementIds, isReadByMe)
API バージョン
40.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BatchResult[] updateFeedElementReadByCapabilityBatch(String communityId, List<String> feedElementIds, Boolean isReadByMe)
パラメーター
updateLikeForComment(communityId, commentId, isLikedByCurrentUser)
API バージョン
39.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLikePage updateLikeForComment(String communityId, String commentId, Boolean isLikedByCurrentUser)
パラメーター
戻り値
updateLikeForFeedElement(communityId, feedElementId, isLikedByCurrentUser)
API バージョン
39.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLikePage updateLikeForFeedElement(String communityId, String feedElementId, Boolean isLikedByCurrentUser)
パラメーター
戻り値
フィード要素が ChatterLikes 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
updatePinnedFeedElements(communityId, feedType, subjectId, pin)
API バージョン
41.0
ゲストユーザーが使用可能
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.PinCapability updatePinnedFeedElements(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.PinCapabilityInput pin)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Record および Topics です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId はグループ ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。
- pin
- 型: ConnectApi.PinCapabilityInput
- 固定または固定解除するフィード要素を示す ConnectApi.PinCapabilityInput オブジェクト。
戻り値
フィードがこの機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
updateStream(communityId, streamId, streamInput)
API バージョン
39.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterStream updateStream(String communityId, String streamId, ConnectApi.ChatterStreamInput streamInput)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- streamId
- 型: String
- Chatter フィードストリームの ID。
- streamInput
- 型: ConnectApi.ChatterStreamInput
- ConnectApi.ChatterStreamInput オブジェクト。
戻り値
voteOnFeedElementPoll(communityId, feedElementId, myChoiceId)
API バージョン
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.PollCapability voteOnFeedElementPoll(String communityId, String feedElementId, String myChoiceId)
パラメーター
例
1ConnectApi.PollCapability poll = ConnectApi.ChatterFeeds.voteOnFeedElementPoll(null, '0D5D0000000XZaUKAW', '09AD000000000TKMAY');ChatterFeeds テストメソッド
ChatterFeeds のテストメソッドを次に示します。すべてのメソッドが静的です。
これらのメソッドを使用して ConnectApi コードをテストする方法の詳細は、「ConnectApi コードのテスト」を参照してください。
setTestGetFeedElementsFromFeed(communityId, feedType, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, pageParam, pageSize, sortParam, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- このパラメーターの有効な値は Company のみです。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, filter, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
32.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は Home のみです。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, filter, threadedCommentsCollapsed, result)
一致する ConnectApi.getFeedElementsFromFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
44.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedFilter filter, Boolean threadedCommentsCollapsed, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は Home のみです。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィード種別。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, showInternalOnly, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, filter, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
35.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.UserProfile である必要があります。
- subjectId
- 型: String
- ユーザーの ID。コンテキストユーザーを指定するには、ユーザー ID または別名 me を使用します。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped である必要があります。Experience Cloud サイトを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのサイトで常に表示されるフィード要素は除外されます。現在、サイトを範囲とするフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, filter, threadedCommentsCollapsed, result)
一致する ConnectApi.getFeedElementsFromFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
44.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedFilter filter, Boolean threadedCommentsCollapsed, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.UserProfile である必要があります。
- subjectId
- 型: String
- ユーザーの ID。コンテキストユーザーを指定するには、ユーザー ID または別名 me を使用します。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped である必要があります。Experience Cloud サイトを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのサイトで常に表示されるフィード要素は除外されます。現在、サイトを範囲とするフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, customFilter, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
40.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String customFilter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されま��。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, filter, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
32.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, filter, threadedCommentsCollapsed, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
44.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, ConnectApi.FeedFilter filter, Boolean threadedCommentsCollapsed, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, customFilter, result)
テストコンテキストの一致するパラメーターで getFeedElementsFromFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
40.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, String customFilter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, customFilter, threadedCommentsCollapsed, result)
一致する ConnectApi.getFeedElementsFromFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
44.0
署名
public static Void setTestGetFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, String customFilter, Boolean threadedCommentsCollapsed, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, result)
一致する getFeedElementsFromFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクト。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, result)
一致する getFeedElementsFromFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブ��ェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, result)
一致する getFeedElementsFromFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsFromFilterFeedUpdatedSince(communityId, subjectId, keyPrefix, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, result)
getFeedElementsFromFilterFeedUpdatedSince メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsFromFilterFeedUpdatedSince(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの変更タイムスタンプと並べ替え順を定義する不透明トークン。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince, result)
テストコンテキストの一致するパラメーターで getFeedElementsUpdatedSince をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince, filter, result)
テストコンテキストの一致するパラメーターで getFeedElementsUpdatedSince をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
32.0
署名
public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, result)
テストコンテキストの一致するパラメーターで getFeedElementsUpdatedSince をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかの値になります。
- Files
- Groups
- News
- People
- Record
- subjectId
- 型: String
- feedType が ConnectApi.Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。それ以外の場合は、コンテキストユーザーまたは別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, showInternalOnly, result)
テストコンテキストの一致するパラメーターで getFeedElementsUpdatedSince をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, filter, result)
テストコンテキストの一致するパラメーターで getFeedElementsUpdatedSince をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
35.0
署名
public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.UserProfile である必要があります。
- subjectId
- 型: String
- ユーザーの ID。コンテキストユーザーを指定するには、ユーザー ID または別名 me を使用します。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの変更タイムスタンプと並べ替え順を定義する不透明トークン。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped である必要があります。Experience Cloud サイトを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのサイトで常に表示されるフィード要素は除外されます。現在、サイトを範囲とするフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, customFilter, result)
テストコンテキストの一致するパラメーターで getFeedElementsUpdatedSince をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
40.0
署名
public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, String customFilter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの変更タイムスタンプと並べ替え順を定義する不透明トークン。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, result)
テストコンテキストの一致するパラメーターで getFeedElementsUpdatedSince をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
31.0
署名
public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, filter, result)
テストコンテキストの一致するパラメーターで getFeedElementsUpdatedSince をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
32.0
署名
public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, customFilter, result)
テストコンテキストの一致するパラメーターで getFeedElementsUpdatedSince をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
40.0
署名
public static Void setTestGetFeedElementsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, Integer elementsPerBundle, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, String customFilter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedElementPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
updatedSince パラメーターは、同じ秒内にコールとして作成されたフィード要素を返しません。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetRelatedPosts(communityId, feedElementId, filter, maxResults, result)
一致する ConnectApi.getRelatedPosts(communityId, feedElementId, filter, maxResults) メソッドをテストコンテキストでコールするときに返される ConnectApi.RelatedFeedPosts オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
37.0
署名
public static Void setTestGetRelatedPosts(String communityId, String feedElementId, ConnectApi.RelatedFeedPostType filter, Integer maxResults, ConnectApi.RelatedFeedPosts result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElementId
- 型: String
- フィード要素の ID。フィード要素は質問である必要があります。
- filter
- 型: ConnectApi.RelatedFeedPostType
- 関連フィード投稿の種別を指定します。値は次のとおりです。
- Answered — 1 つ以上の回答がある関連質問。
- BestAnswer — 最良の回答がある関連質問。
- Generic — 回答がある関連質問、最良の回答がある関連質問、回答がない関連質問を含む、すべての種別の関連質問。
- Unanswered — 回答がない関連質問。
- maxResults
- 型: Integer
- 返す結果の最大数。最大 25 件の結果を返すことができます。デフォルト値は 5 です。
- result
- 型: ConnectApi.RelatedFeedPosts
- テストデータを含むオブジェクト。
バージョン 37.0 以降では、関連するフィード投稿は質問です。
戻り値
型: Void
setTestGetTopUnansweredQuestions(communityId, result) (パイロット)
一致する ConnectApi.getTopUnansweredQuestions メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
42.0
署名
public static Void setTestGetTopUnansweredQuestions(String communityId, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetTopUnansweredQuestions(communityId, filter, result) (パイロット)
一致する ConnectApi.getTopUnansweredQuestions メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
42.0
署名
public static Void setTestGetTopUnansweredQuestions(String communityId, ConnectApi.TopUnansweredQuestionsFilterType filter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID。
- filter
- 型: ConnectApi.FeedFilter
- フィードの検索条件を指定します。有効な値は UnansweredQuestionsWithCandidateAnswers のみです。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetTopUnansweredQuestions(communityId, pageSize, result) (パイロット)
一致する ConnectApi.getTopUnansweredQuestions メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
42.0
署名
public static Void setTestGetTopUnansweredQuestions(String communityId, Integer pageSize, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 0 ～ 10 です。null を渡すと、デフォルトサイズの 5 に設定されます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetTopUnansweredQuestions(communityId, filter, pageSize, result) (パイロット)
一致する ConnectApi.getTopUnansweredQuestions メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
42.0
署名
public static Void setTestGetTopUnansweredQuestions(String communityId, ConnectApi.FeedFilter filter, Integer pageSize, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID。
- filter
- 型: ConnectApi.FeedFilter
- フィードの検索条件を指定します。有効な値は UnansweredQuestionsWithCandidateAnswers のみです。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 0 ～ 10 です。null を渡すと、デフォルトサイズの 5 に設定されます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElements(communityId, q, result)
一致する ConnectApi.searchFeedElements メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElements(String communityId, String q, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElements(communityId, q, sortParam, result)
一致する ConnectApi.searchFeedElements メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElements(String communityId, String q, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並べ替えます。
- LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElements(communityId, q, threadedCommentsCollapsed, result)
一致する ConnectApi.searchFeedElements メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
44.0
署名
public static Void setTestSearchFeedElements(String communityId, String q, Boolean threadedCommentsCollapsed, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElements(communityId, q, pageParam, pageSize, result)
一致する ConnectApi.searchFeedElements メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElements(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElements(communityId, q, pageParam, pageSize, sortParam, result)
一致する ConnectApi.searchFeedElements メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElements(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElements(communityId, q, pageParam, pageSize, threadedCommentsCollapsed, result)
一致する ConnectApi.searchFeedElements メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
44.0
署名
public static Void setTestSearchFeedElements(String communityId, String q, String pageParam, Integer pageSize, Boolean threadedCommentsCollapsed, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- threadedCommentsCollapsed
- 型: Boolean
- 折りたたまれたスタイルでスレッドコメントを返すか (true)、否か (false) を指定します。null を渡すと、デフォルトの false に設定されます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElements(communityId, q, recentCommentCount, pageParam, pageSize, sortParam, result)
一致する ConnectApi.searchFeedElements メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElements(String communityId, String q, Integer recentCommentCount, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, q, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String q, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- ���: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、Isolated、Moderation、および PendingReview です。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、Isolated、Moderation、および PendingReview です。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q, filter, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
32.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は Home のみです。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, q, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String q, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、Streams、および Topics を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。フィード種別が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値である場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、Streams、および Topics を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 検索語。ユーザー名またはグループ名でキーワードを検索します。1 文字以上を指定する必要があります。このパラメーターではワイルドカードは使用できません。このパラメーターは必須です。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、Streams、および Topics を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, filter, result)
テストコンテキストの一致するパラメーターで searchFeedElementsInFeed をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
35.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.UserProfile である必要があります。
- subjectId
- 型: String
- ユーザーの ID。コンテキストユーザーを指定するには、ユーザー ID または別名 me を使用します。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- コンテキストユーザーに表示されるフィード要素に含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped である必要があります。Experience Cloud サイトを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのサイトで常に表示されるフィード要素は除外されます。現在、サイトを範囲とするフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, customFilter, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
40.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, String customFilter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- コンテキストユーザーに表示されるフィード要素に含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, Boolean showInternalOnly, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, filter, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
32.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, Boolean showInternalOnly, ConnectApi.FeedFilter filter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザープロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — Experience Cloud サイトを範囲とするフィード要素。現在、これらのフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがサイトを範囲とする可能性があります。すべてのサイトで常に表示されるフィード要素は除外されます。この値は、UserProfile フィードでのみ有効です。
- QuestionsWithCandidateAnswers — 回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- QuestionsWithCandidateAnswersReviewedPublished — レビュー済みまたは公開済みの回答候補がある質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Read — 経過日数が 30 日を超えたか、既読としてマークされたコンテキストユーザーのフィード要素。コンテキストユーザーがグループに参加している場合は既存のフィード要素を含みます。この値は、グループの Record フィードでのみ有効です。
- SolvedQuestions — 質問で最良の回答があるフィード要素。
- UnansweredQuestions — 質問で回答がないフィード要素。
- UnansweredQuestionsWithCandidateAnswers — 回答はないものの回答候補が関連付けられている質問のフィード要素。この値は、「Einstein が生成した回答へのアクセス」権限を持つユーザーのみで有効です。
- Unread — 過去 30 日間に作成された、既読としてマークされていないコンテキストユーザーのフィード要素。この値は、グループの Record フィードでのみ有効です。
- UnsolvedQuestions — 質問で最良の回答がないフィード要素。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, customFilter, result)
一致する ConnectApi.searchFeedElementsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
40.0
署名
public static Void setTestSearchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, Boolean showInternalOnly, String customFilter, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- ケースの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- cusotmFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, q, result)
一致する ConnectApi.searchFeedElementsInFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, String q, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedElementsInFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedElementsInFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedElementsInFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
31.0
署名
public static Void setTestSearchFeedElementsInFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedElementPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchStreams(communityId, q, result)
一致する ConnectApi.searchStream(communityId, q) メソッドをテストコンテキストでコールするときに返される ConnectApi.ChatterStreamPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
40.0
署名
public static Void setTestSearchStreams(String communityId, String q, ConnectApi.ChatterStreamPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.ChatterStreamPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchStreams(communityId, q, sortParam, result)
一致する ConnectApi.searchStream(communityId, q, sortParam) メソッドをテストコンテキストでコールするときに返される ConnectApi.ChatterStreamPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
40.0
署名
public static Void setTestSearchStreams(String communityId, String q, ConnectApi.SortOrder sortParam, ConnectApi.ChatterStreamPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- sortParam
- 型: ConnectApi.SortOrder
-
並べ替え順を指定します。値は次のとおりです。
- Ascending — 項目はアルファベットの昇順 (A ～ Z) で並べられる。
- Descending — 項目はアルファベットの降順 (Z ～ A) で並べられる。
- MostRecentlyViewed — 項目は、最近参照されたものから順番に並べられる。この並べ替え順は、Chatter フィードストリームでのみ有効です。
- result
- 型: ConnectApi.ChatterStreamPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchStreams(communityId, q, pageParam, pageSize, result)
一致する ConnectApi.searchStreams(communityId, q, pageParam, pageSize) メソッドをテストコンテキストでコールするときに返される ConnectApi.ChatterStreamPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
40.0
署名
public static Void setTestSearchStreams(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.ChatterStreamPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: Integer
- 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。デフォルトサイズは 25 です。
- result
- 型: ConnectApi.ChatterStreamPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchStreams(communityId, q, pageParam, pageSize, sortParam, result)
一致する ConnectApi.searchStreams(communityId, q, pageParam, pageSize, sortParam) メソッドをテストコンテキストでコールするときに返される ConnectApi.ChatterStreamPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
40.0
署名
public static Void setTestSearchStreams(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam, ConnectApi.ChatterStreamPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: Integer
- 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。デフォルトサイズは 25 です。
- sortParam
- 型: ConnectApi.SortOrder
-
並べ替え順を指定します。値は次のとおりです。
- Ascending — 項目はアルファベットの昇順 (A ～ Z) で並べられる。
- Descending — 項目はアルファベットの降順 (Z ～ A) で並べられる。
- MostRecentlyViewed — 項目は、最近参照されたものから順番に並べられる。この並べ替え順は、Chatter フィードストリームでのみ有効です。
- result
- 型: ConnectApi.ChatterStreamPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchStreams(communityId, q, pageParam, pageSize, sortParam, globalScope, result)
一致する ConnectApi.searchStreams(communityId, q, pageParam, pageSize, sortParam, globalScope) メソッドをテストコンテキストでコールするときに返される ConnectApi.ChatterStreamPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
41.0
署名
public static Void setTestSearchStreams(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.SortOrder sortParam, Boolean globalScope, ConnectApi.ChatterStreamPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイト��� ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: Integer
- 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 250 です。デフォルトサイズは 25 です。
- sortParam
- 型: ConnectApi.SortOrder
-
並べ替え順を指定します。値は次のとおりです。
- Ascending — 項目はアルファベットの昇順 (A ～ Z) で並べられる。
- Descending — 項目はアルファベットの降順 (Z ～ A) で並べられる。
- MostRecentlyViewed — 項目は、最近参照されたものから順番に並べられる。この並べ替え順は、Chatter フィードストリームでのみ有効です。
- globalScope
- 型: Boolean
- communityId 値に関係なく、すべてのコンテキストユーザーの Experience Cloud サイトからのストリームを取得するかどうかを指定します。
- result
- 型: ConnectApi.ChatterStreamPage
- テストデータを含むオブジェクト。
戻り値
型: Void
廃止された ChatterFeeds のメソッド
廃止された ChatterFeeds のメソッドは次のとおりです。
getCommentsForFeedItem(communityId, feedItemId)
フィード項目のコメントを取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentPage getCommentsForFeedItem(String communityId, String feedItemId)
パラメーター
戻り値
getCommentsForFeedItem(communityId, feedItemId, pageParam, pageSize)
フィード項目のコメントのページを取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentPage getCommentsForFeedItem(String communityId, String feedItemId, String pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedItemId
- 型: String
- フィード項目の ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
戻り値
getFeedItem(communityId, feedItemId)
フィード項目を取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItem getFeedItem(String communityId, String feedItemId)
パラメーター
戻り値
getFeedItemBatch(communityId, feedItemIds)
API バージョン
31.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BatchResult[] getFeedItemBatch(String communityId, List<String> feedItemIds)
パラメーター
戻り値
ConnectApi.BatchResult.getResult() メソッドは、読み込まれなかったフィード項目の ConnectApi.FeedItem オブジェクトとエラーを返します。
例
1// Create a list of feed items.
2ConnectApi.FeedItemPage feedItemPage = ConnectApi.ChatterFeeds.getFeedItemsFromFeed(null, ConnectApi.FeedType.Company);
3System.debug(feedItemPage);
4
5// Create a list of feed item IDs.
6List<String> feedItemIds = new List<String>();
7for (ConnectApi.FeedItem aFeedItem : feedItemPage.items){
8 feedItemIds.add(aFeedItem.id);
9}
10
11// Get info about the feed items in the list.
12ConnectApi.BatchResult[] batchResults = ConnectApi.ChatterFeeds.getFeedItemBatch(null, feedItemIds);
13
14for (ConnectApi.BatchResult batchResult : batchResults) {
15 if (batchResult.isSuccess()) {
16 // Operation was successful.
17 // Print the header for each feed item.
18 ConnectApi.FeedItem aFeedItem;
19 if(batchResult.getResult() instanceof ConnectApi.FeedItem) {
20 aFeedItem = (ConnectApi.FeedItem) batchResult.getResult();
21 }
22 System.debug('SUCCESS');
23 System.debug(aFeedItem.header.text);
24 }
25 else {
26 // Operation failed. Print errors.
27 System.debug('FAILURE');
28 System.debug(batchResult.getErrorMessage());
29 }
30}getFeedItemsFromFeed(communityId, feedType)
Company、Home、および Moderation フィードからフィード項目を取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsFromFeed(communityId, feedType, pageParam, pageSize, sortParam)
Company、Home、および Moderation フィードからフィード項目を並べ替えたページを取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam)
Company、Home、および Moderation フィードからフィード項目を並べ替えたページを取得します。各フィード項目には、指定された数以内のコメント数が含まれます。
API バージョン
29.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsFromFeed(communityId, feedType, subjectId)
ユーザーまたはレコードのフィードからフィード項目を取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsFromFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam)
ユーザーまたはレコードのフィードからフィード項目を並べ替えたページを取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam)
ユーザーまたはレコードのフィードからフィード項目を並べ替えたページを取得します。各フィード項目には、指定された数以内のコメント数が含まれます。
API バージョン
29.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, showInternalOnly)
ユーザーまたはレコードのレコードフィードからフィード項目を並べ替えたページを取得します。各フィード項目には、指定された数以内のコメント数が含まれます。内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード項目を返すかどうかを指定します。
API バージョン
30.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix)
ユーザーのキープレフィックスで絞り込まれたフィードからフィード項目を取得します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix)
パラメーター
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam)
ユーザーのキープレフィックスで絞り込まれたフィードからフィード項目を並べ替えたページを取得します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam)
ユーザーのキープレフィックスで絞り込まれたフィードからフィード項目を並べ替えたページを取得します。各フィード項目には、指定された数以内のコメント数が含まれます。
API バージョン
29.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべ���の更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsFromFilterFeedUpdatedSince(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, updatedSince)
API バージョン
30.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsFromFilterFeedUpdatedSince(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。このトークンを取得するには、getFeedItemsFromFilterFeed をコールし、ConnectApi.FeedItemPage レスポンスボディの updatesToken プロパティの値を取ります。
戻り値
使用方法
このメソッドは、updatedSince 引数で指定された時刻以降に更新されたフィード項目のみを返します。フィード項目は、最後のフィード要求の時刻以降に作成されたか、最後のフィード要求の時刻以降にフィード項目に sort=LastModifiedDateDesc およびコメントが追加された場合、更新されたものとみなされます。いいね! やトピックを追加してもフィード項目は更新されません。
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
getFeedItemsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince)
Company、Home、および Moderation フィードからフィード項目のページを取得します。updatedSince パラメーターで指定された時刻以降に更新されたフィード項目のみが含まれます。各フィード項目には、指定された数以内のコメント数が含まれます。
API バージョン
30.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsUpdatedSince(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedItemPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
戻り値
使用方法
このメソッドは、updatedSince 引数で指定された時刻以降に更新されたフィード項目のみを返します。フィード項目は、最後のフィード要求の時刻以降に作成されたか、最後のフィード要求の時刻以降にフィード項目に sort=LastModifiedDateDesc およびコメントが追加された場合、更新されたものとみなされます。いいね! やトピックを追加してもフィード項目は更新されません。
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
例
この例では、会社フィードのフィード項目を取得し、返されたオブジェクトから updatesToken プロパティを取り込みます。updatesToken の値を getFeedItemsUpdatedSince メソッドに渡し、最初のコール以降に更新されたフィード項目を取得します。
1// Get the feed items in the company feed and return the updatesToken
2String communityId = null;
3
4// Get the feed and extract the update token
5ConnectApi.FeedItemPage page = ConnectApi.ChatterFeeds.getFeedItemsFromFeed(communityId, ConnectApi.FeedType.Company);
6
7// page.updatesToken is opaque and has a value like '2:1384549034000'
8
9// Get the feed items that changed since the provided updatesToken
10ConnectApi.FeedItemPage feedItems= ConnectApi.ChatterFeeds.getFeedItemsUpdatedSince
11 (communityId, ConnectApi.FeedType.Company, 1, ConnectApi.FeedDensity.AllUpdates, null, 1, page.updatesToken);getFeedItemsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince)
Files、Groups、News、People、および Record フィードからフィード項目のページを取得します。updatedSince パラメーターで指定された時刻以降に更新されたフィード項目のみが含まれます。各フィード項目には、指定された数以内のコメント数が含まれます。
API バージョン
30.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかの値になります。
- Files
- Groups
- News
- People
- Record
- subjectId
- 型: String
- feedType が ConnectApi.Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。それ以外の場合は、コンテキストユーザーまたは別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedItemPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
戻り値
使用方法
このメソッドは、updatedSince 引数で指定された時刻以降に更新されたフィード項目のみを返します。フィード項目は、最後のフィード要求の時刻以降に作成されたか、最後のフィード要求の時刻以降にフィード項目に sort=LastModifiedDateDesc およびコメントが追加された場合、更新されたものとみなされます。いいね! やトピックを追加してもフィード項目は更新されません。
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
例
この例では、ニュースフィードのフィード項目を取得し、返されたオブジェクトから updatesToken プロパティを取り込みます。updatesToken の値を getFeedItemsUpdatedSince メソッドに渡し、最初のコール以降に更新されたフィード項目を取得します。
1// Get the feed items in the news feed and return the updatesToken
2String communityId = null;
3String subjectId = 'me';
4
5// Get the feed and extract the update token
6ConnectApi.FeedItemPage page = ConnectApi.ChatterFeeds.getFeedItemsFromFeed(communityId, ConnectApi.FeedType.News, subjectId);
7
8// page.updatesToken is opaque and has a value like '2:1384549034000'
9
10// Get the feed items that changed since the provided updatesToken
11ConnectApi.FeedItemPage feedItems= ConnectApi.ChatterFeeds.getFeedItemsUpdatedSince
12 (communityId, ConnectApi.FeedType.News, subjectId, 1, ConnectApi.FeedDensity.AllUpdates, null, 1, page.updatesToken);getFeedItemsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, showInternalOnly)
レコードフィードからフィード項目のページを取得します。updatedSince パラメーターで指定された時刻以降に更新されたフィード項目のみが含まれます。内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード項目を返すかどうかを指定します。
API バージョン
30.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItemsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedItemPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドは、updatedSince 引数で指定された時刻以降に更新されたフィード項目のみを返します。フィード項目は、最後のフィード要求の時刻以降に作成されたか、最後のフィード要求の時刻以降にフィード項目に sort=LastModifiedDateDesc およびコメントが追加された場合、更新されたものとみなされます。いいね! やトピックを追加してもフィード項目は更新されません。
showInternalOnly が true で、デジタルエクスペリエンスが有効になっている場合、Experience Cloud サイトからのフィード項目が含まれます。それ以外の場合は、内部サイトからのフィード項目のみが含まれます。
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
例
この例では、ニュースフィードのフィード項目を取得し、返されたオブジェクトから updatesToken プロパティを取り込みます。updatesToken の値を getFeedItemsUpdatedSince メソッドに渡し、最初のコール以降に更新されたフィード項目を取得します。
1// Get the feed items in the news feed and return the updatesToken
2String communityId = null;
3String subjectId = 'me';
4
5// Get the feed and extract the update token
6ConnectApi.FeedItemPage page = ConnectApi.ChatterFeeds.getFeedItemsFromFeed(communityId, ConnectApi.FeedType.News, subjectId);
7
8// page.updatesToken is opaque and has a value like '2:1384549034000'
9
10// Get the feed items that changed since the provided updatesToken
11ConnectApi.FeedItemPage feedItems= ConnectApi.ChatterFeeds.getFeedItemsUpdatedSince
12 (communityId, ConnectApi.FeedType.News, subjectId, 1, ConnectApi.FeedDensity.AllUpdates, null, 1, page.updatesToken, true);getFeedPoll(communityId, feedItemId)
フィード項目に関連付けられたアンケートを取得します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedPoll getFeedPoll(String communityId, String feedItemId)
パラメーター
戻り値
getLikesForFeedItem(communityId, feedItemId)
フィード項目のいいね! を取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLikePage getLikesForFeedItem(String communityId, String feedItemId)
パラメーター
getLikesForFeedItem(communityId, feedItemId, pageParam, pageSize)
フィード項目のいいね! のページを取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLikePage getLikesForFeedItem(String communityId, String feedItemId, Integer pageParam, Integer pageSize)
パラメーター
likeFeedItem(communityId, feedItemId)
コンテキストユーザーのフィード項目にいいね! と言います。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.ChatterLike likeFeedItem(String communityId, String feedItemId)
パラメーター
postComment(communityId, feedItemId, text)
フィード項目にプレーンテキストのコメントを投稿します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Comment postComment(String communityId, String feedItemId, String text)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedItemId
- 型: String
- フィード項目の ID。
- text
- 型: String
- コメントのテキスト。メンションはプレーンテキストにダウンロードされます。ユーザーにリンクするメンションを含めるには、postComment(communityId, feedItemId, comment, feedItemFileUpload) をコールし、ConnectApi.CommentInput オブジェクトでメンションを渡します。
戻り値
使用方法
text でハッシュタグまたはリンクが検出された場合は、ハッシュタグセグメントまたはリンクセグメントとしてコメントに含まれます。メンションは、text では検出されず、テキストから分離されることもありません。
フィード項目とコメントには 10,000 文字まで使用できます。
postComment(communityId, feedItemId, comment, feedItemFileUpload)
フィード項目にリッチテキストコメントを投稿します。このメソッドは、メンションを含めたり、コメントにファイルを添付したりするために使用します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Comment postComment(String communityId, String feedItemId, ConnectApi.CommentInput comment, ConnectApi.BinaryInput feedItemFileUpload)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedItemId
- 型: String
- フィード項目の ID。
- comment
- 型: ConnectApi.CommentInput
- CommentInput オブジェクトで、@メンションなどのリッチテキストを指定します。必要に応じて、CommentInput.attachment プロパティで、既存または新規のファイルを指定します。
- feedItemFileUpload
- 型: ConnectApi.BinaryInput
- CommentInput.attachment プロパティで NewFileAttachmentInput オブジェクトを指定する場合は、添付する新規のバイナリファイルをこの引数で指定します。それ以外の場合は、値を指定しません。
戻り値
使用方法
フィード項目とコメントには 10,000 文字まで使用できます。
サンプル: 新しいファイルを添付したコメントの投稿
コメントを投稿し、新しいファイルをアップロードしてコメントに添付するには、ConnectApi.CommentInput オブジェクトと ConnectApi.BinaryInput オブジェクトを作成して ConnectApi.ChatterFeeds.postComment メソッドに渡します。
1String communityId = null;
2String feedItemId = '0D5D0000000Kcd1';
3
4ConnectApi.CommentInput input = new ConnectApi.CommentInput();
5ConnectApi.MessageBodyInput messageInput = new ConnectApi.MessageBodyInput();
6ConnectApi.TextSegmentInput textSegment;
7
8textSegment = new ConnectApi.TextSegmentInput();
9textSegment.text = 'Comment Text Body';
10
11messageInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
12messageInput.messageSegments.add(textSegment);
13
14input.body = messageInput;
15
16ConnectApi.NewFileAttachmentInput attachmentInput = new ConnectApi.NewFileAttachmentInput();
17attachmentInput.description = 'The description of the file';
18attachmentInput.title = 'contentFile.txt';
19input.attachment = attachmentInput;
20
21String fileContents = 'This is the content of the file.';
22Blob fileBlob = Blob.valueOf(fileContents);
23ConnectApi.BinaryInput binaryInput = new ConnectApi.BinaryInput(fileBlob, 'text/plain', 'contentFile.txt');
24
25ConnectApi.Comment commentRep = ConnectApi.ChatterFeeds.postComment(communityId, feedItemId, input, binaryInput);postFeedElement(communityId, feedElement, feedElementFileUpload)
リッチテキストフィード要素を投稿します。メンションやハッシュタグトピックを含めたり、フィード要素にファイルを添付したり、アクションリンクグループをフィード要素に関連付けたりします。また、このメソッドを使用して、フィード要素の共有やコメントの追加を行うこともできます。
API バージョン
31.0 ～ 35.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement postFeedElement(String communityId, ConnectApi.FeedElementInput feedElement, ConnectApi.BinaryInput feedElementFileUpload)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedElement
- 型: ConnectApi.FeedElementInput
- メンションなどのリッチテキストを指定します。必要に応じて、リンク、アンケート、既存または新規のファイルを指定します。
- feedElementFileUpload
- 型: ConnectApi.BinaryInput
- feedElement パラメーターで NewFileAttachmentInput オブジェクトも指定した場合のみ、この投稿に添付する新規バイナリファイルを指定します。それ以外の場合は null を渡します。
戻り値
新しい (バイナリ) ファイルを添付したフィード要素の投稿の例
1ConnectApi.FeedItemInput input = new ConnectApi.FeedItemInput();
2input.subjectId = 'me';
3
4ConnectApi.ContentCapabilityInput contentInput = new ConnectApi.ContentCapabilityInput();
5contentInput.title = 'Title';
6
7ConnectApi.FeedElementCapabilitiesInput capabilities = new ConnectApi.FeedElementCapabilitiesInput();
8capabilities.content = contentInput;
9
10input.capabilities = capabilities;
11
12String text = 'These are the contents of the new file.';
13Blob myBlob = Blob.valueOf(text);
14ConnectApi.BinaryInput binInput = new ConnectApi.BinaryInput(myBlob, 'text/plain', 'fileName');
15
16ConnectApi.ChatterFeeds.postFeedElement(Network.getNetworkId(), input, binInput);postFeedItem(communityId, feedType, subjectId, text)
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItem postFeedItem(String communityId, ConnectApi.FeedType feedType, String subjectId, String text)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかになります。
- News
- Record
- UserProfile
- subjectId
- 型: String
- 値は、feedType によって異なります。
- News — コンテキストユーザーの ID またはキーワード me。
- Record — グループを含むフィードの任意のレコードの ID。
- UserProfile — 任意のユーザーの ID。
- text
- 型: String
- フィード項目のテキスト。メンションはプレーンテキストにダウンロードされます。ユーザーにリンクするメンションを含めるには、postFeedItem(communityId, feedType, subjectId, feedItemInput, feedItemFileUpload) メソッドをコールし、ConnectApi.FeedItemInput オブジェクトでメンションを渡します。
戻り値
postFeedItem(communityId, feedType, subjectId, feedItemInput, feedItemFileUpload)
リッチテキストフィード項目をフィードに投稿します。このメソッドは、メンションやハッシュタグトピックを含めたり、フィード項目にファイルを添付したりするために使用します。また、このメソッドを使用して、フィード項目の共有およびコメントの追加を行うこともできます。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItem postFeedItem(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.FeedItemInput feedItemInput, ConnectApi.BinaryInput feedItemFileUpload)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかになります。
- News
- Record
- UserProfile
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- feedItemInput
- 型: ConnectApi.FeedItemInput
- FeedItemInput オブジェクトで、リッチテキストを指定します。必要に応じて、FeedItemInput.attachment プロパティで、リンク、アンケート、既存または新規のファイルを指定します。
- feedItemFileUpload
- 型: ConnectApi.BinaryInput
- FeedItemInput.attachment プロパティで NewFileAttachmentInput オブジェクトを指定する場合は、添付する新規のバイナリファイルをこの引数で指定します。それ以外の場合は、値を指定しません。
戻り値
使用方法
フィード項目とコメントには 10,000 文字まで使用できます。API バージョン 23.0 および 24.0 での ConnectApi.FeedType.UserProfile への投稿では、フィード項目ではなくユーザー状況更新が作成されていました。これらの API バージョンでのユーザープロファイルフィードへの投稿では、文字制限は 1,000 文字です。
フィード項目の共有とコメントの追加の例
フィード項目を共有しコメントを追加するには、コメントおよび共有するフィード項目を含む ConnectApi.FeedItemInput オブジェクトを作成します。その後、feedItemInput 引数の ConnectApi.ChatterFeeds.postFeeditem にオブジェクトを渡します。メッセージ本文に入力されたメッセージセグメントは、コメントとして使用されます。
1ConnectApi.FeedItemInput input = new ConnectApi.FeedItemInput();
2input.originalFeedItemId = '0D5D0000000JuAG';
3
4ConnectApi.MessageBodyInput body = new ConnectApi.MessageBodyInput();
5List<ConnectApi.MessageSegmentInput> segmentList = new List<ConnectApi.MessageSegmentInput>();
6ConnectApi.TextSegmentInput textSegment = new ConnectApi.TextSegmentInput();
7textSegment.text = 'I hope you enjoy this post I found in another group.';
8segmentList.add((ConnectApi.MessageSegmentInput)textSegment);
9body.messageSegments = segmentList;
10input.body = body;
11
12ConnectApi.ChatterFeeds.postFeedItem(null, ConnectApi.FeedType.UserProfile, 'me', input, null);ユーザープロファイルフィードへのメンションの投稿の例
ユーザープロファイルフィードに投稿し、@メンションを含めるには、ConnectApi.ChatterFeeds.postFeedItem メソッドをコールします。
1String communityId = null;
2ConnectApi.FeedType feedType = ConnectApi.FeedType.UserProfile;
3
4ConnectApi.FeedItemInput input = new ConnectApi.FeedItemInput();
5ConnectApi.MessageBodyInput messageInput = new ConnectApi.MessageBodyInput();
6ConnectApi.TextSegmentInput textSegment;
7ConnectApi.MentionSegmentInput mentionSegment = new ConnectApi.MentionSegmentInput();
8
9messageInput.messageSegments = new List<ConnectApi.MessageSegmentInput>();
10
11textSegment = new ConnectApi.TextSegmentInput();
12textSegment.text = 'Hey there ';
13messageInput.messageSegments.add(textSegment);
14
15mentionSegment.id = '005D0000001LLO1';
16messageInput.messageSegments.add(mentionSegment);
17
18textSegment = new ConnectApi.TextSegmentInput();
19textSegment.text = '. How are you?';
20messageInput.messageSegments.add(textSegment);
21
22input.body = messageInput;
23
24ConnectApi.FeedItem feedItemRep = ConnectApi.ChatterFeeds.postFeedItem(communityId, feedType, 'me', input, null);searchFeedItems(communityId, q)
検索条件に一致するフィード項目を取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItems(String communityId, String q)
パラメーター
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItems(communityId, q, sortParam)
検索条件に一致するフィード項目を並べ替えて取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItems(String communityId, String q, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並べ替えます。
- LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItems(communityId, q, pageParam, pageSize)
検索条件に一致するフィード項目のページを取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItems(String communityId, String q, String pageParam, Integer pageSize)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItems(communityId, q, pageParam, pageSize, sortParam)
検索条件に一致するフィード項目を並べ替えたページを取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItems(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItems(communityId, q, recentCommentCount, pageParam, pageSize, sortParam)
検索条件に一致するフィード項目を並べ替えたページを取得します。
API バージョン
29.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItems(String communityId, String q, Integer recentCommentCount, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- 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 フィードでのみ使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItemsInFeed(communityId, feedType, q)
Company、Home、および Moderation フィードから検索条件に一致するフィード項目を取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItemsInFeed(communityId, feedType, pageParam, pageSize, sortParam, q)
Company、Home、および Moderation フィードから検索条件に一致するフィード項目を並べ替えたページを取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItemsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q)
Company、Home、および Moderation フィードから検索条件に一致するフィード項目を並べ替えたページを取得します。各フィード項目には、指定された数以内のコメント数が含まれます。
API バージョン
29.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItemsInFeed(communityId, feedType, subjectId, q)
フィードから検索条件に一致するフィード項目を取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、および Streams を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。フィード種別が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値である場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItemsInFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, q)
ユーザーまたはレコードのフィードから検索条件に一致するフィード項目を並べ替えたページを取得します。
API バージョン
28.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、および Streams を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 検索語。ユーザー名またはグループ名でキーワードを検索します。1 文字以上を指定する必要があります。このパラメーターではワイルドカードは使用できません。このパラメーターは必須です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItemsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q)
フィードから検索条件に一致するフィード項目を並べ替えたページを取得します。各フィード項目には、指定された数以内のコメント数が含まれます。
API バージョン
29.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、および Streams を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItemsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly)
ユーザーまたはレコードのフィードから検索条件に一致するフィード項目を並べ替えたページを取得します。各フィード項目には、指定された数以内のコメント数が含まれます。内部 (Experience Cloud サイト以外の) ユーザーのみが投稿したフィード項目を返すかどうかを指定します。
API バージョン
30.0 ～ 31.0
ゲストユーザーが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, Boolean showInternalOnly)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 値は ConnectApi.FeedType.Record である必要があります。
- subjectId
- 型: String
- グループ ID を含むすべてのレコード ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItemsInFilterFeed(communityId, subjectId, keyPrefix, q)
ユーザーのキープレフィックスで絞り込まれたフィードから検索条件に一致するフィード項目を取得します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItemsInFilterFeed(String communityId, String subjectId, String keyPrefix, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItemsInFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, q)
ユーザーのキープレフィックスで絞り込まれたフィードから検索条件に一致するフィード項目を並べ替えたページを取得します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItemsInFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
searchFeedItemsInFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, q)
ユーザーのキープレフィックスで絞り込まれたフィードから検索条件に一致するフィード項目を並べ替えたページを取得します。各フィード項目には、指定された数以内のコメント数が含まれます。
API バージョン
29.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage searchFeedItemsInFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
updateBookmark(communityId, feedItemId, isBookmarkedByCurrentUser)
フィード項目にブックマークを付けるか、フィード項目からブックマークを削除します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItem updateBookmark(String communityId, String feedItemId, Boolean isBookmarkedByCurrentUser)
パラメーター
戻り値
voteOnFeedPoll(communityId, feedItemId, myChoiceId)
フィードのアンケートに投票するか、投票を変更します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedPoll voteOnFeedPoll(String communityId, String feedItemId, String myChoiceId)
パラメーター
戻り値
setTestGetFeedItemsFromFeed(communityId, feedType, result)
テストコンテキストの一致するパラメーターで getFeedItemsFromFeed をコールするときに返される ConnectApi.FeedItemPage ���ブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsFromFeed(communityId, feedType, pageParam, pageSize, sortParam, result)
テストコンテキストの一致するパラメーターで getFeedItemsFromFeed をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsFromFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, result)
テストコンテキストの一致するパラメーターで getFeedItemsFromFeed をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
29.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsFromFeed(communityId, feedType, subjectId, result)
テストコンテキストの一致するパラメーターで getFeedItemsFromFeed をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsFromFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, result)
テストコンテキストの一致するパラメーターで getFeedItemsFromFeed をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, result)
テストコンテキストの一致するパラメーターで getFeedItemsFromFeed をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
29.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsFromFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, showInternalOnly, result)
テストコンテキストの一致するパラメーターで getFeedItemsFromFeed をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。get feed メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
30.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, Boolean showInternalOnly, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix, result)
一致する getFeedItemsFromFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix, pageParam, pageSize, sortParam, result)
一致する getFeedItemsFromFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsFromFilterFeed(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, result)
一致する getFeedItemsFromFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
29.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFilterFeed(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsFromFilterFeedUpdatedSince(communityId, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, updatedSince, result)
getFeedItemsFromFilterFeedUpdatedSince メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。
API バージョン
30.0 ～ 31.0
署名
public static Void setTestGetFeedItemsFromFilterFeedUpdatedSince(String communityId, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String updatedSince, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。このトークンを取得するには、getFeedItemsFromFilterFeed をコールし、ConnectApi.FeedItemPage レスポンスボディの updatesToken プロパティの値を取ります。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsUpdatedSince(communityId, feedType, recentCommentCount, density, pageParam, pageSize, updatedSince, ConnectApi.FeedItemPage, results)
テストコンテキストの一致するパラメーターで getFeedItemsUpdatedSince をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
30.0 ～ 31.0
署名
public static Void setTestGetFeedItemsUpdatedSince(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedItemPage results)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedItemPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, result)
テストコンテキストの一致するパラメーターで getFeedItemsUpdatedSince をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
30.0 ～ 31.0
署名
public static Void setTestGetFeedItemsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかの値になります。
- Files
- Groups
- News
- People
- Record
- subjectId
- 型: String
- feedType が ConnectApi.Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。それ以外の場合は、コンテキストユーザーまたは別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedItemPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItemsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, showInternalOnly, result)
テストコンテキストの一致するパラメーターで getFeedItemsUpdatedSince をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、コードで例外が発生します。
API バージョン
30.0 ～ 31.0
署名
public static Void setTestGetFeedItemsUpdatedSince(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, String updatedSince, Boolean showInternalOnly, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかの値になります。
- Files
- Groups
- News
- People
- Record
- subjectId
- 型: String
- feedType が ConnectApi.Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。それ以外の場合は、コンテキストユーザーまたは別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- updatedSince
- 型: String
- フィードの最終更新日に関する情報を含む不透明トークン。このトークンは作成しません。ConnectApi.FeedItemPage レスポンスボディの updatesToken プロパティからこのトークンを取得します。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedItems(communityId, q, result)
テスト中に searchFeedItems(communityId, q) がコールされたときに返される、テストフィード項目ページを登録します。
API バージョン
28.0 ～ 31.0
署名
public static Void searchFeedItems(String communityId, String q, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedItems(communityId, q, sortParam, result)
テスト中に searchFeedItems(String, String, ConnectApi.FeedSortOrder) がコールされたときに返される、テストフィード項目ページを登録します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestSearchFeedItems(String communityId, String q, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並べ替えられる。この並べ替え順は、DirectMessageModeration、Draft, Isolated、Moderation、PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並べ替えます。
- LastModifiedDateDesc — 活動の新しい順に並べ替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並べ替えます。この並べ替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並べ替えます。この並べ替え順は、Company、Home、および Topics フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedItemPage
- フィード項目テストページ。
戻り値
型: Void
setTestSearchFeedItems(communityId, q, pageParam, pageSize, result)
テスト中に searchFeedItems(String, String, String, Integer) がコールされたときに返される、テストフィード項目ページを登録します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestSearchFeedItems(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- result
- 型: ConnectApi.FeedItemPage
- テストフィード項目ページ。
戻り値
型: Void
setTestSearchFeedItems(communityId, q, pageParam, pageSize, sortParam, result)
テスト中に searchFeedItems(String, String, String, Integer, ConnectApi.FeedSortOrder) がコールされたときに返される、テストフィード項目ページを登録します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestSearchFeedItems(String communityId, String q, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedItemPage
- テストフィード項目ページ。
戻り値
型: Void
setTestSearchFeedItems(communityId, q, recentCommentCount, pageParam, pageSize, sortParam, result)
テスト中に searchFeedItems(communityId, q, recentCommentCount, pageParam, pageSize, sortParam) がコールされたときに返される、テストフィード項目ページを登録します。
API バージョン
29.0 ～ 31.0
署名
public static Void setTestSearchFeedItems(String communityId, String q, Integer recentCommentCount, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- 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 フィードでのみ使用できます。
- result
- 型: ConnectApi.FeedItemPage
- テストフィード項目ページ。
戻り値
型: Void
setTestSearchFeedItemsInFeed(communityId, feedType, q, result)
一致する ConnectApi.searchFeedItemsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String q, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Isolated、Moderation、および PendingReview です。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedItemsInFeed(communityId, feedType, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedItemsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedItemsInFeed(communityId, feedType, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedItemsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
29.0 ～ 31.0
署名
public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedItemsInFeed(communityId, feedType, subjectId, q, result)
一致する ConnectApi.searchFeedItemsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String q, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、および Streams を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedItemsInFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedItemsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、および Streams を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedItemsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedItemsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
29.0 ～ 31.0
署名
public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、および Streams を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me である必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedItemsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, result)
一致する ConnectApi.searchFeedItemsInFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
29.0 ～ 31.0
署名
public static Void setTestSearchFeedItemsInFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, Boolean showInternalOnly, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessages、Filter、Landing、および Streams を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- feedType が Record である場合、subjectId にはグループ ID を含む任意のレコード ID を指定できます。feedType が Streams である場合、subjectId はストリーム ID である必要があります。feedType が Topics である場合、subjectId はトピック ID である必要があります。feedType が UserProfile である場合、subjectId には任意のユーザー ID を指定できます。feedType がその他の値の場合、subjectId はコンテキストユーザーの ID または別名 me ��ある必要があります。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (Experience Cloud サイト以外の) ユーザーからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestSearchFeedItemsInFilterFeed(communityId, subjectId, keyPrefix, q, result)
一致する ConnectApi.searchFeedItemsInFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestSearchFeedItemsInFilterFeed(String communityId, String subjectId, String keyPrefix, String q, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストフィード項目ページを指定します。
戻り値
型: Void
setTestSearchFeedItemsInFilterFeed(communityId, feedType, subjectId, keyPrefix, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedItemsInFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
28.0 ～ 31.0
署名
public static Void setTestSearchFeedItemsInFilterFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String keyPrefix, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストフィード項目ページを指定します。
戻り値
型: Void
setTestSearchFeedItemsInFilterFeed(communityId, feedType, subjectId, keyPrefix, recentCommentCount, density, pageParam, pageSize, sortParam, q, result)
一致する ConnectApi.searchFeedItemsInFilterFeed メソッドをテストコンテキストでコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。メソッドでは、同じパラメーターを使用します。パラメーターが同じでないと、例外が発生します。
API バージョン
29.0 ～ 31.0
署名
public static Void setTestSearchFeedItemsInFilterFeed(String communityId, ConnectApi.FeedType feedType, String subjectId, String keyPrefix, Integer recentCommentCount, ConnectApi.FeedDensity density, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, String q, ConnectApi.FeedItemPage result)
パラメーター
- communityId
- 型: String
- Experience Cloud サイトの ID、internal、または null。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter, Home、Isolated、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- subjectId
- 型: String
- コンテキストユーザーの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は、3 です。
- density
- 型: ConnectApi.FeedDensity
- フィードのコンテンツ量を指定します。
- AllUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されます。
- FewerUpdates — ユーザーがフォローする人とレコード、およびユーザーがメンバーとなっているグループからのすべての更新が表示されます。カスタムのおすすめも表示されますが、レコードからのシステム生成された更新は非表示になります。
- 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 フィードでのみ使用できます。
- q
- 型: String
- 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストフィード項目ページを指定します。
戻り値
型: Void