ChatterUsers Class

getFollowings(communityId, userId, pageParam)

Get a page of users and records that a user follows.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

Return Value

getFollowings(communityId, userId, pageParam, pageSize)

Get a page with the specified number of users and records that a user follows.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getFollowings(communityId, userId, filterType)

Get the first page of records, filtered by key prefix, that a user follows.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
filterType: Type: String; Specifies the key prefix to filter the type of objects returned. A key prefix is the first three characters of the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.

Return Value

getFollowings(communityId, userId, filterType, pageParam)

Get a page of records, filtered by key prefix, that a user follows.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
filterType: Type: String; Specifies the key prefix to filter the type of objects returned. A key prefix is the first three characters of the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.

Return Value

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

Get a page with the specified number of records, filtered by key prefix, that a user follows.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
filterType: Type: String; Specifies the key prefix to filter the type of objects returned. A key prefix is the first three characters of the object ID, which specifies the object type. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getGroups(communityId, userId)

Get the groups that a user is a member of.

API Version

28.0–44.0

In version 45.0 and later, use getUserGroups(communityId, userId).

Important

Available to Guest Users

32.0–44.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.

Return Value

getGroups(communityId, userId, pageParam, pageSize)

Get a page of groups that a user is a member of.

API Version

28.0–44.0

In version 45.0 and later, use getUserGroups(communityId, userId, pageParam, pageSize).

Important

Available to Guest Users

32.0–44.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getPhoto(communityId, userId)

Get a user’s photo.

API Version

28.0–34.0

In version 35.0 and later, use ConnectApi.UserProfiles.getPhoto(communityId, userId).

Important

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.

Return Value

Type: ConnectApi.Photo

getReputation(communityId, userId)

Get a user’s reputation.

API Version

32.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; ID of the user.

Return Value

Type: ConnectApi.Reputation

getUser(communityId, userId)

Get information about a user.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.

Return Value

Type: ConnectApi.UserDetail

Usage

If the user is external, the properties that the ConnectApi.UserDetail output class shares with the ConnectApi.UserSummary output class can have non-null values. Other properties are always null.

getUserBatch(communityId, userIds)

Get information about a list of users.

API Version

31.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userIds: Type: List<String>; A list of up to 500 user IDs.

Return Value

Type: ConnectApi.BatchResult[]

The ConnectApi.BatchResult.getResult() method returns a ConnectApi.User object and errors for users that didn’t load.

Example

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)

Get a user’s groups.

API Version

45.0

Available to Guest Users

45.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.

Return Value

getUserGroups(communityId, userId, pageParam, pageSize)

Get a page of a user’s groups.

API Version

45.0

Available to Guest Users

45.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

getUsers(communityId)

Get the first page of users.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

public static ConnectApi.UserPage getUsers(String communityId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.

Return Value

getUsers(communityId, pageParam, pageSize)

Get a page of users.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

purgeUserActivities(communityId, userId)

Start a job to purge Chatter-related user activity, such as bookmarks, topic endorsements, and votes.

API Version

42.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; ID of the user.

Return Value

Type: ConnectApi.UserActivitiesJob

Usage

The following activities can be purged with this method.

Bookmark—User bookmarked a post.
ChatterActivity—Total counts of posts and comments made and likes and comments received for a user.
ChatterLike—User liked a post or comment.
CompanyVerify—User verified comment.
DownVote—User downvoted a post or comment.
FeedEntityRead—User read a post.
FeedRead—User read a feed.
Mute—User muted a post.
TopicEndorsement—User endorsed another user on a topic or received endorsement on a topic.
UpVote—User upvoted a post or comment.

To delete a user’s posts and comments, use these methods, respectively.

searchUserGroupDetails(communityId, userId, q)

Get the user’s groups that match the search criteria.

API Version

45.0

Available to Guest Users

45.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

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

Get a page of a user’s groups that match the search criteria.

API Version

45.0

Available to Guest Users

45.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

searchUserGroups(communityId, userId, q)

Get the user’s groups that match the search criteria.

API Version

30.0–44.0

In version 45.0 and later, use searchUserGroupDetails(communityId, userId, q).

Important

Available to Guest Users

32.0–44.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

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

Get a page of a user’s groups that match the search criteria.

API Version

30.0–44.0

In version 45.0 and later, use searchUserGroupDetails(communityId, userId, q, pageParam, pageSize).

Important

Available to Guest Users

32.0–44.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
userId: Type: String; The ID for a user.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

searchUsers(communityId, q)

Get the first page of users that match the search criteria.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

searchUsers(communityId, q, pageParam, pageSize)

Get a page of users that match the search criteria.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value

Usage

To test code that uses this method, use the matching set test method (prefix the method name with setTest). Use the set test method with the same parameters or the code throws an exception.

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

Get a page of users that match the search criteria.

API Version

28.0

Available to Guest Users

32.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; Required and cannot be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
searchContextId: Type: String; A feed item ID that filters search results for feed @mentions. More useful results are listed first. When you specify this argument, you cannot query more than 500 results and you cannot use wildcards in the search term.
pageParam: Type: Integer; Specifies the number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned.
pageSize: Type: Integer; Specifies the number of items per page. Valid values are from 1 through 100. If you pass in null, the default size is 25.

Return Value