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 に設定されます。

戻り値