この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Force.com Apex コード開発者ガイド

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ChatterFavorites クラス

Chatter のお気に入りを使用すると、トピック、リストビュー、およびフィード検索に簡単にアクセスできます。

名前空間

ConnectApi

使用方法

Chatter in Apex を使用して、お気に入りとして追加されたトピック、リストビュー、およびフィード検索を取得および削除します。トピックとフィード検索をお気に入りとして追加し、フィード検索またはリストビューフィードの最終参照日付を現在のシステム時間に更新します。

Salesforce の次の画像では、トピックが「Build Issues」で、リストビューが「All Accounts」であり、フィード検索が「United」です。Web UI の Chatter の「お気に入り」

ChatterFavorites メソッド

ChatterFavorites のメソッドは次のとおりです。すべてのメソッドが静的です。

addFavorite(String, String, String)

指定されたコミュニティの指定されたユーザのフィード検索のお気に入りを追加します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId
型: String
コミュニティの ID、internal、または null のいずれかを使用します。
subjectId
型: String
コンテキストユーザの ID または別名 me を指定します。
searchText
型: String
お気に入りとして保存する検索のテキストを指定します。このメソッドでは、リストビューのお気に入りまたはトピックではなく、フィード検索のお気に入りのみを作成できます。

戻り値

型: ConnectApi.FeedFavorite

addRecordFavorite(String, String, String)

トピックをお気に入りとして追加します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId
型: String
コミュニティの ID、internal、または null のいずれかを使用します。
subjectId
型: String
コンテキストユーザの ID または別名 me を指定します。
targetId
型: String
お気に入りとして追加するトピックの ID。

戻り値

型: ConnectApi.FeedFavorite

deleteFavorite(String, String, String)

指定されたお気に入りを削除します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId
型: String
コミュニティの ID、internal、または null のいずれかを使用します。
subjectId
型: String
コンテキストユーザの ID または別名 me を指定します。
favoriteId
型: String
お気に入りの ID。

戻り値

型: Void

getFavorite(String, String, String)

お気に入りの説明を返します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId
型: String
コミュニティの ID、internal、または null のいずれかを使用します。
subjectId
型: String
コンテキストユーザの ID または別名 me を指定します。
favoriteId
型: String
お気に入りの ID。

戻り値

型: ConnectApi.FeedFavorite

getFavorites(String, String)

指定されたコミュニティの指定されたユーザのすべてのお気に入りリストを返します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId
型: String
コミュニティの ID、internal、または null のいずれかを使用します。
subjectId
型: String
コンテキストユーザの ID または別名 me を指定します。

戻り値

型: ConnectApi.FeedFavorites

getFeedElements(String, String, String)

指定されたコミュニティの指定されたお気に入りのフィード要素の最初のページを返します。

API バージョン

31.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId
型: String
コミュニティの ID、internal、または null のいずれかを使用します。
subjectId
型: String
コンテキストユーザの ID または別名 me。
favoriteId
型: String
お気に入りの ID。

戻り値

型: ConnectApi.FeedElementPage

使用方法

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

getFeedElements(String, String, String, String, Integer, ConnectApi.FeedSortOrder)

指定された順番で、指定されたコミュニティ内の指定されたお気に入りのフィード要素の指定されたページを返します。

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 — 活動の新しい順に並び替えられます。
最近作成されたフィード要素、または最近変更されたフィード要素ごとに、返されたフィードが並び替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

戻り値

型: ConnectApi.FeedElementPage

使用方法

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

getFeedElements(String, String, String, Integer, Integer, String, Integer, ConnectApi.FeedSortOrder)

指定された順番で、指定されたコミュニティ内の指定されたお気に入りのフィード要素の指定されたページを返します。フィード要素ごとに指定された数以内のコメント数が含まれます。

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 — 活動の新しい順に並び替えられます。
最近作成されたフィード要素、または最近変更されたフィード要素ごとに、返されたフィードが並び替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

戻り値

型: ConnectApi.FeedElementPage

使用方法

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

getFeedItems(String, String, String)

指定されたコミュニティの指定されたお気に入りのフィード項目の最初のページを返します。ページには、デフォルトの項目数が含まれます。

API バージョン

28.0 ～ 31.0

バージョン 32.0 以降では、getFeedElements(String, String, String)を使用します。

重要

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId
型: String
コミュニティの ID、internal、または null のいずれかを使用します。
subjectId
型: String
コンテキストユーザの ID または別名 me。
favoriteId
型: String
お気に入りの ID。

戻り値

型: ConnectApi.FeedItemPage

使用方法

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

getFeedItems(String, String, String, String, Integer, ConnectApi.FeedSortOrder)

指定された順番で、指定されたコミュニティ内の指定されたお気に入りのフィード項目の指定されたページを返します。

API バージョン

28.0 ～ 31.0

バージョン 32.0 以降では、getFeedElements(String, String, String, String, Integer, ConnectApi.FeedSortOrder)を使用します。

重要

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 — 活動の新しい順に並び替えられます。
最近作成されたフィード項目、または最近変更されたフィード項目ごとに、返されたフィードが並び替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

戻り値

型: ConnectApi.FeedItemPage

使用方法

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

getFeedItems(String, String, String, Integer, String, Integer, FeedSortOrder)

指定された順番で、指定されたコミュニティ内の指定されたお気に入りのフィード項目の指定されたページを返します。フィード項目ごとに指定された数以内のコメント数が含まれます。

API バージョン

29.0 ～ 31.0

バージョン 32.0 以降では、getFeedElements(String, String, String, Integer, Integer, String, Integer, ConnectApi.FeedSortOrder)を使用します。

重要

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 — 活動の新しい順に並び替えられます。
最近作成されたフィード項目、または最近変更されたフィード項目ごとに、返されたフィードが並び替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。

戻り値

型: ConnectApi.FeedItemPage

使用方法

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

updateFavorite(String, String, String, Boolean)

updateLastViewDate に true を指定すると、保存された検索またはリストビューフィードの最終参照日付が現在のシステム時間に更新されます。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

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

パラメータ

communityId
型: String
コミュニティの ID、internal、または null のいずれかを使用します。
subjectId
型: String
コンテキストユーザの ID または別名 me を指定します。
favoriteId
型: String
お気に入りの ID。
updateLastViewDate
型: Boolean
指定されたお気に入りの最終参照日付を現在のシステム時間に更新するか (true)、否か (false) を指定します。

戻り値

型: ConnectApi.FeedFavorite

ChatterFavorites テストメソッド

ChatterFavorites のテストメソッドを次に示します。すべてのメソッドが静的です。

これらのメソッドを使用して ConnectApi コードをテストする方法の詳細は、ConnectApi コードのテストを参照してください。

setTestGetFeedElements(String, String, String, ConnectApi.FeedElementPage)

テストコンテキストの一致するパラメータで getFeedElements​ をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。このメソッドでは、必ず同じパラメータを使用する必要があります。パラメータが同じでないと、コードで例外が発生します。

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(String, String, String, String, Integer, ConnectApi.FeedSortOrder, ConnectApi.FeedElementPage)

テストコンテキストの一致するパラメータで getFeedElements​ をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。このメソッドでは、必ず同じパラメータを使用する必要があります。パラメータが同じでないと、コードで例外が発生します。

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 — 活動の新しい順に並び替えられます。
最近作成されたフィード要素、または最近変更されたフィード要素ごとに、返されたフィードが並び替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。
result
型: ConnectApi.FeedElementPage
テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetFeedElements(String, String, String, Integer, Integer, String, Integer, ConnectApi.FeedSortOrder, ConnectApi.FeedElementPage)

テストコンテキストの一致するパラメータで getFeedElements​ をコールするときに返される ConnectApi.FeedElementPage オブジェクトを登録します。このメソッドでは、必ず同じパラメータを使用する必要があります。パラメータが同じでないと、コードで例外が発生します。

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 — 活動の新しい順に並び替えられます。
最近作成されたフィード要素、または最近変更されたフィード要素ごとに、返されたフィードが並び替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。
result
型: ConnectApi.FeedElementPage
テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetFeedItems(String, String, String, ConnectApi.FeedItemPage)

テストコンテキストの一致するパラメータで getFeedItems​ をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。このメソッドでは、必ず同じパラメータを使用する必要があります。パラメータが同じでないと、コードで例外が発生します。

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(String, String, String, String, Integer, FeedSortOrder, ConnectApi.FeedItemPage)

テストコンテキストの一致するパラメータで getFeedItems​ をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。このメソッドでは、必ず同じパラメータを使用する必要があります。パラメータが同じでないと、コードで例外が発生します。

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 — 活動の新しい順に並び替えられます。
最近作成されたフィード項目、または最近変更されたフィード項目ごとに、返されたフィードが並び替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。
result
型: ConnectApi.FeedItemPage
テストデータを含むオブジェクト。

戻り値

型: Void

setTestGetFeedItems(String, String, String, Integer, String, Integer, FeedSortOrder, ConnectApi.FeedItemPage)

テストコンテキストの一致するパラメータで getFeedItems​ をコールするときに返される ConnectApi.FeedItemPage オブジェクトを登録します。このメソッドでは、必ず同じパラメータを使用する必要があります。パラメータが同じでないと、コードで例外が発生します。

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 — 活動の新しい順に並び替えられます。
最近作成されたフィード項目、または最近変更されたフィード項目ごとに、返されたフィードが並び替えられます。null を渡すと、デフォルト値の CreatedDateDesc が使用されます。
result
型: ConnectApi.FeedItemPage
テストデータを含むオブジェクト。

戻り値

型: Void