Apex 開発者ガイド
jChatterFeeds クラス
フィード要素の取得、フィード要素の投稿、フィード要素の削除、いいね!、コメント、ブックマークを実行します。フィード要素の検索、フィード要素の共有、アンケートの投票を行うこともできます。
名前空間
使用方法
API バージョン 30.0 以前では、Chatter フィードはフィード項目のコンテナでした。API バージョン 31.0 では、フィードの定義が拡張され、フィード項目モデルに完全には適合しない新しいオブジェクトが追加されました。Chatter フィードは、フィード要素のコンテナになりました。抽象クラス ConnectApi.FeedElement は、既存の ConnectApi.FeedItem クラスに対する親クラスとして導入されました。フィード要素が共有するプロパティのサブセットは、ConnectApi.FeedElement クラスに移動しました。フィードとフィード要素は Chatter の��核部分であるため、Chatter in Apex を使用してアプリケーションを開発するには、これらの理解が不可欠です。詳細は、「フィードおよびフィード要素の使用」を参照してください。
フィード項目のメッセージセグメントは、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
- コミュニティの 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)
戻り値
getCommentsForFeedElement(communityId, feedElementId)
API バージョン
32.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.CommentPage getCommentsForFeedElement(String communityId, String feedElementId)
パラメータ
戻り値
フィード要素が 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElementId
- 型: String
- フィード要素の ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのコメント数。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
戻り値
型: ConnectApi.CommentPage クラス
フィード要素が 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElementId
- 型: String
- フィード要素の ID。
- sortParam
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序を指定します。値は次のとおりです。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並び替えます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。
戻り値
型: ConnectApi.CommentsCapability
フィード要素が Comments 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedItemId
- 型: String
- フィード項目の ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
戻り値
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Moderation、および PendingReview です。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElementId
- 型: String
- フィード要素の ID。
- commentSort
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序を指定します。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並び替えます。
- 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, 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElementId
- 型: String
- フィード要素の ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は 3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- commentSort
- 型: ConnectApi.FeedCommentSortOrder
- コメントの順序を指定します。
- CreatedDateLatestAsc — 最近作成されたコメントを昇順で並び替えます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。
戻り値
getFeedElementBatch(communityId, feedElementIds)
API バージョン
31.0
ゲストユーザが使用可能
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BatchResult[] getFeedElementBatch(String communityId, List<String> feedElementIds)
パラメータ
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
- コミュニティの 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、Moderation、および PendingReview フィード種別からのフィード要素の最初のページを返します。ページには、デフォルトの項目数が含まれます。
API バージョン
31.0
ゲストユーザが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Moderation、および PendingReview です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, pageParam, pageSize, sortParam)
Company、DirectMessageModeration、DirectMessages、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Moderation、および PendingReview です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザプロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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)
指定されたユーザまたはレコードで、Company、DirectMessageModeration、DirectMessages、Filter、Home、Landing、Moderation、および PendingReview 以外のフィード種別のフィード要素の最初のページを返します。ページには、デフォルトの要素数が含まれます。
API バージョン
31.0
ゲストユーザが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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 メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
コンテキストユーザのニュースフィードの取得の例
別のユーザのプロファイルフィードの取得の例
別のユーザのレコードフィードの取得の例
getFeedElementsFromFeed(communityId, feedType, subjectId, pageParam, pageSize, sortParam)
Company、DirectMessageModeration、DirectMessages、Filter、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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)
指定されたレコードフィード (グループを含む) の指定されたページのフィード要素を、指定された順序で返します。各フィード要素には、指定された数以内のコメント数が含まれます。内部 (コミュニティ以外の) ユーザのみが投稿したフィード要素を返すかどうかを指定します。
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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (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
- コミュニティの 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、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 メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
例
次の例は、コミュニティ固有のフィード要素のみを取得します。
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
- コミュニティの 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、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)
指定されたレコードフィード (グループを含む) の指定されたページのフィード要素を、指定された順序で返します。各フィード要素には、指定された数以内のコメント数が含まれます。内部 (コミュニティ以外の) ユーザのみが投稿したフィード要素を返すかどうかを指定します。バンドル内の最大フィード要素数を指定します。
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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getFeedElementsFromFeed(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, sortParam, showInternalOnly, filter)
指定されたレコードフィード (グループを含む) の指定されたページのフィード要素を、指定された順序で返します。各フィード要素には、指定された数以内のコメント数が含まれます。内部 (コミュニティ以外の) ユーザのみが投稿したフィード要素を返すかどうかを指定します。バンドル内の最大フィード要素数とフィード条件を指定します。
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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザプロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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, 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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する 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
- コミュニティの 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、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
- コミュニティの 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、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
- コミュニティの 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
- コミュニティの 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
- コミュニティの 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 — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかの値にします。
- ファイル
- グループ
- ニュース
- 人
- レコード
- 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)
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, Boolean showInternalOnly)
パラメータ
- communityId
- 型: String
- コミュニティの 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
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, filter)
UserProfile フィードのフィード要素の指定されたページを返します。updatedSince パラメータで指定された時刻以降に更新されたフィード要素のみが含まれます。このメソッドを使用して、コミュニティを範囲とするフィード要素のみが含まれるように UserProfile フィードを絞り込みます。すべてのコミュニティで常に表示されるフィード要素は除外されます。現在、コミュニティを範囲とするフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがコミュニティを範囲とする可能性があります。
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
- コミュニティの 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 である必要があります。コミュニティを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのコミュニティで常に表示されるフィード要素は除外されます。現在、コミュニティを範囲とするフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがコミュニティを範囲とする可能性があります。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する 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
- コミュニティの 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)
Record フィード種別のフィード要素の指定されたページを返します。updatedSince パラメータで指定された時刻以降に更新されたフィード要素のみが含まれます。内部 (コミュニティ以外の) ユーザのみが投稿したフィード要素を返すかどうかを指定します。バンドル内の最大フィード要素数を指定します。
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
- コミュニティの 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
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getFeedElementsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, elementsPerBundle, density, pageParam, pageSize, updatedSince, showInternalOnly, filter)
Record フィード種別のフィード要素の指定されたページを返します。updatedSince パラメータで指定された時刻以降に更新されたフィード要素のみが含まれます。内部 (コミュニティ以外の) ユーザのみが投稿したフィード要素を返すかどうかを指定します。バンドル内の最大フィード要素数とフィード条件を指定します。
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
- コミュニティの 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
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザプロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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
- コミュニティの 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
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getFeedItem(communityId, feedItemId)
指定されたフィード項目の詳細な説明を返します。
API バージョン
28.0 ～ 31.0
ゲストユーザが使用可能
31.0 のみ
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItem getFeedItem(String communityId, String feedItemId)
パラメータ
戻り値
getFeedItemBatch(communityId, feedItemIds)
指定されたフィード項目リストに関する情報を返します。ConnectApi.FeedItem オブジェクトを含む BatchResult オブジェクトのリストを返します。読み込みできないフィード項目のエラーは、結果に返されます。
API バージョン
31.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BatchResult[] getFeedItemBatch(String communityId, List<String> feedItemIds)
パラメータ
戻り値
ConnectApi.BatchResult.getResult() メソッドは ConnectApi.FeedItem オブジェクトを返します。
例
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Moderation、および PendingReview です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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)
指定されたユーザまたはレコードの指定されたページで、Record フィード種別のフィード項目を指定された順序で返します。各フィード項目には、指定された数以内のコメント数が含まれます。内部 (コミュニティ以外の) ユーザのみが投稿したフィード項目を返すかどうかを指定します。
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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (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
- コミュニティの 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、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
- コミュニティの 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、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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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 メソッドに渡し、最初のコール以降に更新されたフィード項目を取得します。
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかの値にします。
- ファイル
- グループ
- ニュース
- 人
- レコード
- 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 メソッドに渡し、最初のコール以降に更新されたフィード項目を取得します。
getFeedItemsUpdatedSince(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, updatedSince, showInternalOnly)
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, Boolean showInternalOnly)
パラメータ
- communityId
- 型: String
- コミュニティの 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
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
使用方法
このメソッドは、updatedSince 引数で指定された時刻以降に更新されたフィード項目のみを返します。フィード項目は、最後のフィード要求の時刻以降に作成されたか、最後のフィード要求の時刻以降にフィード項目に sort=LastModifiedDateDesc およびコメントが追加された場合、更新されたものとみなされます。いいね! やトピックを追加してもフィード項目は更新されません。
showInternalOnly が true で、Salesforce コミュニティが有効になっている場合、コミュニティからのフィード項目が含まれます。それ以外の場合は、内部コミュニティからのフィード項目のみが含まれます。
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
例
この例では、ニュースフィードのフィード項目を取得し、返されたオブジェクトから updatesToken プロパティを取り込みます。updatesToken の値を getFeedItemsUpdatedSince メソッドに渡し、最初のコール以降に更新されたフィード項目を取得します。
getFeedPoll(communityId, feedItemId)
フィード項目に関連付けられたアンケートを返します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedPoll getFeedPoll(String communityId, String feedItemId)
パラメータ
戻り値
getFeedWithFeedElements(communityId, feedType, pageSize)
API バージョン
40.0
ゲストユーザが使用可能
40.0
Chatter が必要かどうか
可
署名
public static ConnectApi.Feed getFeedWithFeedElements(String communityId, ConnectApi.FeedType feedType, Integer pageSize)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me。
- keyPrefix
- 型: String
- レコードタイプを指定するキープレフィックス。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
- sortParam
- 型: ConnectApi.FeedType
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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 つを渡します。返されたフィード項目には、渡されたキープレフィックスによって指定されたエンティティ種別を親に持つニュースフィードからのすべてのフィード項目が含まれます。
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)
パラメータ
戻り値
型: ConnectApi.ChatterLikePage クラス
フィード要素が 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElementId
- 型: String
- フィード要素の ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
戻り値
型: ConnectApi.ChatterLikePage クラス
フィード要素が ChatterLikes 機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
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)
パラメータ
getPinnedFeedElementsFromFeed(communityId, feedType, subjectId) (ベータ)
API バージョン
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.PinnedFeedElements getPinnedFeedElementsFromFeed(String communityId, ConnectApi.FeedType feedType, String subjectId)
パラメータ
- communityId
- 型: String
- コミュニティの 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
- コミュニティの 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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
戻り値
getStreams(communityId, sortParam)
API バージョン
40.0
Chatter が必要かどうか
可
署名
public static ConnectApi.ChatterStreamPage getStreams(String communityId, ConnectApi.SortOrder sortParam)
パラメータ
- communityId
- 型: String
- コミュニティの 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
- コミュニティの 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
- コミュニティの 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 値に関係なく、すべてのコンテキストユーザのコミュニティからのストリームを取得するかどうかを指定します。
戻り値
getSupportedEmojis()
API バージョン
39.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.SupportedEmojis getSupportedEmojis()
戻り値
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
- コミュニティの 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 になります。
例
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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedItemId
- 型: String
- フィード項目の ID。
- comment
- 型: ConnectApi.CommentInput
- CommentInput オブジェクトで、@メンションなどのリッチテキストを指定します。必要に応じて、CommentInput.attachment プロパティで、既存または新規のファイルを指定します。
- feedItemFileUpload
- 型: ConnectApi.BinaryInput
- CommentInput.attachment プロパティで NewFileAttachmentInput オブジェクトを指定する場合は、添付する新規のバイナリファイルをこの引数で指定します。それ以外の場合は、値を指定しません。
戻り値
使用方法
フィード項目とコメントには 10,000 文字まで使用できます。
postCommentToFeedElement(communityId, feedElementId, text)
API バージョン
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Comment postCommentToFeedElement(String communityId, String feedElementId, String text)
パラメータ
例
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElementId
- 型: String
- フィード要素の ID。
- comment
- 型: ConnectApi.CommentInput
- 添付ファイルに関する情報など、テキスト、メンション、機能などを含む、コメント本文。
- feedElementFileUpload
- 型: ConnectApi.BinaryInput
- コメントに添付する新しいバイナリファイル、または null。バイナリファイルを指定した場合、comment パラメータにファイルのタイトルと説明を指定します。
メンションを含むコメントの投稿の例
メンションを含むコメントを投稿する方法は 2 つあります。GitHub の ConnectApiHelper リポジトリを使用して 1 行のコードを記述するか、次のメソッド例を使用します。
既存のファイルを添付したコメントの投稿の例
新しいファイルを添付したコメントの投稿の例
インライン画像を含むリッチテキストコメントの投稿の例
インライン画像とメンションを含むリッチテキストコメントを投稿する方法は 2 つあります。GitHub の ConnectApiHelper リポジトリを使用して 1 行のコードを記述するか、次のメソッド例を使用します。この例の画像ファイルは、Salesforce にアップロード済みの既存のコンテンツです。
コードブロックを含むリッチテキストコメントの投稿の例
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- このフィード要素が投稿された親の ID。この値は、ユーザ、グループ、レコードの ID、またはコンテキストユーザを示す文字列 me になります。
- feedElementType
- 型: ConnectApi.FeedElementType
- 使用可能な値は FeedItem のみです。
- text
- 型: String
- フィード要素のテキスト。フィード要素には 10,000 文字まで使用できます。
戻り値
例
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElement
- 型: ConnectApi.FeedElementInput
- メンションなどのリッチテキストを指定します。必要に応じて、リンク、アンケート、既存または新規のファイルを指定します。
- feedElementFileUpload
- 型: ConnectApi.BinaryInput
- feedElement パラメータで NewFileAttachmentInput オブジェクトも指定した場合のみ、この投稿に添付する新規バイナリファイルを指定します。それ以外の場合は null を渡します。
戻り値
新しい (バイナリ) ファイルを添付したフィード要素の投稿の例
postFeedElement(communityId, feedElement)
コンテキストユーザからのフィード要素を投稿します。このメソッドは、メンションやハッシュタグトピックを含むリッチテキストの投稿、すでにアップロードされているファイルのフィード要素への添付、およびアクションリンクグループとフィード要素の関連付けに使用します。また、このメソッドを使用して、フィード要素の共有やコメントの追加を行うこともできます。
API バージョン
36.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElement postFeedElement(String communityId, ConnectApi.FeedElementInput feedElement)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElement
- 型: ConnectApi.FeedElementInput
- メンションなどのリッチテキストを指定します。必要に応じて、リンク、アンケート、または最大 10 個の既存のファイルを指定します。
戻り値
メンションを含むフィード要素の投稿の例
メンションを含むフィード要素を投稿する方法は 2 つあります。GitHub の ConnectApiHelper リポジトリを使用して 1 行のコードを記述するか、次のメソッド例を使用します。
既存のコンテンツが添付されたフィード要素の投稿の例
インライン画像を含むリッチテキストフィード要素の投稿の例
インライン画像とメンションを含むリッチテキストフィード要素を投稿する方法は 2 つあります。GitHub の ConnectApiHelper リポジトリを使用して 1 行のコードを記述するか、次のメソッド例を使用します。この例の画像ファイルは、Salesforce にアップロード済みの既存のコンテンツです。投稿には、テキストとメンションも含まれます。
コードブロックを含むリッチテキストフィード要素の投稿の例
フィード要素の共有の例 (バージョン 39.0 以降)
postFeedElementBatch(communityId, feedElements)
API バージョン
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BatchResult[] postFeedElementBatch(String communityId, List<ConnectApi.BatchInput> feedElements)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElements
- 型: List<ConnectApi.BatchInput Class>
- リストには最大 500 個の ConnectApi.BatchInput オブジェクトを含めることができます。ConnectApi.BatchInput コンストラクタでは、入力オブジェクトは ConnectApi.FeedElementInput 抽象クラスの具象インスタンスである必要があります。
戻り値
ConnectApi.BatchResult.getResult() メソッドは ConnectApi.FeedElement オブジェクトを返します。
返されるオブジェクトは、各入力オブジェクトに対応し、入力オブジェクトと同じ順序で返されます。
メソッドコールは、操作全体に影響を与えるエラー (解析エラーなど) が発生した場合にのみ失敗します。個々のオブジェクトでエラーが発生した場合、エラーは ConnectApi.BatchResult リスト内に埋め込まれます。
使用方法
このメソッドを使用すると、フィード要素のリストを効率よく投稿できます。最大 500 オブジェクトを含むリストを作成し、1 つの DML ステートメントでそのすべてを挿入します。
ConnectApi.BatchInput Class クラスには 3 つのコンストラクタがありますが、postFeedElementBatch メソッドでサポートされるのはここで示している 2 つのみです。複数のバイナリ入力はサポートされません。
各コンストラクタで、入力オブジェクトは ConnectApi.FeedElementInput のインスタンスである必要があります。コンストラクタは、バイナリ入力を渡すかどうかに基づいて選択します。
- ConnectApi.BatchInput(Object input) — バイナリ入力なし
- ConnectApi.BatchInput(Object input, ConnectApi.BinaryInput binary) — 1 つのバイナリ入力
例
このトリガは、新たに挿入された取引先のフィードに一括投稿します。
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかになります。
- News
- Record
- UserProfile
- subjectId
- 型: String
- 値は、feedType によって異なります。
- News — subjectId は、コンテキストユーザの 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
- コミュニティの 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 にそのオブジェクトを渡します。メッセージ本文に入力されたメッセージセグメントは、コメントとして使用されます。
ユーザプロファイルフィードへのメンションの投稿の例
ユーザプロファイルフィードに投稿し、@メンションを含めるには、ConnectApi.ChatterFeeds.postFeedItem メソッドをコールします。
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する 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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する 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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, q)
API バージョン
31.0
ゲストユーザが使用可能
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage searchFeedElementsInFeed(String communityId, ConnectApi.FeedType feedType, String q)
パラメータ
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, pageParam, pageSize, sortParam, q)
Company、DirectMessageModeration、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、Moderation、および PendingReview です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、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、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)
Home フィード種別のフィード要素を検索し、指定されたフィード条件で��指定されたページおよびページサイズを指定された並び替え順で返します。各フィード要素には、指定された数以内のコメント数が含まれます。
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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザプロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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
- コミュニティの 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 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する 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
- コミュニティの 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、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
- コミュニティの 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、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)
UserProfile フィードのフィード要素を検索します。このメソッドを使用して、コミュニティを範囲とするフィード要素のみが含まれるように UserProfile フィードを絞り込みます。すべてのコミュニティで常に表示されるフィード要素は除外されます。現在、コミュニティを範囲とするフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがコミュニティを範囲とする可能性があります。
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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- コンテキストユーザに表示されるフィード要素に含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped である必要があります。コミュニティを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのコミュニティで常に表示されるフィード要素は除外されます。現在、コミュニティを範囲とするフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがコミュニティを範囲とする可能性があります。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する 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
- コミュニティの 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、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)
指定されたフィード種別およびコンテキストユーザのフィード要素を検索し、指定されたページおよびページサイズを指定された並び替え順で返します。各フィード要素には、指定された数以内のコメント数が含まれます。内部 (コミュニティ以外の) ユーザのみが投稿したフィード要素を返すかどうかを指定します。
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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
searchFeedElementsInFeed(communityId, feedType, subjectId, recentCommentCount, density, pageParam, pageSize, sortParam, q, showInternalOnly, filter)
指定されたフィード種別およびコンテキストユーザのフィード要素を検索し、指定されたページおよびページサイズを指定された並び替え順で返します。各フィード要素には、指定された数以内のコメント数が含まれます。内部 (コミュニティ以外の) ユーザのみが投稿したフィード要素を返すかどうかを指定します。フィード条件を指定します。
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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザプロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (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
- コミュニティの 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
- コミュニティの 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、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの 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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Moderation、および PendingReview です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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、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
- コミュニティの 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
- コミュニティの 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、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
searchFeedItemsInFeed(String, ConnectApi.FeedType, String, Integer, ConnectApi.FeedDensity, String, Integer, ConnectApi.FeedSortOrder, String, Boolean)
指定されたフィード種別およびユーザまたはレコードのフィード項目を検索し、指定されたページおよびページサイズを指定された並び替え順で返します。各フィード項目には、指定された数以内のコメント数が含まれます。内部 (コミュニティ以外の) ユーザのみが投稿したフィード項目を返すかどうかを指定します。
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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (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
- コミュニティの 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
- コミュニティの 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、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
- コミュニティの 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、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
- コミュニティの 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
- コミュニティの 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
- コミュニティの 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
- コミュニティの 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 値に関係なく、すべてのコンテキストユーザのコミュニティからのストリームを取得するかどうかを指定します。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
setCommentIsVerified(communityId, commentId, isVerified)
API バージョン
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.VerifiedCapability setCommentIsVerified(String communityId, String commentId, Boolean isVerified)
パラメータ
setCommentVote(communityId, commentId, upDownVote)
API バージョン
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.UpDownVoteCapability setCommentVote(String communityId, String commentId, ConnectApi.UpDownVoteCapabilityInput upDownVote)
パラメータ
- communityId
- 型: String
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- commentId
- 型: String
- コメントの ID。
- status
- 型: ConnectApi.StatusCapabilityInput
- 設定する状況が含まれる ConnectApi.StatusCapabilityInput オブジェクト。
使用方法
フィード投稿またはコメントの状況を設定できるのは、「フィード投稿とコメントの承認」権限のあるユーザのみです。
setFeedElementVote(communityId, feedElementId, upDownVote)
API バージョン
41.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.UpDownVoteCapability setFeedElementVote(String communityId, String feedElementId, ConnectApi.UpDownVoteCapabilityInput upDownVote)
パラメータ
- communityId
- 型: String
- コミュニティの 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
- コミュニティの 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
- コミュニティの 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)
パラメータ
updateBookmark(communityId, feedItemId, isBookmarkedByCurrentUser)
指定されたフィード項目にブックマークを付けるか、指定されたフィード項目からブックマークを削除します。
API バージョン
28.0 ～ 31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItem updateBookmark(String communityId, String feedItemId, Boolean isBookmarkedByCurrentUser)
パラメータ
戻り値
updateComment(communityId, commentId, comment)
API バージョン
34.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.Comment updateComment(String communityId, String commentId, ConnectApi.CommentInput comment)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- commentId
- 型: String
- 編集するコメントの ID。
- comment
- 型: ConnectApi.CommentInput
- 編集するコメントに関する情報。
例
updateDirectMessage(communityId, feedElementId, directMessage)
API バージョン
40.0
Chatter が必要かどうか
可
署名
public static ConnectApi.DirectMessageCapability updateDirectMessage(String communityId, String feedElementId, ConnectApi.DirectMessageCapabilityInput directMessage)
パラメータ
- communityId
- 型: String
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElementId
- 型: String
- 編集するフィード要素の ID。フィード要素の種類のうち、編集可能なのはフィード項目のみです。
- feedElement
- 型: ConnectApi.FeedElementInput
- 編集するフィード要素に関する情報。フィード要素の種類のうち、編集可能なのはフィード項目のみです。
フィード投稿を編集する例
質問のタイトルと投稿を編集する例
updateFeedElementBookmarks(communityId, feedElementId, bookmarks)
API バージョン
32.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.BookmarksCapability updateFeedElementBookmarks(String communityId, String feedElementId, ConnectApi.BookmarksCapabilityInput bookmarks)
パラメータ
- communityId
- 型: String
- コミュニティの 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 になります。
例
updateFeedElementReadByCapabilityBatch(communityId, feedElementIds, readBy)
API バージョン
40.0
Chatter が必要かどうか
可
署名
public static ConnectApi.BatchResult[] updateFeedElementReadByCapabilityBatch(String communityId, List<String> feedElementIds, ConnectApi.ReadByCapabilityInput readBy)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedElementIds
- 型: 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
Chatter が必要かどうか
はい
署名
public static ConnectApi.PinCapability updatePinnedFeedElements(String communityId, ConnectApi.FeedType feedType, String subjectId, ConnectApi.PinCapabilityInput pin)
パラメータ
- communityId
- 型: String
- コミュニティの 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
- コミュニティの 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)
パラメータ
戻り値
型: ConnectApi.PollCapability クラス
フィード要素がこの機能をサポートしていない場合、戻り値は ConnectApi.NotFoundException になります。
例
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- このパラメータの有効な値は Company のみです。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザプロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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, 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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped である必要があります。コミュニティを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのコミュニティで常に表示されるフィード要素は除外されます。現在、コミュニティを範囲とするフィード要素には、User または Group 親レコードがあります。ただし、今後、他の親レコードタイプがコミュニティを範囲とする可能性があります。
- 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
- コミュニティの 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、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザプロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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, 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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
- 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
- コミュニティの 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
- コミュニティの 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、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
- コミュニティの 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、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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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 — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかの値にします。
- ファイル
- グループ
- ニュース
- 人
- レコード
- 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
- コミュニティの 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
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (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
- コミュニティの 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 である必要があります。コミュニティを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのコミュニティで常に表示されるフィード要素は除外されます。現在、コミュニティを範囲とするフィード要素には、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
- コミュニティの 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
- コミュニティの 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
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (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
- コミュニティの 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
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザプロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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
- コミュニティの 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
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- customFilter
- 型: String
- ケースフィードにのみ適用されるカスタム検索条件。サポートされる値については、『メタデータ API 開発者ガイド』の customFeedFilter を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、Moderation、および PendingReview です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (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
- コミュニティの 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
- コミュニティの 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、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
- コミュニティの 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、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
- コミュニティの 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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかの値にします。
- ファイル
- グループ
- ニュース
- 人
- レコード
- 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- 次のいずれかの値にします。
- ファイル
- グループ
- ニュース
- 人
- レコード
- 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
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: 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
- コミュニティの ID、internal、または null のいずれかを使���します。
- feedElementId
- 型: String
- フィード要素の ID。フィード要素は質問である必要があります。
- filter
- 型: ConnectApi.RelatedFeedPostType
- 関連フィード投稿の種別を指定します。値は次のとおりです。
- Answered — 1 つ以上の回答がある関連質問。
- BestAnswer — 最良の回答がある関連質問。
- Generic — 回答がある関連質問、最良の回答がある関連質問、回答がない関連質問を含む、すべての種別の関連質問。
- Unanswered — 回答がない関連質問。
- maxResults
- 型: Integer
- 返す結果の最大数。最大 25 件の結果を返すことができます。デフォルト値は 5 です。
- result
- 型: ConnectApi.RelatedFeedPosts
- テストデータを含むオブジェクト。
バージョン 37.0 以降では、関連するフィード投稿は質問です。
戻り値
型: 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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- 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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken の��うに、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- 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
- コミュニティの 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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、Moderation、および PendingReview です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、Home、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザプロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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
- コミュニティの 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 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- 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
- コミュニティの 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、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
- コミュニティの 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、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- コンテキストユーザに表示されるフィード要素に含まれる 1 つ以上の検索キーワード。検索文字列にはワイルドカード文字を含めることができ、ワイルドカード文字を除く 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- filter
- 型: ConnectApi.FeedFilter
- 値は ConnectApi.FeedFilter.CommunityScoped である必要があります。コミュニティを範囲とするフィード要素のみが含まれるようにフィードを絞り込みます。すべてのコミュニティで常に表示されるフィード要素は除外されます。現在、コミュニティを範囲とするフィード要素には、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
- コミュニティの 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、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (true)、否か (false) を指定します。デフォルト値は、false です。
- filter
- 型: ConnectApi.FeedFilter
- フィード条件を指定します。
- AllQuestions — 質問であるフィード要素。
- AuthoredBy — ユーザプロファイル所有者が作成したフィード要素。この値は、UserProfile フィードでのみ有効です。
- CommunityScoped — コミュニティを範囲とするフィード要素。現在、これらのフィード要素には、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード要素のみを表示するか (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
- コミュニティの 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
- コミュニティの 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、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: 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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの 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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Home、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、Landing、Moderation、および PendingReview を除くすべての ConnectApi.FeedType です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateAsc — 作成日の古い順に並び替えられる。この並び替え順は DirectMessageModeration、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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
- コミュニティの 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
- コミュニティの 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、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
- コミュニティの 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、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
- コミュニティの 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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- showInternalOnly
- 型: Boolean
- 内部 (コミュニティ以外の) ユーザからのフィード項目のみを表示するか (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
- コミュニティの 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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、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
- コミュニティの ID、internal、または null のいずれかを使用します。
- feedType
- 型: ConnectApi.FeedType
- フィードの種別。有効な値は、Company、DirectMessageModeration、DirectMessages、Filter、Home、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、Moderation、および PendingReview フィードでのみ使用できます。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- MostViewed — 最も参照回数の多いコンテンツで並び替えます。この並び替え順は、ConnectApi.FeedFilter が UnansweredQuestions の場合に Home フィードでのみ使用できます。
- Relevance — 最も関連性の高いコンテンツで並び替えます。この並び替え順は Company、Home、および Topics フィードで使用できます。
- q
- 型: String
- 必須項目であり、null は無効です。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
- result
- 型: ConnectApi.FeedItemPage
- テストフィード項目ページを指定します。
戻り値
型: 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
- コミュニティの 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
- コミュニティの 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
- コミュニティの 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
- コミュニティの 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
- コミュニティの 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 値に関係なく、すべてのコンテキストユーザのコミュニティからのストリームを取得するかどうかを指定します。
- result
- 型: ConnectApi.ChatterStreamPage
- テストデータを含むオブジェクト。
戻り値
型: Void