Newer Version Available

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

ChatterGroups Class

Information about groups, such as the group’s members, photo, and the groups the specified user is a member of. Add members to a group, remove members, and change the group photo.

Namespace

ConnectApi

ChatterGroups Methods

The following are methods for ChatterGroups. All methods are static.

addMember(String, String, String)

Adds the specified user to the specified group in the specified community as a standard member. To execute this method, the context user must be the group owner or moderator.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMember addMember(String communityId, String groupId, String userId)

Parameters

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

Return Value

Type: ConnectApi.GroupMember

addMemberWithRole(String, String, String, ConnectApi.GroupMembershipType)

Adds the specified user with the specified role to the specified group in the specified community. To execute this method, the context user must be the group owner or moderator.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMember addMemberWithRole(String communityId, String groupId, String userId, ConnectApi.GroupMembershipType role)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

groupId

Type: String

The ID for a group.

userId

Type: String

The ID for a user.

role

Type: ConnectApi.GroupMembershipType

The group membership type. One of these values:

GroupManager
StandardMember

Return Value

Type: ConnectApi.GroupMember

createGroup(String, ConnectApi.ChatterGroupInput)

Creates a group.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupDetail createGroup(String, communityId, ConnectApi.ChatterGroupInput groupInput)

Parameters

communityId: Type: String,; Use either the ID for a community, internal, or null.
groupInput: Type: ConnectApi.ChatterGroupInput; The properties of the group.

Return Value

Type: ConnectApi.ChatterGroupDetail

deleteMember(String, String)

Deletes the specified group membership.

API Version

28.0

Requires Chatter

Yes

Signature

public static Void deleteMember(String communityId, String membershipId)

Parameters

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

Return Value

Type: Void

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

deletePhoto(String, String)

Deletes the photo of the specified group.

API Version

28.0

Requires Chatter

Yes

Signature

public static Void deletePhoto(String communityId, String groupId)

Parameters

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

Return Value

Type: Void

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

getAnnouncements(String, String)

Gets the first page of announcements in a group. An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.AnnouncementPage getAnnouncements(String communityId, String groupId)

Parameters

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

Return Value

Type: ConnectApi.AnnouncementPage

Usage

To post an announcement, call postAnnouncement(String, String, String, ConnectApi.AnnouncementInput).

To get information about a specific announcement, update the expiration date of an announcement, or delete an announcement, use the methods of the ConnectApi.Announcements class.

getAnnouncements(String, String, Integer, Integer)

Gets the specified page of announcements in a group. You can also specify the page size. An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.AnnouncementPage getAnnouncements(String communityId, String groupId, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
groupId: Type: String; The ID for a group.
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 feed items per page. Valid values are between 1 and 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.AnnouncementPage

Usage

To post an announcement, call postAnnouncement(String, String, String, ConnectApi.AnnouncementInput).

To get information about a specific announcement, update the expiration date of an announcement, or delete an announcement, use the methods of the ConnectApi.Announcements class.

getGroup(String, String)

Returns information about the specified group.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupDetail getGroup(String communityId, String groupId)

Parameters

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

Return Value

Type: ConnectApi.ChatterGroupDetail

getGroupBatch(String, List<String>)

Gets information about the specified list of groups. Returns a list of BatchResult objects containing ConnectApi.ChatterGroup objects. Returns errors embedded in the results for groups that couldn’t be loaded.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.BatchResult[] getGroupBatch(String communityId, List<String> groupIds)

Parameters

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

Return Value

Type: BatchResult[]

The BatchResult.getResult() method returns a ConnectApi.ChatterGroup object.

Example

1swfobject.registerObject("clippy.codeblock-0", "9");// Create a list of groups.
2ConnectApi.ChatterGroupPage groupPage = ConnectApi.ChatterGroups.getGroups(null);
3
4// Create a list of group IDs.
5List<String> groupIds = new List<String>();
6for (ConnectApi.ChatterGroup aGroup : groupPage.groups){
7    groupIds.add(aGroup.id); 
8}
9
10// Get info about all the groups in the list.
11ConnectApi.BatchResult[] batchResults = ConnectApi.ChatterGroups.getGroupBatch(null, groupIds);
12    
13for (ConnectApi.BatchResult batchResult : batchResults) {
14    if (batchResult.isSuccess()) {
15        // Operation was successful. 
16        // Print the number of members in each group.
17        ConnectApi.ChatterGroup aGroup;
18        if(batchResult.getResult() instanceof ConnectApi.ChatterGroup) {
19           aGroup = (ConnectApi.ChatterGroup) batchResult.getResult();
20        }
21        System.debug('SUCCESS');
22        System.debug(aGroup.memberCount);
23    }
24    else {
25        // Operation failed. Print errors.
26        System.debug('FAILURE');
27        System.debug(batchResult.getErrorMessage());
28    }
29}

getGroupMembershipRequest(String, String)

Returns information about the specified request to join a private group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequest getGroupMembershipRequest(String communityId, String requestId)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
requestId: Type: String; The ID of a request to join a private group.

Return Value

Type: ConnectApi.GroupMembershipRequest

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

getGroupMembershipRequests(String, String)

Returns information about every request to join the specified private group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequests getGroupMembershipRequests(String communityId, String groupId)

Parameters

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

Return Value

Type: ConnectApi.GroupMembershipRequests

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

getGroupMembershipRequests(String, String, ConnectApi.GroupMembershipRequestStatus)

Returns information about every request to join the specified private group that has a specified status.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequests getGroupMembershipRequests(String communityId, String groupId, ConnectApi.GroupMembershipRequestStatus status)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

groupId

Type: String

The ID for a group.

status

Type: ConnectApi.GroupMembershipRequestStatus

status—The status of a request to join a private group.

Accepted
Declined
Pending

Return Value

Type: ConnectApi.GroupMembershipRequests

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

getGroups(String)

Returns the first page of all the groups. The page contains the default number of items.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage getGroups(String communityId)

Parameters

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

Return Value

Type: ConnectApi.ChatterGroupPage

getGroups(String, Integer, Integer)

Returns the specified page of information about all groups.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage getGroups(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 feed items per page. Valid values are between 1 and 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.ChatterGroupPage

getGroups(String, Integer, Integer, ConnectApi.GroupArchiveStatus)

Returns the specified page of information about a set of groups with a specified group archive status.

API Version

29.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage getGroups(String communityId, Integer pageParam, Integer pageSize, ConnectApi.GroupArchiveStatus archiveStatus)

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 feed items per page. Valid values are between 1 and 100. If you pass in null, the default size is 25.

archiveStatus

Type: ConnectApi.GroupArchiveStatus

Specifies a set of groups based on whether the groups are archived or not.

All—All groups, including groups that are archived and groups that are not archived.
Archived—Only groups that are archived.
NotArchived—Only groups that are not archived.

If you pass in null, the default value is All.

Return Value

Type: ConnectApi.ChatterGroupPage

getMember(String, String)

Returns information about the specified group member.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMember getMember(String communityId, String membershipId)

Parameters

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

Return Value

Type: ConnectApi.GroupMember

getMembers(String, String)

Returns the first page of information about all members of the specified group. The page contains the default number of items.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMemberPage getMembers(String communityId, String groupId)

Parameters

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

Return Value

Type: ConnectApi.GroupMemberPage

getMembers(String, String, Integer, Integer)

Returns the specified page of information about all members of the specified group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMemberPage getMembers(String communityId, String groupId, Integer pageParam, Integer pageSize)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
groupId: Type: String; The ID for a group.
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; The number of items per page. Valid values are between 1 and 1000. If you pass null, pageSize is 25.

Return Value

Type: ConnectApi.GroupMemberPage

getMembershipBatch(String, List<String>)

Gets information about the specified list of group memberships. Returns a list of BatchResult objects containing ConnectApi.GroupMember objects. Returns errors embedded in the results for group memberships that couldn’t be accessed.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.BatchResult[] getMembershipBatch(String communityId, List<String> membershipIds)

Parameters

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

Return Value

Type: BatchResult[]

The BatchResult getResults() method returns a ConnectApi.GroupMember object.

Example

1swfobject.registerObject("clippy.codeblock-1", "9");// Get members of a group.
2ConnectApi.GroupMemberPage membersPage = ConnectApi.ChatterGroups.getMembers(null, '0F9D00000000oOT');
3
4// Create a list of membership IDs.
5List<String> membersList = new List<String>();
6for (ConnectApi.GroupMember groupMember : membersPage.members){
7    membersList.add(groupMember.id); 
8}
9
10// Get info about all group memberships in the list.
11ConnectApi.BatchResult[] batchResults = ConnectApi.ChatterGroups.getMembershipBatch(null, membersList);
12
13for (ConnectApi.BatchResult batchResult : batchResults) {
14    if (batchResult.isSuccess()) {
15        // Operation was successful. 
16        // Print the first name of each member.
17        ConnectApi.GroupMember groupMember;
18        if(batchResult.getResult() instanceof ConnectApi.GroupMember) {
19            groupMember = (ConnectApi.GroupMember) batchResult.getResult();
20        }
21        System.debug('SUCCESS');
22        System.debug(groupMember.user.firstName);
23    }
24    else {
25        // Operation failed. Print errors.
26        System.debug('FAILURE');
27        System.debug(batchResult.getErrorMessage());
28    }
29}

getMyChatterSettings(String, String)

Returns the context user’s Chatter settings for the specified group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupChatterSettings getMyChatterSettings(String communityId, String groupId)

Parameters

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

Return Value

Type: ConnectApi.GroupChatterSettings

getPhoto(String, String)

Returns information about the photo for the specified group.

API Version

28.0

Requires Chatter

Yes

Signature

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

Parameters

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

Return Value

Type: ConnectApi.Photo

postAnnouncement(String, String, String, ConnectApi.AnnouncementInput)

Posts an announcement to the group. An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.

API Version

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.Announcement postAnnouncement(String communityId, String groupId, ConnectApi.AnnouncementInput announcement)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
groupId: Type: String; The ID for a group.
announcement: Type: ConnectApi.AnnouncementInput; A ConnectApi.AnnouncementInput object.

Return Value

Type: ConnectApi.Announcement

Usage

Use an announcement to highlight information. Users can discuss, like, and post comments on announcements in the group feed. Group members receive an email notification when you post an announcement, same as for other posts, depending on their selected group email notification frequency. Deleting the feed post deletes the announcement.

To get information about all the announcements in a group, call getAnnouncements(String, String) or getAnnouncements(String, String, Integer, Integer).

To get information about a specific announcement, update the expiration date of an announcement, or delete an announcement, use the methods of the ConnectApi.Announcements class.

requestGroupMembership(String, String)

Requests membership in a private group for the context user.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequest requestGroupMembership(String communityId, String groupId)

Parameters

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

Return Value

Type: ConnectApi.GroupMembershipRequest

Sample: Requesting to Join a Private Group

This sample code calls ConnectApi.ChatterGroups.requestGroupMembership to request to join a private group.

1String communityId = null;
2ID groupId = '0F9x00000000hAZ';
3
4ConnectApi.GroupMembershipRequest membershipRequest = ConnectApi.ChatterGroups.requestGroupMembership(communityId, groupId);

searchGroups(String, String)

Returns the first page of groups that match the specified search criteria. The page contains the default number of items.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage searchGroups(String communityId, String q)

Parameters

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

Return Value

Type: ConnectApi.ChatterGroupPage

searchGroups(String, String, Integer, Integer)

Returns the specified page of groups that match the specified search criteria.

API Version

28.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage searchGroups(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; q—Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards. Can be specified as 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 feed items per page. Valid values are between 1 and 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.ChatterGroupPage

searchGroups(String, String, ConnectApi.GroupArchiveStatus, Integer, Integer)

Returns the specified page of groups that match the specified search criteria and that have the specified archive status.

API Version

29.0

Available to Guest Users

31.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroupPage searchGroups(String communityId, String q, ConnectApi.GroupArchiveStatus archiveStatus, Integer pageParam, Integer pageSize)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

q—Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards. Can be specified as null.

archiveStatus

Type: ConnectApi.GroupArchiveStatus

archiveStatus Specifies a set of groups based on whether the groups are archived or not.

All—All groups, including groups that are archived and groups that are not archived.
Archived—Only groups that are archived.
NotArchived—Only groups that are not archived.

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 feed items per page. Valid values are between 1 and 100. If you pass in null, the default size is 25.

Return Value

Type: ConnectApi.ChatterGroupPage

setPhoto(String, String, String, Integer)

Sets the group photo to an already uploaded file. The key prefix must be 069 and the file size must be less than 2 MB.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhoto(String communityId, String groupId, String fileId, Integer versionNumber)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
groupId: Type: String; The ID for a group.
fileId: Type: String; ID of a file already uploaded. The file must be an image smaller than 2 MB.
versionNumber: Type: Integer; Version number of the existing file. Specify either an existing version number or, to get the latest version, specify null.

Return Value

Type: ConnectApi.Photo

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

Photos are processed asynchronously and may not be visible right away.

Sample: Updating a Group Photo with an Existing File

When a group is created, it doesn’t have a group photo. You can set an existing photo that has already been uploaded to Salesforce as the group photo. The key prefix must be 069 and the file size must be less than 2 MB.

1String communityId = null;
2ID groupId = '0F9x00000000hAK';
3ID fileId = '069x00000001Ion';
4
5// Set photo
6ConnectApi.Photo photo = ConnectApi.ChatterGroups.setPhoto(communityId, groupId, fileId, null);

setPhoto(String, String, ConnectApi.BinaryInput)

Sets the group photo to the specified blob..

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhoto(String communityId, String groupId, ConnectApi.BinaryInput fileUpload)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
groupId: Type: String; The ID for a group.
fileUpload: Type: ConnectApi.BinaryInput; A file to use as the photo. The content type must be usable as an image.

Return Value

Type: ConnectApi.Photo

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

Photos are processed asynchronously and may not be visible right away.

Sample: Uploading a New File and Using it as a Group Photo

When a group is created, it doesn’t have a group photo. You can upload a photo and set it as the group photo.

1String communityId = null;
2ID groupId = '0F9x00000000hAP';
3ID photoId = '069x00000001Ioo';
4
5// Set photo
6List<ContentVersion> groupPhoto = [Select c.VersionData From ContentVersion c where ContentDocumentId=:photoId];
7ConnectApi.BinaryInput binary = new ConnectApi.BinaryInput(groupPhoto.get(0).VersionData, 'image/png', 'image.png');
8ConnectApi.Photo photo = ConnectApi.ChatterGroups.setPhoto(communityId, groupId, binary);

setPhotoWithAttributes(String, String, ConnectApi.PhotoInput)

Sets and crops an already uploaded file as the group photo.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhotoWithAttributes(String communityId, String groupId, ConnectApi.PhotoInput photo)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
groupId: Type: String; The ID for a group.
photo: Type: ConnectApi.PhotoInput; A ConnectApi.PhotoInput object that specifies the ID and version of the file, and how to crop the file.

Return Value

Type: ConnectApi.Photo

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

Photos are processed asynchronously and may not be visible right away.

setPhotoWithAttributes(String, String, ConnectApi.PhotoInput, ConnectApi.BinaryInput)

Sets and crops a binary input as the group photo.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.Photo setPhotoWithAttributes(String communityId, String groupId, ConnectApi.PhotoInput photo, ConnectApi.BinaryInput fileUpload)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
groupId: Type: String; The ID for a group.
photo: Type: ConnectApi.PhotoInput; A ConnectApi.PhotoInput object that specifies how to crop the file specified in fileUpload.
fileUpload: Type: ConnectApi.BinaryInput; A file to use as the photo. The content type must be usable as an image.

Return Value

Type: ConnectApi.Photo

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

Photos are processed asynchronously and may not be visible right away.

updateGroup(String, String, ConnectApi.ChatterGroupInput)

Update the settings of a group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroup updateGroup(String communityId, String groupId, ConnectApi.ChatterGroupInput groupInput)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
groupId: Type: String; The ID for a group.
groupInput: Type: ConnectApi.ChatterGroupInput; A ConnectApi.ChatterGroupInput object.

Return Value

Type: ConnectApi.ChatterGroup

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission. Use this method to update any settings in the ConnectApi.ChatterGroupInput class. These settings include the group title and text in the “Information” section, whether the group is public or private, and whether the group is archived.

Example

This example archives a group:

1swfobject.registerObject("clippy.codeblock-5", "9");String groupId = '0F9D00000000qSz';
2String communityId = null;
3
4ConnectApi.ChatterGroupInput groupInput = new ConnectApi.ChatterGroupInput();
5groupInput.isArchived = true;
6
7ConnectApi.ChatterGroups.updateGroup(communityId, groupId, groupInput);

updateGroupMember(String, String, ConnectApi.GroupMembershipType)

Updates the specified group membership with the specified role in the specified community. This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

API Version

29.0

Requires Chatter

Yes

Signature

public static ConnectApi.ChatterGroup updateGroupMember(String communityId, String membershipId, ConnectApi.GroupMembershipType role)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

membershipId

Type: String

The ID for a membership.

role

Type: ConnectApi.GroupMembershipType

The group membership type. One of these values:

GroupManager
StandardMember

Return Value

Type: ConnectApi.ChatterGroup

updateMyChatterSettings(String, String, ConnectApi.GroupEmailFrequency)

Updates the context user’s Chatter settings for the specified group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupChatterSettings updateMyChatterSettings(String communityId, String groupId, ConnectApi.GroupEmailFrequency emailFrequency)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

groupId

Type: String

The ID for a group.

emailFrequency

Type: ConnectApi.GroupEmailFrequency

emailFrequency—Specifies the frequency with which a user receives email from a group.

EachPost
DailyDigest
WeeklyDigest
Never
UseDefault

The value UseDefault uses the value set in a call to updateChatterSettings(String, String, ConnectApi.GroupEmailFrequency).

Return Value

Type: ConnectApi.GroupChatterSettings

updateRequestStatus(String, String, ConnectApi.GroupMembershipRequestStatus)

Updates a request to join a private group.

API Version

28.0

Requires Chatter

Yes

Signature

public static ConnectApi.GroupMembershipRequest updateRequestStatus(String communityId, String requestId, ConnectApi.GroupMembershipRequestStatus status)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

requestId

Type: String

The ID for a request to join a private group.

status

Type: ConnectApi.GroupMembershipRequestStatus

The status of the request:

Accepted
Declined

The Pending value of the enum is not valid in this method.

Return Value

Type: ConnectApi.GroupMembershipRequest

Usage

This method is only successful when the context user is the group manager or owner, or has “Modify All Data” permission.

Sample: Accepting or Declining a Request to Join a Private Group

This sample code calls ConnectApi.ChatterGroups.updateRequestStatus and passes it the membership request ID and an ConnectApi.GroupMembershipRequestStatus.Accepted status. You can also pass ConnectApi.GroupMembershipRequestStatus.Declined.

1String communityId = null;
2ID groupId = '0F9x00000000hAZ';
3String requestId = '0I5x000000001snCAA';
4
5ConnectApi.GroupMembershipRequest membershipRequestRep = ConnectApi.ChatterGroups.updateRequestStatus(communityId, requestId, 
6ConnectApi.GroupMembershipRequestStatus.Accepted);

ChatterGroups Test Methods

The following are the test methods for ChatterGroups. All methods are static.

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

setTestSearchGroups(String, String, ConnectApi.ChatterGroupPage)

Registers a ConnectApi.ChatterGroupPage object to be returned when the matching ConnectApi.searchGroups method is called in a test context. You must use the test method with the same parameters or you receive an exception.

API Version

29.0

Signature

public static Void setTestSearchGroups(String communityId, String q, ConnectApi.ChatterGroupPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; q—Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards. Can be specified as null.
result: Type: ConnectApi.ChatterGroupPage; The test ConnectApi.ChatterGroupPage object.

Return Value

Type: Void

setTestSearchGroups(String, String, Integer, Integer, ConnectApi.ChatterGroupPage)

API Version

28.0

Signature

public static Void setTestSearchGroups(String communityId, String q, Integer pageParam, Integer pageSize, ConnectApi.ChatterGroupPage result)

Parameters

communityId: Type: String; Use either the ID for a community, internal, or null.
q: Type: String; q—Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards. Can be specified as 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 feed items per page. Valid values are between 1 and 100. If you pass in null, the default size is 25.
result: Type: ConnectApi.ChatterGroupPage; The test ConnectApi.ChatterGroupPage object.

Return Value

Type: Void

setTestSearchGroups(String, String, ConnectApi.GroupArchiveStatus, Integer, Integer, ConnectApi.ChatterGroupPage)

API Version

29.0

Signature

public static Void setTestSearchGroups(String communityId, String q, ConnectApi.GroupArchiveStatus, archiveStatus, Integer pageParam, Integer pageSize, ConnectApi.ChatterGroupPage result)

Parameters

communityId

Type: String

Use either the ID for a community, internal, or null.

q

Type: String

q—Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards. Can be specified as null.

archiveStatus

Type: ConnectApi.GroupArchiveStatus

archiveStatusSpecifies a set of groups based on whether the groups are archived or not.

All—All groups, including groups that are archived and groups that are not archived.
Archived—Only groups that are archived.
NotArchived—Only groups that are not archived.

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 feed items per page. Valid values are between 1 and 100. If you pass in null, the default size is 25.

result

Type: ConnectApi.ChatterGroupPage

The test ConnectApi.ChatterGroupPage object.

Return Value

Type: Void

Force.com Apex Code Developer's Guide

No Results

ChatterGroups Class

Namespace

ChatterGroups Methods

addMember(String, String, String)

API Version

Requires Chatter

Signature

Parameters

Return Value

addMemberWithRole(String, String, String, ConnectApi.GroupMembershipType)

API Version

Requires Chatter

Signature

Parameters

Return Value

createGroup(String, ConnectApi.ChatterGroupInput)

API Version

Requires Chatter

Signature

Parameters

Return Value

deleteMember(String, String)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

deletePhoto(String, String)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

getAnnouncements(String, String)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

getAnnouncements(String, String, Integer, Integer)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

getGroup(String, String)

API Version

Available to Guest Users

Requires Chatter

Signature

Parameters

Return Value

getGroupBatch(String, List<String>)

API Version

Requires Chatter

Signature

Parameters

Return Value

Example

See Also:

getGroupMembershipRequest(String, String)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage

getGroupMembershipRequests(String, String)

API Version

Requires Chatter

Signature

Parameters

Return Value

Usage