CollaborationGroup

Represents a Chatter group. This object is available in API version 19.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert()

Special Access Rules

The visibility of information in groups depends on the type of group and the user’s permissions.

  • Members: Any user with the “Create and Own New Chatter Groups” permission can create public, private, and unlisted groups, including in any communities they belong to.
  • Owners and managers: Users can modify group details for any group they own or manage. Owners can also delete groups they own.
  • Nonmembers: These user permissions allow group access regardless of group membership.
    • “View All Data”—Allows users to view all public and private groups across their organization and its communities. Users with this permission can’t view unlisted group information, unless they have the “Modify Unlisted Groups” permission as well.
    • “Modify All Data”—Allows users to view, modify, and delete all public and private groups across their organization and its communities. Users with this permission can’t view or modify unlisted group information, unless they have the “Modify Unlisted Groups” permission as well.
    • “Create and Customize Communities”—Allows users to view, modify, and delete all public and private groups in communities.
    • “Manage Unlisted Groups”—Allows users to search for, access, and modify any unlisted group in an organization and its communities.
    • “Data Export”—Allows users to export any data from Salesforce, including private and unlisted group data from an organization and its communities.
  • Apex and Visualforce: Apex code runs in system mode, which means that the permissions of the current user aren’t taken into account.
    • Visualforce pages that display groups might expose unlisted or private group data to users who aren’t members.
    • Because system mode disregards the user’s permissions, all users who are accessing a Visualforce page that’s showing a group can act as an owner of that group.
    • AppExchange apps that are written in Apex and that access all groups will expose unlisted groups to users who aren’t members.
To limit and manage access to the unlisted and private groups in your organization:
  • Explicitly filter out unlisted and private group information from SOQL queries in all Apex code.
  • Use permission sets, profile-level permissions, and sharing checks in your code to further limit group access.
  • Use Apex triggers on the CollaborationGroup object to monitor and manage the creation of groups. In Setup, go to Chatter | Groups | Group Triggers to add triggers.

Fields

Field Details
AnnouncementId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Contains the ID of the Announcement last associated with the group. This field is available in API version 30.0 and later.
CanHaveGuests
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
If set to true, indicates that a group allows customers. Chatter customers are users outside your company's email domains who can only see groups they're invited to and interact with members of those groups; they can't see any Salesforce information.

This field is available starting in API version 23.0, but groups that allow customers are accessible from earlier API versions. However, when accessed from earlier API versions, groups that allow customers aren't distinguishable from private groups. We strongly recommend that you upgrade to the latest API version. If you must use an earlier version, name groups that allow customers to indicate that they include customers.

CollaborationType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of Chatter group. Available values are:
  • Public—Anyone can see and post updates. Anyone can join a public group.
  • Private—Only members can see the group feed and post updates. Non-members can only see the group name and a few other details in list views, search, and on the group page. The group's owner or managers must add members who request to join the group.
  • Unlisted—Only members and users with the “Modify Unlisted Groups” permission can see the group and post updates. Other users can’t access the group or see it in lists, search, and feeds.
Description
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
Description of the group.
FullPhotoUrl
Type
url
Properties
Filter, Nillable, Sort
Description
The URL for the group's profile photo.

The URL is updated every time a photo is uploaded and reflects the most recent photo. The URL returned for an older photo is not guaranteed to return a photo if a newer photo has been uploaded. You should always query this field for the URL of the most recent photo.

This field is available in API version 20.0 and later.

GroupEmail
Type
email
Properties
Group, Nillable, Sort
Description
The email address for posting to the group. For private groups, only visible to members and users with “Modify All Data” or “View All Data” permissions.

This field is available in API version 29.0 and later.

HasPrivateFieldsAccess
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
If set to true, indicates that a user can see the InformationBody and InformationTitle fields in a private group. This field is set to true for members of a private group and users with “Modify All Data” or “View All Data” permissions.
InformationBody
Type
textarea
Properties
Create, Nillable, Update
Description
The text of the Information section. For private groups, only visible to members and users with “Modify All Data” or “View All Data” permissions.
InformationTitle
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The title of the Information section. For private groups, only visible to members and users with “Modify All Data” or “View All Data” permissions.
IsArchived
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the group is archived (true) or not (false).
IsAutoArchiveDisabled
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether automatic archiving is enabled for the group (true) or not (false).
LastFeedModifiedDate
Type
dateTime
Properties
Filter, Sort
Description
The date of the last post or comment on the group.
LastReferencedDate
Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
date
Properties
Filter, Nillable, Sort, Update
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
MemberCount
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The number of members in the group.
Name
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Name of the group. The group name must be unique.
NetworkId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
ID of the community that this group is part of. This field is available only if Salesforce Communities is enabled in your organization.

You can only add a NetworkId when creating a group. You can’t change or add a NetworkId for an existing group. This field is available in API version 26.0 and later.

OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
ID of the owner of the group. Only the current group owner or people with the “Modify All Data” permission can update the OwnerId.
SmallPhotoUrl
Type
url
Properties
Filter, Nillable, Sort
Description
The URL for a thumbnail of the group's profile photo.

The URL is updated every time a photo is uploaded and reflects the most recent photo. The URL returned for an older photo is not guaranteed to return a photo if a newer photo has been uploaded. You should always query this field for the URL of the most recent photo.

This field is available in API version 20.0 and later.

Usage

Use this object to create, edit, or delete groups in an organization or in a community. Deleting a group permanently deletes all posts and comments to the group. It also deletes all files and links posted to the group and removes the files from other locations where they were shared.

As a Chatter group member, you can post to the group using the CollaborationGroupFeed object. As a Chatter group owner or manager, you can add or remove group members using the CollaborationGroupMember object, post announcements to the group using the Announcement object, and accept or decline requests to join private groups using the CollaborationGroupMemberRequest object. Additionally, the group owner, manager, or your Salesforce system administrator can invite people to join the group using the CollaborationInvitation object.

The Salesforce system administrator doesn’t need to be a member of the group in order to send invitations using the API.
© Copyright 2000–2014 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.