Force.com Apex コード開発者ガイド
jChatterFavorites クラス
名前空間
使用方法
Chatter in Apex を使用して、お気に入りとして追加されたトピック、リストビュー、およびフィード検索を取得および削除します。トピックとフィード検索をお気に入りとして追加し、フィード検索またはリストビューフィードの最終参照日付を現在のシステム時間に更新します。
Salesforce の次の画像では、トピックが「Build Issues」で、リストビューが「All Accounts」であり、フィード検索が「United」です。
ChatterFavorites メソッド
ChatterFavorites のメソッドは次のとおりです。すべてのメソッドが静的です。
addFavorite(communityId, subjectId, searchText)
API バージョン
28.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedFavorite addFavorite(String communityId, String subjectId, String searchText)
パラメータ
戻り値
addRecordFavorite(communityId, subjectId, targetId)
API バージョン
28.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedFavorite addRecordFavorite(String communityId, String subjectId, String targetId)
パラメータ
戻り値
deleteFavorite(communityId, subjectId, favoriteId)
API バージョン
28.0
Chatter が必要かどうか
はい
署名
public static Void deleteFavorite(String communityId, String subjectId, String favoriteId)
パラメータ
戻り値
型: Void
getFavorite(communityId, subjectId, favoriteId)
API バージョン
28.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedFavorite getFavorite(String communityId, String subjectId, String favoriteId)
パラメータ
戻り値
getFavorites(communityId, subjectId)
API バージョン
28.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedFavorites getFavorites(String communityId, String subjectId)
パラメータ
戻り値
getFeedElements(communityId, subjectId, favoriteId)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElements(String communityId, String subjectId, String favoriteId)
パラメータ
戻り値
使用方法
��のメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getFeedElements(communityId, subjectId, favoriteId, pageParam, pageSize, sortParam)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElements(String communityId, String subjectId, String favoriteId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me。
- favoriteId
- 型: String
- お気に入りの ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getFeedElements(communityId, subjectId, favoriteId, recentCommentCount, elementsPerBundle, pageParam, pageSize, sortParam)
API バージョン
31.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedElementPage getFeedElements(String communityId, String subjectId, String favoriteId, Integer recentCommentCount, Integer elementsPerBundle, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me。
- favoriteId
- 型: String
- お気に入りの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は 3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getFeedItems(communityId, subjectId, favoriteId)
API バージョン
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItems(String communityId, String subjectId, String favoriteId)
パラメータ
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getFeedItems(communityId, subjectId, favoriteId, pageParam, pageSize, sortParam)
API バージョン
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItems(String communityId, String subjectId, String favoriteId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me。
- favoriteId
- 型: String
- お気に入りの ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
getFeedItems(communityId, subjectId, favoriteId, recentCommentCount, pageParam, pageSize, sortParam)
API バージョン
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedItemPage getFeedItems(String communityId, String subjectId, String favoriteId, Integer recentCommentCount, String pageParam, Integer pageSize, FeedSortOrder sortParam)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me。
- favoriteId
- 型: String
- お気に入りの ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は 3 です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: FeedSortOrder
- 値は次のとおりです。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
戻り値
使用方法
このメソッドを使用するコードをテストするには、一致する set test メソッドを使用します (メソッド名に setTest をプレフィックスとして付けます)。set test メソッドでは、同じパラメータを使用します。パラメータが同じでないと、コードで例外が発生します。
updateFavorite(communityId, subjectId, favoriteId, updateLastViewDate)
API バージョン
28.0
Chatter が必要かどうか
はい
署名
public static ConnectApi.FeedFavorite updateFavorite(String communityId, String subjectId, String favoriteId, Boolean updateLastViewDate)
パラメータ
戻り値
ChatterFavorites テストメソッド
ChatterFavorites のテストメソッドを次に示します。すべてのメソッドが静的です。
これらのメソッドを使用して ConnectApi コードをテストする方法の詳細は、「ConnectApi コードのテスト」を参照してください。
setTestGetFeedElements(communityId, subjectId, favoriteId, result)
API バージョン
31.0
署名
public static Void setTestGetFeedElements(String communityId, String subjectId, String favoriteId, ConnectApi.FeedElementPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me。
- favoriteId
- 型: String
- お気に入りの ID。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElements(communityId, subjectId, favoriteId, pageParam, pageSize, sortParam, result)
API バージョン
31.0
署名
public static Void setTestGetFeedElements(String communityId, String subjectId, String favoriteId, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me。
- favoriteId
- 型: String
- お気に入りの ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedElements(communityId, subjectId, favoriteId, recentCommentCount, elementsPerClump, pageParam, pageSize, sortParam, result)
API バージョン
31.0
署名
public static Void setTestGetFeedElements(String communityId, String subjectId, String favoriteId, Integer recentCommentCount, Integer elementsPerClump, String pageParam, Integer pageSize, ConnectApi.FeedSortOrder sortParam, ConnectApi.FeedElementPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me。
- favoriteId
- 型: String
- お気に入りの ID。
- recentCommentCount
- 型: Integer
- フィード要素ごとに返されるコメントの最大数。デフォルト値は 3 です。
- elementsPerBundle
- 型: Integer
- バンドルあたりの最大フィード要素数。デフォルトおよび最大値は、10 です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード要素数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: ConnectApi.FeedSortOrder
- 値は次のとおりです。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- result
- 型: ConnectApi.FeedElementPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItems(communityId, subjectId, favoriteId, result)
API バージョン
28.0 ～ 31.0
署名
public static Void setTestGetFeedItems(String communityId, String subjectId, String favoriteId, ConnectApi.FeedItemPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me を指定します。
- favoriteId
- 型: String
- お気に入りの ID。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItems(communityId, subjectId, favoriteId, pageParam, pageSize, sortParam, result)
API バージョン
28.0 ～ 31.0
署名
public static Void setTestGetFeedItems(String communityId, String subjectId, String favoriteId, String pageParam, Integer pageSize, FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me を指定します。
- favoriteId
- 型: String
- お気に入りの ID。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: FeedSortOrder
- 値は次のとおりです。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void
setTestGetFeedItems(communityId, subjectId, favoriteId, recentCommentCount, pageParam, pageSize, sortParam, result)
API バージョン
29.0 ～ 31.0
署名
public static Void setTestGetFeedItems(String communityId, String subjectId, String favoriteId, Integer recentCommentCount, String pageParam, Integer pageSize, FeedSortOrder sortParam, ConnectApi.FeedItemPage result)
パラメータ
- communityId
- 型: String
- コミュニティの ID、internal、または null のいずれかを使用します。
- subjectId
- 型: String
- コンテキストユーザの ID または別名 me を指定します。
- favoriteId
- 型: String
- お気に入りの ID。
- recentCommentCount
- 型: Integer
- フィード項目ごとに返されるコメントの最大数。デフォルト値は 3 です。
- pageParam
- 型: String
- ページの表示に使用するページトークン。ページトークンは、currentPageToken または nextPageToken のように、応答クラスの一部として返されます。null を渡すと、最初のページが返されます。
- pageSize
- 型: Integer
- ページあたりのフィード項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
- sortParam
- 型: FeedSortOrder
- 値は次のとおりです。
- CreatedDateDesc — 作成日の新しい順に並び替えます。
- LastModifiedDateDesc — 活動の新しい順に並び替えられます。
- result
- 型: ConnectApi.FeedItemPage
- テストデータを含むオブジェクト。
戻り値
型: Void