ChatterUsers クラス

getFollowings(communityId, userId, pageParam)

ユーザーがフォローしているユーザーおよびレコードのページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FollowingPage getFollowings(String communityId, String userId, Integer pageParam)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。

戻り値

getFollowings(communityId, userId, pageParam, pageSize)

ユーザーがフォローしているユーザーおよびレコードの数を指定してページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FollowingPage getFollowings(String communityId, String userId, Integer pageParam, Integer pageSize)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getFollowings(communityId, userId, filterType)

ユーザーがフォローしている、キープレフィックスで絞り込まれたレコードの最初のページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FollowingPage getFollowings(String communityId, String userId, String filterType)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
filterType: 型: String; 返されるオブジェクトの種別を絞り込みするためのキープレフィックスを指定します。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。

戻り値

getFollowings(communityId, userId, filterType, pageParam)

ユーザーがフォローしている、キープレフィックスで絞り込まれたレコードのページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FollowingPage getFollowings(String communityId, String userId, String filterType, Integer pageParam)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
filterType: 型: String; 返されるオブジェクトの種別を絞り込みするためのキープレフィックスを指定します。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。

戻り値

getFollowings(communityId, userId, filterType, pageParam, pageSize)

ユーザーがフォローしている、キープレフィックスで絞り込まれたレコードの数を指定してページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.FollowingPage getFollowings(String communityId, String userId, String filterType, Integer pageParam, Integer pageSize)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
filterType: 型: String; 返されるオブジェクトの種別を絞り込みするためのキープレフィックスを指定します。キープレフィックスは、オブジェクト ID の先頭 3 文字で、オブジェクト種別を示します。たとえば、User オブジェクトのプレフィックスは 005、Group オブジェクトのプレフィックスは 0F9 です。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getReputation(communityId, userId)

ユーザーの評価を取得します。

API バージョン

32.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Reputation getReputation(String communityId, String userId)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。

戻り値

型: ConnectApi.Reputation

getUser(communityId, userId)

ユーザーに関する情報を取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserSummary getUser(String communityId, String userId)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。

戻り値

型: ConnectApi.UserDetail

使用方法

外部ユーザーの場合、ConnectApi.UserDetail 出力クラスが ConnectApi.UserSummary 出力クラスと共有するプロパティに null 以外の値が設定されている可能性があります。その他のプロパティは常に null です。

getUserBatch(communityId, userIds)

ユーザーのリストに関する情報を取得します。

API バージョン

31.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.BatchResult[] getUserBatch(String communityId, List<String> userIds)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userIds: 型: List<String>; 最大 500 件のユーザー ID のリスト。

戻り値

型: ConnectApi.BatchResult[]

ConnectApi.BatchResult.getResult() メソッドは、ConnectApi.User オブジェクトと、読み込まれなかったユーザーのエラーを返します。

例

1// Get users in an organization.
2ConnectApi.UserPage userPage = ConnectApi.ChatterUsers.getUsers(null);
3
4// Create a list of user IDs.
5List<String> userList = new List<String>();
6for (ConnectApi.User user : userPage.users){
7    userList.add(user.id); 
8}
9
10// Get info about all users in the list.
11ConnectApi.BatchResult[] batchResults = ConnectApi.ChatterUsers.getUserBatch(null, userList);
12
13for (ConnectApi.BatchResult batchResult : batchResults) {
14    if (batchResult.isSuccess()) {
15        // Operation was successful. 
16        // Print each user's username.
17        ConnectApi.UserDetail user;
18        if(batchResult.getResult() instanceof ConnectApi.UserDetail) {
19            user = (ConnectApi.UserDetail) batchResult.getResult();
20        }
21        System.debug('SUCCESS');
22        System.debug(user.username);
23    }
24    else {
25        // Operation failed. Print errors.
26        System.debug('FAILURE');
27        System.debug(batchResult.getErrorMessage());
28    }
29}

getUserGroups(communityId, userId)

ユーザーのグループを取得します。

API バージョン

45.0

ゲストユーザーが使用可能

45.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupDetailPage getUserGroups(String communityId, String userId)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。

戻り値

getUserGroups(communityId, userId, pageParam, pageSize)

ユーザーのグループのページを取得します。

API バージョン

45.0

ゲストユーザーが使用可能

45.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupDetailPage getUserGroups(String communityId, String userId, Integer pageParam, Integer pageSize)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getUsers(communityId)

ユーザーの最初のページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserPage getUsers(String communityId)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。

戻り値

getUsers(communityId, pageParam, pageSize)

ユーザーのページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserPage getUsers(String communityId, Integer pageParam, Integer pageSize)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

purgeUserActivities(communityId, userId)

Chatter 関連のユーザー活動 (ブッ��マーク、トピックの支持、投票など) を消去するジョブを開始します。

API バージョン

42.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserActivitiesJob purgeUserActivities(String communityId, String userId)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。

戻り値

型: ConnectApi.UserActivitiesJob

使用方法

このメソッドで次の活動を消去できます。

Bookmark — ユーザーが投稿をブックマークしました。
ChatterActivity — ユーザーによる投稿およびコメントと、ユーザーが受信したいいね! およびコメントの合計数。
ChatterLike — ユーザーが投稿またはコメントにいいね! しました。
CompanyVerify — ユーザーがコメントを検証しました。
DownVote — ユーザーが投稿またはコメントにマイナス投票しました。
FeedEntityRead — ユーザーが投稿を閲覧しました。
FeedRead — ユーザーがフィードを閲覧しました。
Mute — ユーザーが投稿をミュートしました。
TopicEndorsement — ユーザーがあるトピックに関して別のユーザーを支持したか、支持を受けました。
UpVote — ユーザーが投稿またはコメントにプラス投票しました。

ユーザーの投稿やコメントを削除するには、それぞれ次のメソッドを使用します。

searchUserGroupDetails(communityId, userId, q)

検索条件に一致するユーザーのグループを取得します。

API バージョン

45.0

ゲストユーザーが使用可能

45.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupDetailPage searchUserGroupDetails(String communityId, String userId, String q)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
q: 型: String; 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

searchUserGroupDetails(communityId, userId, q, pageParam, pageSize)

検索条件に一��するユーザーのグループのページを取得します。

API バージョン

45.0

ゲストユーザーが使用可能

45.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupDetailPage searchUserGroupDetails(String communityId, String userId, String q, Integer pageParam, Integer pageSize)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
q: 型: String; 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

searchUsers(communityId, q)

検索条件に一致するユーザーの最初のページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserPage searchUsers(String communityId, String q)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
q: 型: String; 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

使用方法

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

searchUsers(communityId, q, pageParam, pageSize)

検索条件に一致するユーザーのページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserPage searchUsers(String communityId, String q, Integer pageParam, Integer pageSize)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
q: 型: String; 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

使用方法

searchUsers(communityId, q, searchContextId, pageParam, pageSize)

検索条件に一致するユーザーのページを取得します。

API バージョン

28.0

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserPage searchUsers(String communityId, String q, String searchContextId, Integer pageParam, Integer pageSize)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
q: 型: String; 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
searchContextId: 型: String; フィード @メンションの検索結果を絞り込むフィード項目 ID。最も役に立つ結果が最初に表示されます。この引数を指定する場合は、500 件を超える結果を照会できず、検索語にワイルドカードも使用できません。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

型: ConnectApi.GroupEmailFrequency

使用方法

updateChatterSettings(communityId, userId, defaultGroupEmailFrequency)

ユーザーのデフォルトの Chatter 設定を更新します。

API バージョン

28.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserChatterSettings updateChatterSettings(String communityId, String userId, ConnectApi.GroupEmailFrequency defaultGroupEmailFrequency)

パラメーター

communityId

型: String

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

userId

型: String

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

defaultGroupEmailFrequency

ユーザーがメールを受信する頻度。値は次のとおりです。

EachPost
DailyDigest
WeeklyDigest
Never
UseDefault

updateChatterSettings をコールするとデフォルト値が設定されるため、defaultGroupEmailFrequency パラメーターに UseDefault 値を渡さないでください。

戻り値

型: ConnectApi.UserChatterSettings

updateUser(communityId, userId, userInput)

ユーザーの [自己紹介] セクションを更新します。

API バージョン

29.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserDetail updateUser(String communityId, String userId, ConnectApi.UserInput userInput)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; コンテキストユーザーの ID またはキーワード me。
userInput: 型: ConnectApi.UserInput; 更新情報を指定します。

戻り値

型: ConnectApi.UserDetail

ChatterUsers テストメソッド

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

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

setTestSearchUsers(communityId, q, result)

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

API バージョン

28.0

署名

public static Void setTestSearchUsers(String communityId, String q, ConnectApi.UserPage result)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
q: 型: String; 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
result: 型: ConnectApi.UserPage; テストデータを含むオブジェクト。

戻り値

型: Void

setTestSearchUsers(communityId, q, pageParam, pageSize, result)

API バージョン

28.0

署名

public static Void setTestSearchUsers(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.UserPage result)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
q: 型: String; 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
result: 型: ConnectApi.UserPage; テストデータを含むオブジェクト。

戻り値

型: Void

setTestSearchUsers(communityId, q, searchContextId, pageParam, pageSize, result)

API バージョン

28.0

署名

public static Void setTestSearchUsers(String communityId, String q, String searchContextId, Integer pageParam, Integer pageSize, ConnectApi.UserPage result)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
q: 型: String; 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
searchContextId: 型: String; フィード @メンションの検索結果を絞り込むフィード項目 ID。最も役に立つ結果が最初に表示されます。この引数を指定する場合は、500 件を超える結果を照会できず、検索語にワイルドカードも使用できません。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。
result: 型: ConnectApi.UserPage; テストデータを含むオブジェクト。

戻り値

型: Void

廃止された ChatterUsers のメソッド

廃止された ChatterUsers のメソッドは次のとおりです。

deletePhoto(communityId, userId)

ユーザーの写真を削除します。

API バージョン

28.0 ～ 34.0

バージョン 35.0 以降では、ConnectApi.UserProfiles.deletePhoto(communityId, userId) を使用します。

重要

署名

public static Void deletePhoto(String communityId, String userId)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; コンテキストユーザーの ID またはキーワード me。

戻り値

型: Void

getGroups(communityId, userId)

ユーザーがメンバーであるグループを取得します。

API バージョン

28.0 ～ 44.0

バージョン 45.0 以降では、getUserGroups(communityId, userId) を使用します。

重要

ゲストユーザーが使用可能

32.0 ～ 44.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupPage getGroups(String communityId, String userId)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。

戻り値

getGroups(communityId, userId, pageParam, pageSize)

ユーザーがメンバーであるグループのページを取得します。

API バージョン

28.0 ～ 44.0

バージョン 45.0 以降では、getUserGroups(communityId, userId, pageParam, pageSize) を使用します。

重要

ゲストユーザーが使用可能

32.0 ～ 44.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupPage getGroups(String communityId, String userId, Integer pageParam, Integer pageSize)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値

getPhoto(communityId, userId)

ユーザーの写真を取得します。

API バージョン

28.0 ～ 34.0

バージョン 35.0 以降では、ConnectApi.UserProfiles.getPhoto(communityId, userId) を使用します。

重要

ゲストユーザーが使用可能

32.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.Photo getPhoto(String communityId, String userId)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。

戻り値

型: ConnectApi.Photo

searchUserGroups(communityId, userId, q)

検索条件に一致するユーザーのグループを取得します。

API バージョン

30.0 ～ 44.0

バージョン 45.0 以降では、searchUserGroupDetails(communityId, userId, q) を使用します。

重要

ゲストユーザーが使用可能

32.0 ～ 44.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupPage searchUserGroups(String communityId, String userId, String q)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
q: 型: String; 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。

戻り値

searchUserGroups(communityId, userId, q, pageParam, pageSize)

検索条件に一致するユーザーのグループのページを取得します。

API バージョン

30.0 ～ 44.0

バージョン 45.0 以降では、searchUserGroupDetails(communityId, userId, q, pageParam, pageSize) を使用します。

重要

ゲストユーザーが使用可能

32.0 ～ 44.0

Chatter が必要かどうか

はい

署名

public static ConnectApi.UserGroupPage searchUserGroups(String communityId, String userId, String q, Integer pageParam, Integer pageSize)

パラメーター

communityId: 型: String; Experience Cloud サイトの ID、internal、または null。
userId: 型: String; ユーザーの ID。
q: 型: String; 必須。null にすることはできません。検索する文字列を指定します。検索文字列にはワイルドカード文字を除いて 2 文字以上が含まれている必要があります。「ワイルドカード」を参照してください。
pageParam: 型: Integer; 返すページの数。0 から開始します。null または 0 を渡すと、最初のページが返されます。
pageSize: 型: Integer; ページあたりの項目数を指定します。有効な値は 1 ～ 100 です。null を渡すと、デフォルトサイズの 25 に設定されます。

戻り値