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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.
pageParam: Type: Integer; 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.
pageParam: Type: Integer; 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; 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; 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; 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; 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

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; ID for an Experience Cloud site, 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; 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; ID for an Experience Cloud site, 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

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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.
pageParam: Type: Integer; 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; ID for an Experience Cloud site, 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; ID for an Experience Cloud site, internal, or null.
pageParam: Type: Integer; 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; ID for an Experience Cloud site, 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.
q: Type: String; Required and can’t 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: Integer; 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; ID for an Experience Cloud site, internal, or null.
q: Type: String; Required and can’t 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; ID for an Experience Cloud site, internal, or null.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: Integer; 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; ID for an Experience Cloud site, internal, or null.
q: Type: String; Required and can’t 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; 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

Type: ConnectApi.GroupEmailFrequency

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.

updateChatterSettings(communityId, userId, defaultGroupEmailFrequency)

Update the default Chatter settings for a user.

API Version

28.0

Requires Chatter

Yes

Signature

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

Parameters

communityId

Type: String

ID for an Experience Cloud site, internal, or null.

userId

Type: String

ID for the context user or the keyword me.

defaultGroupEmailFrequency

Frequency with which a user receives email. Values are:

EachPost
DailyDigest
WeeklyDigest
Never
UseDefault

Don’t pass the value UseDefault for the defaultGroupEmailFrequency parameter because calling updateChatterSettings sets the default value.

Return Value

Type: ConnectApi.UserChatterSettings

updateUser(communityId, userId, userInput)

Update the About Me section for a user.

API Version

29.0

Requires Chatter

Yes

Signature

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

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for the context user or the keyword me.
userInput: Type: ConnectApi.UserInput; Specifies the updated information.

Return Value

Type: ConnectApi.UserDetail

ChatterUsers Test Methods

These test methods are for ChatterUsers. All methods are static.

For information about using these methods to test your ConnectApi code, see Testing ConnectApi Code.

setTestSearchUsers(communityId, q, result)

Register a ConnectApi.UserPage object to be returned when the matching ConnectApi.searchUsers method is called in a test context. Use the method with the same parameters or you receive an exception.

API Version

28.0

Signature

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

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
result: Type: ConnectApi.UserPage; Object containing test data.

Return Value

Type: Void

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

API Version

28.0

Signature

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

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: Integer; 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.
result: Type: ConnectApi.UserPage; Object containing test data.

Return Value

Type: Void

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

API Version

28.0

Signature

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

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
q: Type: String; Required and can’t 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; 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.
result: Type: ConnectApi.UserPage; Object containing test data.

Return Value

Type: Void

Retired ChatterUsers Methods

These methods for ChatterUsers are retired.

All methods in this class require Chatter and are subject to the per user, per namespace, per hour rate limit.

deletePhoto(communityId, userId)

Delete a user’s photo.

API Version

28.0–34.0

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

Important

Signature

public static Void deletePhoto(String communityId, String userId)

Parameters

communityId: Type: String; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for the context user or the keyword me.

Return Value

Type: Void

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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.
pageParam: Type: Integer; 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.

Return Value

Type: ConnectApi.Photo

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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.
q: Type: String; Required and can’t 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; ID for an Experience Cloud site, internal, or null.
userId: Type: String; ID for a user.
q: Type: String; Required and can’t be null. Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.
pageParam: Type: Integer; 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