Object Reference for Salesforce and Force.com

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

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

Announcement

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

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Fields

Field Name Details
ExpirationDate
Type
dateTime
Properties
Create, Filter, Sort, Update
Description

Required. The date on which the announcement expires. Announcements display on the group UI until 11:59 p.m. local time on the selected date.
FeedItemId
Type
reference
Properties
Create, Filter, Group, Sort
Description

Required. The ID of the FeedItem that contains the content of the announcement. Announcements are stored as text posts.
ParentId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description

The ID of the parent CollaborationGroup that the announcement belongs to. An announcement can belong only to a single Chatter group.

Usage

Group owners, managers, and users with the “Modify All Data” permission can use the Announcement object to create, edit, and delete group announcements. Creating a group announcement is a three-step process:
  1. Use the FeedItem object to create a text post with the announcement’s content. Use the CollaborationGroup record you want to post the announcement to as the parent of this feed item.
  2. Next, use the feed item ID and an expiration date to create the announcement record.
  3. Finally, update the AnnouncementId field in the CollaborationGroup record with the ID of the announcement you created.
To delete the group announcement, simply delete the AnnouncementId value in the CollaborationGroup record. To restore a group announcement, update the AnnouncementId field for a group with the announcement’s ID. The expiration date for the announcement should be in the future and the feed item used to create the announcement should be parented by the same group.