ConnectApi Output Classes

All properties are read-only, except for instances of output classes created within test code.

All output classes are concrete unless marked abstract in this documentation.

All concrete output classes have no-argument constructors that you can invoke only from test code. See Testing ConnectApi Code.

ConnectApi.AbstractMessageBody Class

This class is abstract.

Superclass of:

ConnectApi.FeedBody Class
ConnectApi.MessageBody Class

Name	Type	Description	Available Version
`messageSegments`	`List<ConnectApi.MessageSegment Class>`	List of message segments	28.0
`text`	String	Display-ready text. Use this text if you don’t want to process the message segments.	28.0

ConnectApi.AbstractRecordField Class

This class is abstract.

Superclass of:

ConnectApi.BlankRecordField Class
ConnectApi.LabeledRecordField Class

A field on a record object.

Message segments in a feed item are typed as ConnectApi.MessageSegment. Feed item attachments are typed as ConnectApi.FeedItemAttachment. Record fields are typed as ConnectApi.AbstractRecordField. These classes are all abstract and have several concrete subclasses. At runtime you can use instanceof to check the concrete types of these objects and then safely proceed with the corresponding downcast. When you downcast, you must have a default case that handles unknown subclasses.

The composition of a feed may change between releases. Your code should always be prepared to handle instances of unknown subclasses.

Important

Name	Type	Description	Available Version
`type`	String	The type of the field. One of these values: `Address` `Blank` `Boolean` `Compound` `CreatedBy` `Date` `DateTime` `Email` `LastModifiedBy` `Location` `Name` `Number` `Percent` `Phone` `Picklist` `Reference` `Text` `Time`	29.0

ConnectApi.AbstractRecordView Class

This class is abstract.

Subclass of ConnectApi.ActorWithId Class

Superclass of:

ConnectApi.RecordSummary Class
ConnectApi.RecordView Class

A view of any record in the organization, including a custom object record. This object is used if a specialized object, such as User or ChatterGroup, is not available for the record type.

Name	Type	Description	Available Version
`name`	String	The localized name of the record.	29.0

ConnectApi.Actor Class

Superclass of:

ConnectApi.ActorWithId Class
ConnectApi.UnauthenticatedUser Class

Name	Type	Description	Available Version
`name`	String	Name of the actor, such as the group name	28.0
`type`	String	One of the following: `file` `group` `unauthenticateduser` `user` `record type name`—the name of the record type, such as myCustomObject__c or Account	28.0

ConnectApi.ActorWithId Class

Subclass of: ConnectApi.Actor Class

Superclass of:

ConnectApi.AbstractRecordView Class
ConnectApi.ChatterGroup Class
ConnectApi.File Class
ConnectApi.User

Name	Type	Description	Available Version
`id`	String	Actor’s 18-character ID	28.0
`motif`	`ConnectApi.Motif`	An icon that identifies the actor as a user, group, file, or custom object. The icon isn’t the user or group photo, and it isn’t a preview of the file. The motif can also contain the object’s base color.	28.0
`mySubscription`	`ConnectApi.Reference Class`	If the context user is following the item, this contains information about the subscription, else returns `null`.	28.0
`recordViewUrl`	String	The URL of the Chatter REST API record view resource for this record, or `null` if this record does not have a record view layout, or if “Connect Records API” is not enabled for this organization, or if the record type isn’t supported.	30.0
`url`	String	Chatter REST API URL for the resource	28.0

ConnectApi.Address Class

Name	Type	Description	Available Version
`city`	String	Name of the city	28.0
`country`	String	Name of the country	28.0
`formattedAddress`	String	Formatted address per the locale of the context user	28.0
`state`	String	Name of the state, province, or so on	28.0
`street`	String	Street number	28.0
`zip`	String	Zip or postal code	28.0

ConnectApi.ApprovalAttachment Class

Subclass of ConnectApi.FeedItemAttachment Class

Name	Type	Description	Available Version
`id`	String	A work item ID.	28.0
`postTemplateFields`	`List <ConnectApi.ApprovalPostTemplateField Class>`	Collection of approval post template fields	28.0
`processInstanceStepId`	String	An approval step ID.	30.0
`status`	`ConnectApi.WorkflowProcessStatus` Enum	Specifies the status of a workflow process. `Approved` `Fault` `Held` `NoResponse` `Pending` `Reassigned` `Rejected` `Removed` `Started`	28.0

ConnectApi.ApprovalPostTemplateField Class

Name	Type	Description	Available Version
`displayName`	String	The field name	28.0
`displayValue`	String	The field value or `null` if the field is set to `null`.	28.0
`record`	`ConnectApi.Reference Class`	A record ID If no record exists or if the reference is `null`, this value is `null`.	28.0

ConnectApi.BasicTemplateAttachment Class

Subclass of ConnectApi.FeedItemAttachment Class

Objects of this type are returned by attachments in feed items with type BasicTemplate.

Property	Type	Description	Available Version
`description`	String	An optional description with a 500 character limit.	28.0
`icon`	`ConnectApi.Icon Class`	An optional icon.	28.0
`linkRecordId`	String	If `linkURL` refers to a Salesforce record, `linkRecordId` contains the ID of the record.	28.0
`linkUrl`	String	An optional URL to a detail page if there is additional content that can’t be displayed inline. Do not specify `linkUrl` unless you specify a `title`.	28.0
`title`	String	An optional title to the detail page. If `linkUrl` is specified, the title links to `linkUrl`.	28.0

ConnectApi.BlankRecordField Class

Subclass of ConnectApi.AbstractRecordField Class

A record field displayed as a place holder in a grid of fields.

ConnectApi.CanvasTemplateAttachment Class

Subclass of ConnectApi.FeedItemAttachment Class

Objects of this type are returned by attachments in feed items with type CanvasPost.

Property	Type	Description	Available Version
`description`	String	Optional. Description of the canvas app. The maximum length of this field is 500 characters.	29.0
`developerName`	String	Specifies the developer name (API name) of the canvas app.	29.0
`height`	String	Optional. The height of the canvas app in pixels. Default height is 200 pixels.	29.0
`icon`	`ConnectApi.Icon Class`	The canvas app icon.	29.0
`namespacePrefix`	String	Optional. The namespace prefix of the Developer Edition organization in which the canvas app was created.	29.0
`parameters`	String	Optional. Parameters passed to the canvas app in JSON format. Example: `1{'isUpdated'='true'}`	29.0
`thumbnailUrl`	String	Optional. A URL to a thumbnail image for the canvas app. Maximum dimensions are 120x120 pixels.	29.0
`title`	String	Specifies the title of the link used to call the canvas app.	29.0

ConnectApi.CaseComment Class

Subclass of ConnectApi.FeedItemAttachment Class

Objects of this type are returned by attachments in feed items with type CaseCommentPost.

Name	Type	Description	Available Version
`actorType`	`ConnectApi.CaseActorType` Enum	Specifies the type of user who made the comment. `Customer`—if a Chatter customer made the comment `CustomerService`—if a service representative made the comment	28.0
`createdBy`	`ConnectApi.UserSummary Class`	Comment’s creator	28.0
`createdDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z	28.0
`id`	String	Comment’s 18–character ID	28.0
`published`	Boolean	Specifies whether the comment has been published	28.0
`text`	String	Comment’s text	28.0

ConnectApi.ChatterActivity Class

Name	Type	Description	Available Version
`commentCount`	Integer	Total number of comments in the organization or community made by the user	28.0
`commentReceivedCount`	Integer	Total number of comments in the organization or community received by the user	28.0
`likeReceivedCount`	Integer	Total number of likes on posts and comments in the organization or community received by the user	28.0
`postCount`	Integer	Total number of posts in the organization or community made by the user	28.0

ConnectApi.ChatterConversation Class

Name	Type	Description	Available Version
`conversationId`	String	The ID for the conversation	29.0
`conversationUrl`	String	Chatter REST API URL identifying the conversation	29.0
`members`	`List<ConnectApi.UserSummary Class>`	List of users in the conversation	29.0
`messages`	`ConnectApi.ChatterMessagePage Class`	The content of the conversation	29.0
`read`	Boolean	Specifies if the conversation is read (`true`) or not read (`false`)	29.0

ConnectApi.ChatterConversationPage Class

Name	Type	Description	Available Version
`conversations`	`List<ConnectApi.ChatterConversationSummary Class>`	List of conversations on the page	29.0
`currentPageToken`	String	Token identifying the current page.	29.0
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	29.0
`nextPageToken`	String	Token identifying the next page or `null` if there isn’t a next page.	29.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	29.0

ConnectApi.ChatterConversationSummary Class

Name	Type	Description	Available Version
`id`	String	The ID for the conversation summary	29.0
`latestMessage`	`ConnectApi.ChatterMessage Class`	The contents of the latest message	29.0
`members`	`List<ConnectApi.UserSummary Class>`	List of members in the conversation	29.0
`read`	Boolean	Specifies if the conversation is read (`true`) or not read (`false`)	29.0
`url`	String	Chatter REST API URL to the conversation summary	29.0

ConnectApi.ChatterGroup Class

This class is abstract.

Subclass of ConnectApi.ActorWithId Class

Superclass of:

ConnectApi.ChatterGroupDetail Class
ConnectApi.ChatterGroupSummary Class

Name	Type	Description	Available Version
`additionalLabel`	String	An additional label for the group, for example, “Archived,” “Private,” or “Private With Customers.” If there isn’t an additional label, the value is `null`.	30.0
`canHaveChatterGuests`	Boolean	`true` if this group allows Chatter guests	28.0
`community`	`ConnectApi.Reference Class`	Information about the community the group is in	28.0
`description`	String	Group’s description	28.0
`emailToChatterAddress`	String	Group’s email address for posting to this group by email. Returns `null` if Chatter emails and posting to Chatter by email aren’t both enabled in your organization.	30.0
`isArchived`	Boolean	Specifies whether the group is archived (`true`) or not (`false`).	29.0
`isAutoArchiveDisabled`	Boolean	Specifies whether automatic archiving is disabled for the group (`true`) or not (`false`).	29.0
`lastFeedItemPostDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z of the most recent feed item posted to the group.	28.0
`memberCount`	Integer	Total number of group members	28.0
`myRole`	`ConnectApi.GroupMembershipType` Enum	Specifies the type of membership the user has with the group, such as group owner, manager, or member. `GroupOwner` `GroupManager` `NotAMember` `NotAMemberPrivateRequested` `StandardMember`	28.0
`mySubscription`	`ConnectApi.Reference Class`	If the context user is a member of this group, contains information about that subscription; otherwise, returns `null`.	28.0
`name`	String	Name of the group	28.0
`owner`	`ConnectApi.UserSummary Class`	Information about the owner of the group	28.0
`photo`	`ConnectApi.Photo Class`	Information about the group photo	28.0
`visibility`	`ConnectApi.GroupVisibilityType` Enum	Specifies whether a group is private or public. Valid values are: `PrivateAccess`—Only members of the group can see posts to this group. `PublicAccess`—All users within the internal community can see posts to this group.	28.0

ConnectApi.ChatterGroupDetail Class

Subclass of ConnectApi.ChatterGroup Class

Name	Type	Description	Available Version
`fileCount`	Integer	The number of files posted to the group.	28.0
`information`	`ConnectApi.GroupInformation Class`	Describes the “Information” section of the group. In the Web UI, this section is above the “Description” section. If the group is private, this section is visible only to members. If the context user is not a member of the group or does not have “Modify All Data” or “View All Data” permission, this value is `null`.	28.0
`pendingRequests`	Integer	The number of requests to join a group that are in a pending state.	29.0

ConnectApi.ChatterGroupPage Class

Name	Type	Description	Available Version
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	28.0
`groups`	`List<ConnectApi.ChatterGroupDetail Class>`	List of group details	28.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	28.0
`previousPageUrl`	String	Chatter REST API URL identifying the previous page or `null` if there isn’t a previous page.	28.0

ConnectApi.ChatterGroupSummary Class

Subclass of ConnectApi.ChatterGroup Class

ConnectApi.ChatterGroupSummaryPage Class

Name	Type	Description	Available Version
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	29.0
`groups`	`List<ConnectApi.ChatterGroupSummary Class>`	List of group summary objects	29.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	29.0
`previousPageUrl`	String	Chatter REST API URL identifying the previous page or `null` if there isn’t a previous page.	29.0

ConnectApi.ChatterLike Class

Name	Type	Description	Available Version
`id`	String	Like’s 18-character ID	28.0
`likedItem`	`ConnectApi.Reference Class`	A reference to the liked comment or feed item.	28.0
`url`	String	Like’s Chatter REST API URL	28.0
`user`	`ConnectApi.UserSummary Class`	Like’s creator	28.0

ConnectApi.ChatterLikePage Class

Name	Type	Description	Available Version
`currentPageToken`	Integer	Token identifying the current page.	28.0
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	28.0
`likes`	`List<ConnectApi.ChatterLike Class>`	List of likes	28.0
`nextPageToken`	Integer	Token identifying the next page or `null` if there isn’t a next page.	28.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	28.0
`previousPageToken`	Integer	Token identifying the previous page or `null` if there isn’t a previous page.	28.0
`previousPageUrl`	String	Chatter REST API URL identifying the previous page or `null` if there isn’t a previous page.	28.0
`total`	Integer	Total number of likes across all pages	28.0

ConnectApi.ChatterMessage Class

Name	Type	Description	Available Version
`body`	`ConnectApi.MessageBody Class`	Contents of the message	29.0
`conversationId`	String	The ID for the conversation	29.0
`conversationUrl`	String	Chatter REST API URL identifying the conversation	29.0
`id`	String	The ID of the message	29.0
`recipients`	`List<ConnectApi.UserSummary Class>`	List of the recipients of the message	29.0
`sender`	`ConnectApi.UserSummary Class`	The sender of the message	29.0
`sentDate`	Date	The date the message was sent	29.0
`url`	String	Chatter REST API URL identifying the current page of the conversation	29.0

ConnectApi.ChatterMessagePage Class

Name	Type	Description	Available Version
`currentPageToken`	String	Token identifying the current page.	29.0
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	29.0
`messages`	`List<ConnectApi.ChatterMessage>`	The messages on the current page	29.0
`nextPageToken`	String	Token identifying the next page or `null` if there isn’t a next page.	29.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	29.0

ConnectApi.ClientInfo Class

Name	Type	Description	Available Version
`applicationName`	String	Name of the Connected App used for authentication.	28.0
`applicationUrl`	String	Value from the Info URL field of the Connected App used for authentication	28.0

ConnectApi.Comment Class

Name	Type	Description	Available Version
`attachment`	`ConnectApi.FeedItemAttachment Class`	If the comment contains an attachment, property value is `ContentAttachment`. If the comment does not contain an attachment, it is `null`.	28.0
`body`	`ConnectApi.FeedBody Class`	Body of the comment	28.0
`clientInfo`	`ConnectApi.ClientInfo Class`	Information about the Connected App used to authenticate the connection	28.0
`createdDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z	28.0
`feedItem`	`ConnectApi.Reference Class`	Information about the feed item	28.0
`id`	String	Comment’s 18–character ID	28.0
`isDeleteRestricted`	Boolean	If this property is `true`, the context user cannot delete the comment. If it is `false`, it might be possible for the context user to delete the comment, but it is not guaranteed.	28.0
`likes`	`ConnectApi.ChatterLikePage Class`	The first page of likes for the comment	28.0
`likesMessage`	`ConnectApi.MessageBody Class`	A message body that describes who likes the comment.	28.0
`moderationFlags`	`ConnectApi.ModerationFlags Class`	Information about the moderation flags on a comment. If `ConnectApi.Features.communityModeration` is `false`, this property is `null`.	29.0
`myLike`	`ConnectApi.Reference Class`	If the context user has liked the comment, this property is a reference to the specific like, `null` otherwise	28.0
`parent`	`ConnectApi.Reference Class`	Information about the parent feed-item for this comment	28.0
`relativeCreatedDate`	String	The created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.”	28.0
`type`	`ConnectApi.CommentType` Enum	Specifies the type of comment. `ContentComment`—Comment contains an attachment. `TextComment`—Comment contains only text.	28.0
`url`	String	Chatter REST API URL to this comment	28.0
`user`	`ConnectApi.UserSummary Class`	Information about the comment author	28.0

ConnectApi.CommentPage Class

Name	Type	Description	Available Version
`comments`	`List<ConnectApi.Comment Class>`	Collection of comments	28.0
`currentPageToken`	String	Token identifying the current page.	28.0
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	28.0
`nextPageToken`	String	Token identifying the next page or `null` if there isn’t a next page.	28.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	28.0
`total`	Integer	Total number of comments for the parent feed item	28.0

ConnectApi.Community Class

Name	Type	Description	Available Version
`allowMembersToFlag`	Boolean	Specifies if members of the community can flag content	30.0
`description`	String	Community description	28.0
`id`	String	Community ID	28.0
`invitationsEnabled`	Boolean	User can invite other external users to the community	28.0
`knowledgeableEnabled`	Boolean	Specifies whether knowledgeable people and endorsements are available for topics (`true`), or not (`false`).	30.0
`name`	String	Community name	28.0
`privateMessagesEnabled`	Boolean	Specifies whether members of the community can send and receive private messages to and from other members of the community, (`true`) or not (`false`).	30.0
`sendWelcomeEmail`	Boolean	Send email to all new users when they join	28.0
`siteUrl`	String	Site URL for the community, which is the custom domain plus a URL prefix	30.0
`status`	`ConnectApi.CommunityStatus` Enum	Specifies the current status of the community. `Live` `Inactive` `UnderConstruction`	28.0
`url`	String	Full URL to community	28.0
`urlPathPrefix`	String	Community-specific URL prefix	28.0

ConnectApi.CommunityPage Class

Name	Type	Description	Available Version
`communities`	`List<ConnectApi.Community Class>`	List of communities context user has access to	28.0
`total`	Integer	Total number of communities	28.0

ConnectApi.ComplexSegment Class

This class is abstract.

Subclass of ConnectApi.MessageSegment Class

Superclass of ConnectApi.FieldChangeSegment Class

ComplexSegments are only part of field changes.

Name	Type	Description	Available Version
`segments`	`List<ConnectApi.MessageSegment Class>`	List of message segments.	28.0

ConnectApi.CompoundRecordField Class

Subclass of ConnectApi.LabeledRecordField Class

A record field that is a composite of sub-fields.

Name	Type	Description	Available Version
`fields`	`List<ConnectApi.AbstractRecordField Class>`	A collection of sub-fields that make up the compound field.	29.0

ConnectApi.ContentAttachment Class

Subclass of ConnectApi.FeedItemAttachment Class

Objects of this type are returned by attachments in feed items with the type ContentPost.

Name	Type	Description	Available Version
`checkSum`	String	MD5 checksum for the file	28.0
`description`	String	Description of the attachment	28.0
`downloadUrl`	String	File’s URL	28.0
`fileExtension`	String	File’s extension	28.0
`fileSize`	String	Size of the file in bytes. If size cannot be determined, returns `unknown`.	28.0
`fileType`	String	Type of file	28.0
`hasImagePreview`	Boolean	`true` if the file has a preview image available, otherwise ,`false`	28.0–29.0
`hasPdfPreview`	Boolean	`true` if the file has a PDF preview available, otherwise, `false`	28.0
`id`	String	Content’s 18-character ID	28.0
`isInMyFileSync`	Boolean	`true` if the file is included in the user’s Salesforce Files folder, and is synced between that folder and Chatter; `false` otherwise.	28.0
`mimeType`	String	File’s MIME type	28.0
`renditionUrl`	String	URL to the file’s rendition resource	28.0
`renditionUrl240By180`	String	URL to the 240 x 180 rendition resource for the file. Renditions are processed asynchronously and might not be available immediately after the file has been uploaded.	30.0
`renditionUrl720By480`	String	URL to the 720 x 480 rendition resource for the file. Renditions are processed asynchronously and might not be available immediately after the file has been uploaded.	30.0
`textPreview`	String	Text preview of the file if available, `null` otherwise.	30.0
`thumb120By90RenditionStatus`	String	Specifies the rendering status of the 120 x 90 preview image of the file. One of these values: `Processing`—Image is being rendered. `Failed`—Rendering process failed. `Success`—Rendering process was successful. `Na`—Rendering is not available for this image.	30.0
`thumb240By180RenditionStatus`	String	Specifies the rendering status of the 240 x 180 preview image of the file. One of these values: `Processing`—Image is being rendered. `Failed`—Rendering process failed. `Success`—Rendering process was successful. `Na`—Rendering is not available for this image.	30.0
`thumb720By480RenditionStatus`	String	Specifies the rendering status of the 720 x 480 preview image of the file. One of these values: `Processing`—Image is being rendered. `Failed`—Rendering process failed. `Success`—Rendering process was successful. `Na`—Rendering is not available for this image.	30.0
`title`	String	Title of the file	28.0
`versionId`	String	File’s version number	28.0

ConnectApi.CurrencyRecordField Class

Subclass of ConnectApi.LabeledRecordField Class

A record field containing a currency value.

ConnectApi.DashboardComponentAttachment Class

Subclass of ConnectApi.FeedItemAttachment Class

Objects of this type are returned as attachments in feed items with type DashboardSnapshot.

Name	Type	Description	Available Version
`componentId`	String	Component’s 18–character ID	28.0
`componentName`	String	Name of the component. If no name is saved with the component, returns the localized string, “Untitled Component.”	28.0
`dashboardBodyText`	String	Text displayed next to the actor in the body of a feed item. This is used instead of the default body text. If no text is specified, and there is no default body text, returns null.	28.0
`dashboardId`	String	Dashboard’s 18–character ID	28.0
`dashboardName`	String	Name of the dashboard.	28.0
`fullSizeImageUrl`	String	URL of the full-sized dashboard image	28.0
`lastRefreshDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z, specifying when this dashboard was last refreshed.	28.0
`lastRefreshDateDisplayText`	String	The text of the last refresh date to be displayed, such as, “Last refreshed on October 31, 2011.”	28.0
`runningUser`	`ConnectApi.UserSummary Class`	The user running the dashboard.	28.0
`thumbnailUrl`	String	URL of the thumbnail-sized dashboard image.	28.0

ConnectApi.DateRecordField Class

Subclass of ConnectApi.LabeledRecordField Class

A record field containing a date.

Name	Type	Description	Available Version
`dateValue`	Date	A date that a machine can read. Ignore the trailing `00:00:00.000Z` characters.	29.0

Name

Type

Description

Available Version

dateValue

Date

A date that a machine can read.

Ignore the trailing 00:00:00.000Z characters.

29.0

ConnectApi.EmailAddress Class

An email address.

Name	Type	Description	Available Version
`displayName`	String	The display name for the email address.	29.0
`emailAddress`	String	The email address.	29.0

ConnectApi.EmailMessage Class

Subclass of ConnectApi.FeedItemAttachment Class

An email message from a case.

Name	Type	Description	Available Version
`direction`	`ConnectApi.EmailMessageDirection`	The direction of the email message. `Inbound`—An inbound message (sent by a customer). `Outbound`—An outbound message (sent to a customer by a support agent).	29.0
`emailMessageId`	String	The ID of the email message.	29.0
`subject`	String	The subject of the email message.	29.0
`textBody`	String	The body of the email message.	29.0
`toAddresses`	`List<ConnectApi.EmailAddress Class>`	A list of email addresses to send the message to.	29.0

ConnectApi.EntityLinkSegment Class

Subclass of ConnectApi.MessageSegment Class

Name	Type	Description	Available Version
`motif`	`ConnectApi.Motif`	A set of small, medium, and large icons that indicate whether the entity is a file, group, record, or user. The motif can also contain the object’s base color.	28.0
`reference`	`ConnectApi.Reference Class`	A reference to the link object if applicable, otherwise, `null`.	28.0

ConnectApi.Features Class

Property	Type	Description	Available Version
`chatter`	Boolean	Indicates whether Chatter is enabled for an organization	28.0
`chatterActivity`	Boolean	Indicates whether the user details include information about Chatter activity	28.0
`chatterAnswers`	Boolean	Indicates whether Chatter Answers is enabled	29.0
`chatterGlobalInfluence`	Boolean	Indicates whether the user details include global Chatter activity	28.0
`chatterGroupRecords`	Boolean	Reserved for future use	30.0
`chatterGroupRecordSharing`	Boolean	Reserved for future use	30.0
`chatterMessages`	Boolean	Indicates whether Chatter messages are enabled for the organization	28.0
`chatterTopics`	Boolean	Indicates whether Chatter topics are enabled	28.0
`communityModeration`	Boolean	Specifies whether Community moderation is enabled.	29.0
`connectRecords`	Boolean	Reserved for future use	28.0
`dashboardComponentSnapshots`	Boolean	Indicates whether the user can post dashboard component snapshots	28.0
`defaultCurrencyIsoCode`	String	The ISO code of the default currency. Applicable only when `multiCurrency` is false.	28.0
`feedPolling`	Boolean	Indicates whether the is-modified resource is enabled for the Chatter API	28.0
`files`	Boolean	Indicates whether files can act as resources for Chatter API	28.0
`filesOnComments`	Boolean	Indicates whether files can be attached to comments	28.0
`groupsCanFollow`	Boolean	Reserved for future use	28.0–29.0
`ideas`	Boolean	Indicates whether Ideas is enabled	29.0
`mobileNotificationsEnabled`	Boolean	Reserved for future use	29.0
`multiCurrency`	Boolean	Indicates whether the user’s organization uses multiple currencies (`true`) or not (`false`). When `false`, the `defaultCurrencyIsoCode` indicates the ISO code of the default currency.	28.0
`publisherActions`	Boolean	Indicates whether publisher actions are enabled	28.0
`storeDataOnDevicesEnabled`	Boolean	Indicates whether the Salesforce1 downloadable apps can use secure, persistent storage on mobile devices to cache data.	30.0
`thanksAllowed`	Boolean	Reserved for future use	28.0
`trendingTopics`	Boolean	Indicates whether trending topics are enabled	28.0
`viralInvitesAllowed`	Boolean	Indicates whether existing Chatter users can invite people in their company to use Chatter	28.0

ConnectApi.Feed Class

Name	Type	Description	Available Version
`feedItemsUrl`	String	Chatter REST API URL of feed items	28.0
`isModifedUrl`	String	A Chatter REST API URL with a `since` request parameter that contains an opaque token that describes when the feed was last modified. Returns `null` if the feed is not a news feed. Use this URL to poll a news feed for updates.	28.0

ConnectApi.FeedBody Class

Subclass of ConnectApi.AbstractMessageBody Class

No additional properties.

As of API version 29.0, the value of the ConnectApi.FeedItem.FeedBody.text property can be null, which means you can’t use it as the default case for rendering text. Instead, use the ConnectApi.FeedItem.MessageBody.text property as the default case.

ConnectApi.FeedDirectory Class

A directory of feeds and favorites.

Name	Type	Description	Available Version
`favorites`	`List<ConnectApi.FeedFavorite Class>`	A list of feed favorites	30.0
`feeds`	`List<ConnectApi.FeedDirectoryItem Class>`	A list of feeds	30.0

ConnectApi.FeedDirectoryItem Class

The definition of a feed.

Name	Type	Description	Available Version
`feedItemsUrl`	String	Chatter REST API resource URL for the feed items of a specific feed.	30.0
`feedType`	`ConnectApi.FeedType`	The feed type. One of these values: `Bookmarks`—Contains all feed items saved as bookmarks by the logged-in user. `Company`—Contains all feed items except feed items of type `TrackedChange`. To see the feed item, the user must have sharing access to its parent. `Files`—Contains all feed items that contain files posted by people or groups that the logged-in user follows. `Filter`—Contains the news feed filtered to contain feed items whose parent is a specified object type. `Groups`—Contains all feed items from all groups the logged-in user either owns or is a member of. `Moderation`—Contains all feed items that have been flagged for moderation. The Communities Moderation feed is available only to users with “Moderate Community Feeds” permissions. `News`—Contains all updates for people the logged-in user follows, groups the user is a member of, files and records the user is following, all updates for records whose parent is the logged-in user, and every feed item and comment that mentions the logged-in user or that mentions a group the logged-in user is a member of. `People`—Contains all feed items posted by all people the logged-in user follows. `Record`—Contains all feed items whose parent is a specified record, which could be a group, user, object, file, or any other standard or custom object. When the record is a group, the feed also contains feed items that mention the group. `To`—Contains all feed items with mentions of the logged-in user, feed items the logged-in user commented on, and feed items created by the logged-in user that are commented on. `Topics`—Contains all feed items that include the specified topic. `UserProfile`—Contains feed items created when a user changes records that can be tracked in a feed, feed items whose parent is the user, and feed items that @mention the user. This feed is different than the news feed, which returns more feed items, including group updates.	30.0
`feedUrl`	String	Chatter REST API resource URL for a specific feed	30.0
`keyPrefix`	String	For filter feeds, this value is the key prefix associated with the entity type used to filter this feed. All feed items in this feed have a parent whose entity type matches this key prefix value. For non-filter feeds, this value is `null`. A key prefix is the first three characters of a record ID, which specifies the entity type.	30.0
`label`	String	Localized label of the feed	30.0

ConnectApi.FeedFavorite Class

Name	Type	Description	Available Version
`community`	`ConnectApi.Reference Class`	Information about the community that contains the favorite	28.0
`createdBy`	`ConnectApi.UserSummary Class`	Favorite’s creator	28.0
`feedUrl`	String	Chatter REST API URL identifying the feed item for this favorite	28.0
`id`	String	Favorite’s 18–character ID	28.0
`lastViewDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z	28.0
`name`	String	Favorite’s name	28.0
`searchText`	String	If the favorite is from a search, contains the search text, otherwise, an empty string	28.0
`target`	`ConnectApi.Reference Class`	A reference to the topic if applicable, `null` otherwise	28.0
`type`	`ConnectApi.FeedFavoriteType` Enum	An empty string or one of the following values: `ListView` `Search` `Topic`	28.0
`url`	String	Chatter REST API URL to this favorite	28.0
`user`	`ConnectApi.UserSummary Class`	Information about the user who saved this favorite	28.0

ConnectApi.FeedFavorites Class

Name	Type	Description	Available Version
`favorites`	`List<ConnectApi.FeedFavorite Class>`	Complete list of favorites	28.0
`total`	Integer	Total number of favorites	28.0

ConnectApi.FeedItem Class

Name	Type	Description	Available Version
`actor`	`ConnectApi.Actor Class`	The entity that created the feed item.	28.0
`attachment`	`ConnectApi.FeedItemAttachment Class`	Information about the attachment. If there is no attachment, returns `null`.	28.0
`body`	`ConnectApi.FeedBody Class`	The body of the feed item. As of API version 29.0, the value of the `ConnectApi.FeedItem.body.text` property can be `null`, which means you can’t use it as the default case for rendering text. Instead, use the `ConnectApi.FeedItem.preamble.text` property as the default case.	28.0
`canShare`	Boolean	`true` if the feed item can be shared, otherwise, `false`	28.0
`clientInfo`	`ConnectApi.ClientInfo Class`	Information about the Connected App used to authenticate the connection.	28.0
`comments`	`ConnectApi.CommentPage Class`	First page of comments for this feed item.	28.0
`createdDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z	28.0
`id`	String	Feed item’s 18–character ID	28.0
`isBookmarkedByCurrentUser`	Boolean	`true` if the current user has bookmarked this feed item, otherwise, `false`.	28.0
`isDeleteRestricted`	Boolean	If this property is `true` the comment cannot be deleted by the context user. If it is `false`, it might be possible for the context user to delete the comment, but it is not guaranteed.	28.0
`isEvent`	Boolean	`true` if feed item created due to an event change, otherwise, `false`	28.0
`isLikedByCurrentUser`	Boolean	`true` if the current user has liked this feed item, otherwise, `false`	28.0
`likes`	`ConnectApi.ChatterLikePage Class`	First page of likes for this feed item	28.0
`likesMessage`	`ConnectApi.MessageBody Class`	A message body the describes who likes the feed item.	28.0
`moderationFlags`	`ConnectApi.ModerationFlags Class`	Information about the moderation flags on a feed item. If `ConnectApi.Features.communityModeration` is `false`, this property is `null`.	29.0
`modifiedDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z	28.0
`myLike`	`ConnectApi.Reference Class`	If the context user has liked the feed item, this property is a reference to the specific like, otherwise, `null`.	28.0
`originalFeedItem`	`ConnectApi.Reference Class`	A reference to the original feed item if this feed item is a shared feed item, otherwise, `null`.	28.0
`originalFeedItemActor`	`ConnectApi.Actor Class`	If this feed item is a shared feed item, returns information about the original poster of the feed item, otherwise, returns `null`.	28.0
`parent`	`ConnectApi.ActorWithId Class`	Feed item’s parent	28.0
`photoUrl`	String	URL of the photo associated with the feed item	28.0
`preamble`	`ConnectApi.MessageBody Class`	A collection of message segments, including the unformatted text of the message that you can use as the title of a feed item. Message segments include name, link, and motif icon information for the actor that created the feed item. As of API version 29.0, the value of the `ConnectApi.FeedItem.body.text` property can be `null`, which means you can’t use it as the default case for rendering text. Instead, use the `ConnectApi.FeedItem.preamble.text` property as the default case.	28.0
`relativeCreatedDate`	String	The created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.”	28.0
`topics`	`ConnectApi.FeedItemTopicPage Class`	Topics for this feed item	28.0
`type`	`ConnectApi.FeedItemType` Enum	Specifies the type of feed item, such as a content post, a text post, and so on. `ActivityEvent`—Feed item generated in Case Feed when an event or task associated with a parent record with a feed enabled is created or updated. `ApprovalPost`—Feed item with an approval action attachment. Approvers can act on the feed item parent. `AttachArticleEvent`—Feed item generated when an article is attached to a case in Case Feed. `BasicTemplateFeedItem`—Feed item with a standard rendering containing an attachment with an image, link, and title. `CallLogPost`—Feed item generated when a call log is saved to a case in Case Feed. `CanvasPost`—Feed item generated by a canvas app in the publisher or from Chatter REST API or Chatter in Apex. The post itself is a link to a canvas app. `CaseCommentPost`—Feed item generated when a case comment is saved in Case Feed. `ChangeStatusPost`—Feed item generated when the status of a case is changed in Case Feed. `ChatTranscriptionPost`—Feed item generated in Case Feed when a Live Agent chat transcript is saved to a case. `CollaborationGroupCreated`—Feed item generated when a new group is created. Contains a link to the new group. `CollaborationGroupUnarchived`—Do not use. Feed item generated when an archived group is activated. `ContentPost`—Feed item with a file attachment. `CreateRecordEvent`—Feed item that describes a record created in the publisher. `DashboardComponentAlert`—Feed item with a dashboard alert attachment. `DashboardComponentSnapshot`—Feed item with a dashboard snapshot attachment. `EmailMessageEvent`—Feed item generated when an email is sent from a case in Case Feed. `FacebookPost`—Feed item generated when a Facebook post is created from a case in Case Feed. `LinkPost`—Feed item with a hyperlink attachment `MilestoneEvent`—Feed item generated when a case milestone is either completed or reaches a violation status. Contains a link to the case milestone. `PollPost`—Feed item with an actionable poll attachment. Viewers of the feed item are allowed to vote on the options in the poll. `ReplyPost`—Feed item generated by a Chatter Answers reply. `RypplePost`—Feed item generated when a Thanks badge is created. `TextPost`—Feed item without an attachment. `TrackedChange`—Feed item created when one or more fields on a record have been changed. `SocialPost`—Feed item generated when a social post is created from a case in Case Feed. `UserStatus`— Deprecated. A user's post to their own profile.	28.0
`url`	String	Chatter REST API URL to this feed item	28.0
`visibility`	`ConnectApi.FeedItemVisibilityType` Enum	Specifies the type of users who can see a feed item. `AllUsers`—Visibility is not limited to internal users. `InternalUsers`—Visibility is limited to internal users.	28.0

ConnectApi.FeedItemAttachment Class

This class is abstract.

Subclasses:

ConnectApi.ApprovalAttachment Class
ConnectApi.BasicTemplateAttachment Class
ConnectApi.CanvasTemplateAttachment Class
ConnectApi.EmailMessage Class
ConnectApi.CaseComment Class
ConnectApi.ContentAttachment Class
ConnectApi.DashboardComponentAttachment Class
ConnectApi.FeedPoll Class
ConnectApi.LinkAttachment Class
ConnectApi.RecordSnapshotAttachment Class
ConnectApi.TrackedChangeAttachment Class

Message segments in a feed item are typed as ConnectApi.MessageSegment. Feed item attachments are typed as ConnectApi.FeedItemAttachment. Record fields are typed as ConnectApi.AbstractRecordField. These classes are all abstract and have several concrete subclasses. At runtime you can use instanceof to check the concrete types of these objects and then safely proceed with the corresponding downcast. When you downcast, you must have a default case that handles unknown subclasses.

The composition of a feed may change between releases. Your code should always be prepared to handle instances of unknown subclasses.

Important

ConnectApi.FeedItemPage Class

A paged collection of ConnectApi.FeedItem objects.

Name	Type	Description	Available Version
`currentPageToken`	String	Token identifying the current page.	28.0
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	28.0
`isModifiedToken`	String	An opaque polling token to use in the `since` parameter of the `ChatterFeeds.isModified` method. The token describes when the feed was last modified.	28.0
`isModifiedUrl`	String	A Chatter REST API URL with a `since` request parameter that contains an opaque token that describes when the feed was last modified. Returns `null` if the feed is not a news feed. Use this URL to poll a news feed for updates.	28.0
`items`	`List<ConnectApi.FeedItem Class>`	List of feed items	28.0
`nextPageToken`	String	Token identifying the next page or `null` if there isn’t a next page.	28.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	28.0
`updatesToken`	String	Token to use in an `updatedSince` parameter, or `null` if not available.	30.0
`updatesUrl`	String	A Chatter REST API resource with a query string containing the value of the `updatesToken` property. The resource returns the feed items that have been updated since the last request. Property is `null` if not available.	30.0

ConnectApi.FeedItemTopicPage Class

Name	Type	Description	Available Version
`canAssignTopics`	Boolean	`true` if a topic can be assigned to the feed item, `false` otherwise	28.0
`topics`	`List<ConnectApi.Topic Class>`	List of topics	28.0

ConnectApi.FeedModifiedInfo Class

Name	Type	Description	Available Version
`isModified`	Boolean	`true` if the news feed has been modified since the last time it was polled; `false` otherwise. Returns `null` if the feed is not a news feed.	28.0
`isModifiedToken`	String	An opaque polling token to use in the `since` parameter of the `ChatterFeeds.isModified` method. The token describes when the feed was last modified.	28.0
`nextPollUrl`	String	A Chatter REST API URL with a `since` request parameter that contains an opaque token that describes when the feed was last modified. Returns `null` if the feed is not a news feed. Use this URL to poll a news feed for updates. Make a request to this URL after requesting the URL in the `Feed.isModifiedUrl` or `FeedItemPage.isModifiedUrl` property.	28.0

ConnectApi.FeedPoll Class

Subclass of ConnectApi.FeedItemAttachment Class

This object is returned as the attachment of ConnectApi.FeedItem objects where the type property is PollPost.

Name	Type	Description	Available Version
`choices`	`List<ConnectApi.FeedPollChoice Class>`	List of choices for poll.	28.0
`myChoiceId`	String	ID of the poll choice that the current user has voted for in this poll. Returns `null` if the current user hasn’t voted.	28.0
`totalVoteCount`	Integer	Total number of votes cast on the feed poll item.	28.0

ConnectApi.FeedPollChoice Class

Name	Type	Description	Available Version
`id`	String	Poll choice ID	28.0
`position`	Integer	The location in the poll where this poll choice exists. The first poll choice starts at 1.	28.0
`text`	String	Label text associated with the poll choice	28.0
`voteCount`	Integer	Total number of votes for this poll choice	28.0
`voteCountRatio`	Double	The ratio of total number of votes for this poll choice to all votes cast in the poll. Multiply the ratio by 100 to get the percentage of votes cast for this poll choice.	28.0

ConnectApi.FieldChangeSegment Class

Subclass of ConnectApi.ComplexSegment Class

No additional properties.

ConnectApi.FieldChangeNameSegment Class

Subclass of ConnectApi.MessageSegment Class

No additional properties.

ConnectApi.FieldChangeValueSegment Class

Subclass of ConnectApi.MessageSegment Class

Name	Type	Description	Available Version
`valueType`	`ConnectApi.FieldChangeValueType`	Specifies the value type of a field change: `NewValue`—A new value `OldValue`—An old value	28.0
`url`	String	URL value if the field change is to a URL field (such as a web address)	28.0

ConnectApi.File Class

This class is abstract.

Subclass of ConnectApi.ActorWithId Class

Superclass of ConnectApi.FileSummary Class

Name	Type	Description	Available Version
`checksum`	String	MD5 checksum for the file	28.0
`contentSize`	Integer	Size of the file in bytes	28.0
`contentUrl`	String	If the file is a link, returns the URL, otherwise, the string “null”	28.0
`description`	String	Description of the file	28.0
`downloadUrl`	String	URL to the file, that can be used for downloading the file	28.0
`fileExtension`	String	Extension of the file	28.0
`fileType`	String	Type of file, such as PDF, PowerPoint, and so on	28.0
`flashRenditionStatus`	String	Specifies if a flash preview version of the file has been rendered	28.0
`isInMyFileSync`	Boolean	`true` if the file is included in the user’s Salesforce Files folder, and is synced between that folder and Chatter; `false` otherwise.	28.0
`mimeType`	String	File’s MIME type	28.0
`moderationFlags`	`ConnectApi.ModerationFlags Class`	Information about the moderation flags on a file. If `ConnectApi.Features.communityModeration` is `false`, this property is `null`.	30.0
`modifiedDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z	28.0
`name`	String	Name of the file	28.0
`origin`	String	Specifies the file source. Valid values are: `Chatter`—file came from Chatter `Content`—file came from content	28.0
`owner`	`ConnectApi.UserSummary Class`	File’s owner	28.0
`pdfRenditionStatus`	String	Specifies if a PDF preview version of the file has been rendered	28.0
`publishStatus`	`ConnectApi.FilePublishStatus`	Specifies the publish status of the file.	28.0
`renditionUrl`	String	URL to the rendition for the file	28.0
`renditionUrl240By180`	String	URL to the 240 x 180 rendition resource for the file. Renditions are processed asynchronously and might not be available immediately after the file has been uploaded.	29.0
`renditionUrl720By480`	String	URL to the 720 x 480 rendition resource for the file. Renditions are processed asynchronously and might not be available immediately after the file has been uploaded.	29.0
`sharingRole`	`ConnectApi.FileSharingType`	Specifies the sharing role of the file.	28.0
`textPreview`	String	Text preview of the file if available, `null` otherwise.	30.0
`thumb120By90RenditionStatus`	String	Specifies the rendering status of the 120 x 90 preview image of the file. One of these values: `Processing`—Image is being rendered. `Failed`—Rendering process failed. `Success`—Rendering process was successful. `Na`—Rendering is not available for this image.	28.0
`thumb240By180RenditionStatus`	String	Specifies the rendering status of the 240 x 180 preview image of the file. One of these values: `Processing`—Image is being rendered. `Failed`—Rendering process failed. `Success`—Rendering process was successful. `Na`—Rendering is not available for this image.	28.0
`thumb720By480RenditionStatus`	String	Specifies the rendering status of the 720 x 480 preview image of the file. One of these values: `Processing`—Image is being rendered. `Failed`—Rendering process failed. `Success`—Rendering process was successful. `Na`—Rendering is not available for this image.	28.0
`title`	String	Title of the file	28.0
`versionNumber`	String	File’s version number	28.0

ConnectApi.FileSummary Class

Subclass of ConnectApi.File Class

This class represents a summary description of a file.

ConnectApi.FollowerPage Class

Name	Type	Description	Available Version
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	28.0
`followers`	`List<ConnectApi.Subscription Class>`	List of subscriptions	28.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	28.0
`previousPageUrl`	String	Chatter REST API URL identifying the previous page or `null` if there isn’t a previous page.	28.0
`total`	Integer	Total number of followers across all pages	28.0

ConnectApi.FollowingCounts Class

Name	Type	Description	Available Version
`people`	Integer	Number of people user is following	28.0
`records`	Integer	Number of records user is following Topics are a type of record that can be followed as of version 29.0.	28.0
`total`	Integer	Total number of items user is following	28.0

ConnectApi.FollowingPage Class

Name	Type	Description	Available Version
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	28.0
`following`	`List<ConnectApi.Subscription Class>`	List of subscriptions	28.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	28.0
`previousPageUrl`	String	Chatter REST API URL identifying the previous page or `null` if there isn’t a previous page.	28.0
`total`	Integer	Total number of records being followed across all pages	28.0

ConnectApi.GlobalInfluence Class

Name	Type	Description	Available Version
`percentile`	String	Percentile value for the user’s influence rank within the organization or community	28.0
`rank`	Integer	Number indicating the user’s influence rank, relative to all other users within the organization or community	28.0

ConnectApi.GroupChatterSettings Class

A user’s Chatter settings for a specific group.

Name	Type	Description	Available Version
`emailFrequency`	`ConnectApi.GroupEmailFrequency` Enum	The frequency with which a group member receives email from a group.	28.0

ConnectApi.GroupInformation Class

Describes the “Information” section of the group. In the Web UI, this section is above the “Description” section. If the group is private, this section is visible only to members.

Name	Type	Description	Available Version
`text`	String	The text of the “Information” section of the group.	28.0
`title`	String	The title of the “Information” section of the group.	28.0

ConnectApi.GroupMember Class

Name	Type	Description	Available Version
`id`	String	User’s 18–character ID	28.0
`role`	`ConnectApi.GroupMembershipType` Enum	Specifies the type of membership the user has with the group, such as group owner, manager, or member. `GroupOwner` `GroupManager` `NotAMember` `NotAMemberPrivateRequested` `StandardMember`	28.0
`url`	String	Chatter REST API URL to this membership	28.0
`user`	`ConnectApi.UserSummary Class`	Information about the user who is subscribed to this group	28.0

ConnectApi.GroupMemberPage Class

Name	Type	Description	Available Version
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	28.0
`members`	`List<ConnectApi.GroupMember Class`>	List of group members	28.0
`myMembership`	`ConnectApi.Reference Class`	If the context user is a member of this group, returns information about that membership, otherwise, `null`.	28.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	28.0
`previousPageUrl`	String	Chatter REST API URL identifying the previous page or `null` if there isn’t a previous page.	28.0
`totalMemberCount`	Integer	Total number of group members across all pages	28.0

ConnectApi.GroupMembershipRequest Class

Name	Type	Description	Available Version
`createdDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z	28.0
`id`	String	ID for the group membership request object	28.0
`lastUpdateDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z	28.0
`requestedGroup`	`ConnectApi.Reference Class`	Information about the group the context user is requesting to join.	28.0
`responseMessage`	String	A message for the user if their membership request is declined. The value of this property is used only when the value of the `status` property is `Declined`. The maximum length is 756 characters.	28.0
`status`	`ConnectApi.GroupMembershipRequestStatus` Enum	The status of a request to join a private group. Values are: `Accepted` `Declined` `Pending`	28.0
`url`	String	URL of the group membership request object.	28.0
`user`	`ConnectApi.UserSummary Class`	Information about the user requesting membership in a group.	28.0

ConnectApi.GroupMembershipRequests Class

Name	Type	Description	Available Version
`requests`	`List<ConnectApi.GroupMembershipRequest Class>`	Information about group membership requests.	28.0
`total`	Integer	The total number of requests.	28.0

ConnectApi.HashtagSegment Class

Subclass of ConnectApi.MessageSegment Class

Name	Type	Description	Available Version
`tag`	String	Text of the topic without the hash symbol (#)	28.0
`topicUrl`	String	Chatter REST API Topics resource that searches for the topic: `1/services/data/v30.0/chatter/topics?exactMatch=true&q=topic`	28.0
`url`	String	Chatter REST API Feed Items resource URL that searches for the topic in all feed items in an organization: `1/services/data/v30.0/chatter/feed-items?q=topic`	28.0

ConnectApi.Icon Class

Property	Type	Description	Available Version
`height`	Integer	The height of the icon in pixels.	28.0
`width`	Integer	The width of the icon in pixels.	28.0
`url`	String	The URL of the icon. This URL is available to unauthenticated users. This URL does not expire.	28.0

ConnectApi.LabeledRecordField Class

This class is abstract.

Subclass of ConnectApi.AbstractRecordField Class

Superclass of:

ConnectApi.CompoundRecordField Class
ConnectApi.CurrencyRecordField Class
ConnectApi.DateRecordField Class
ConnectApi.PercentRecordField Class
ConnectApi.PicklistRecordField Class
ConnectApi.RecordField Class
ConnectApi.ReferenceRecordField Class
ConnectApi.ReferenceWithDateRecordField Class

A record field containing a label and a text value.

The composition of a feed may change between releases. Your code should always be prepared to handle instances of unknown subclasses.

Important

Name	Type	Description	Available Version
`label`	String	A localized string describing the record field.	29.0
`text`	String	The text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property and if it isn’t recognized, render the text value as the default case.	29.0

ConnectApi.LinkAttachment Class

Subclass of ConnectApi.FeedItemAttachment Class

Name	Type	Description	Available Version
`title`	String	Title given to the link if available, otherwise, `null`	28.0
`url`	String	The link URL	28.0

ConnectApi.LinkSegment Class

Subclass of ConnectApi.MessageSegment Class

Name	Type	Description	Available Version
`url`	String	The link URL	28.0

ConnectApi.MentionCompletion Class

Information about a record that could be used to @mention a user or group.

Name	Type	Description	Available Version
`additionalLabel`	String	An additional label (if one exists) for the record represented by this completion, for example, “(Customer)” or “(Acme Corporation)”.	29.0
`description`	String	A description of the record represented by this completion.	29.0
`name`	String	The name of the record represented by this completion. The name is localized, if possible.	29.0
`photoUrl`	String	A URL to the photo or icon of the record represented by this completion.	29.0
`recordId`	String	The ID of the record represented by this completion.	29.0
`userType`	ConnectApi.UserType	If the record represented by this completion is a user, this value is the user type associated with that user; otherwise the value is `null`. One of these values: `ChatterGuest`—User is a Chatter customer in an external group `ChatterOnly`—User is a Chatter Free customer `Guest`—Unauthenticated users `Internal`—User is a standard organization member `Portal`—User is a Customer Portal User, a communities user, and so on. `System`—User is Chatter Expert or a system user `Undefined`—User is a user type that is a custom object.	30.0

ConnectApi.MentionCompletionPage Class

A paginated list of Mention Completion response bodies.

Name	Type	Description	Available Version
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	29.0
`mentionCompletions`	`List<ConnectApi.MentionCompletion Class>`	A list of mention completion proposals. Use these proposals to build a feed post body.	29.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	29.0
`previousPageUrl`	String	Chatter REST API URL identifying the previous page or `null` if there isn’t a previous page.	29.0

ConnectApi.MentionSegment Class

Subclass of ConnectApi.MessageSegment Class

Name	Type	Description	Available Version
`accessible`	Boolean	Specifies whether the mentioned user or group can see the post in which they are mentioned (`true`) or not (`false`).	28.0
`name`	String	Name of the mentioned user or group	28.0
`record`	`ConnectApi.ActorWithId Class`	Information about the mentioned user or group	29.0
`user`	`ConnectApi.UserSummary Class`	Information about the mentioned user	28.0 only In versions before 29.0, if the mention is not a user, the mention is in a `ConnectApi.TextSegment` object.

ConnectApi.MentionValidation Class

Information about whether a proposed mention is valid for the context user.

Name	Type	Description	Available Version
`recordId`	String	The ID of the mentioned record.	29.0
`validationStatus`	connectAPI_enums.htm#MentionValidationStatus	Specifies the type of validation error for a proposed mention, if any. `Disallowed`—The proposed mention is invalid and will be rejected because the context user is trying to mention something that is not allowed. For example a user who is not a member of a private group is trying to mention the private group. `Inaccessible`—The proposed mention is allowed but the user or record being mentioned will not be notified because they don't have access to the parent record being discussed. `Ok`—There is no validation error for this proposed mention.	29.0

ConnectApi.MentionValidations Class

Information about whether a set of mentions is valid for the context user.

Name	Type	Description	Available Version
`hasErrors`	Boolean	Indicates whether at least one of the proposed mentions has an error (`true`), or not (`false`). For example, the context user can’t mention private groups he doesn’t belong to. If such a group were included in the list of mention validations, `hasErrors` would be `true` and the group would have a `validationStatus` of `Disallowed` in its mention validation.	29.0
`mentionValidations`	`List<ConnectApi.MentionValidation Class>`	A list of mention validation information in the same order as the provided record IDs.	29.0

ConnectApi.MessageBody Class

Subclass of ConnectApi.AbstractMessageBody Class

No additional properties.

ConnectApi.MessageSegment Class

This class is abstract.

Superclass of:

ConnectApi.ComplexSegment Class
ConnectApi.EntityLinkSegment Class
ConnectApi.FieldChangeSegment Class
ConnectApi.FieldChangeNameSegment Class
ConnectApi.FieldChangeValueSegment Class
ConnectApi.HashtagSegment Class
ConnectApi.LinkSegment Class
ConnectApi.MentionSegment Class
ConnectApi.MoreChangesSegment Class
ConnectApi.ResourceLinkSegment Class
ConnectApi.TextSegment Class

Message segments in a feed item are typed as ConnectApi.MessageSegment. Feed item attachments are typed as ConnectApi.FeedItemAttachment. Record fields are typed as ConnectApi.AbstractRecordField. These classes are all abstract and have several concrete subclasses. At runtime you can use instanceof to check the concrete types of these objects and then safely proceed with the corresponding downcast. When you downcast, you must have a default case that handles unknown subclasses.

The composition of a feed may change between releases. Your code should always be prepared to handle instances of unknown subclasses.

Important

Name	Type	Description	Available Version
`text`	String	Formatted text of the message.	28.0
`type`	`ConnectApi.MessageSegmentType` Enum	Textual summary of the message segment. The values correspond to the different child classes. Value are: `ConnectApi.EntityLinkSegment Class` `ConnectApi.FieldChangeSegment Class` `ConnectApi.FieldChangeNameSegment Class` `ConnectApi.FieldChangeValueSegment Class` `ConnectApi.HashtagSegment Class` `ConnectApi.LinkSegment Class` `ConnectApi.MentionSegment Class` `ConnectApi.MoreChangesSegment Class` `ConnectApi.ResourceLinkSegment Class` `ConnectApi.TextSegment Class`	28.0

ConnectApi.ModerationFlags Class

Information about the moderation flags on a feed item, comment, or file.

Name	Type	Description	Available Version
`flagCount`	Integer	The number of moderation flags on this feed item, comment, or file. If the logged-in user is not a community moderator, the property is `null`.	29.0
`flaggedByMe`	Boolean	`true` if the logged-in user had flagged the feed item, comment, or file for moderation; `false` otherwise.	29.0

ConnectApi.MoreChangesSegment Class

Subclass of ConnectApi.MessageSegment Class

In feed items with a large number of tracked changes, the message is formatted as: “changed A, B, and made X more changes.” The MoreChangesSegment contains the “X more changes.”

Name	Type	Description	Available Version
`moreChanges`	`List<ConnectApi.FieldChangeSegment Class>`	Complete list of tracked changes.	29.0
`moreChangesCount`	Integer	Number of additional changes	28.0

ConnectApi.Motif

The motif properties contain URLs for small, medium, and large icons that indicate the Salesforce record type. Common record types are files, users, and groups, but all record types have a set of motif icons. Custom object records use their tab style icon. All icons are available to unauthenticated users so that, for example, you can display the motif icons in an email. The motif can also contain the record type’s base color.

The motif images are icons, not user uploaded images or photos. For example, every user has the same set of motif icons.

Note

Custom object records use their tab style icon, for example, the following custom object uses the “boat” tab style:

1"motif": {
2      "color: "8C004C",
3      "largeIconUrl": "/img/icon/custom51_100/boat64.png",
4      "mediumIconUrl": "/img/icon/custom51_100/boat32.png",
5      "smallIconUrl": "/img/icon/custom51_100/boat16.png"
6   },

Users use the following icons:

1"motif": {
2      "color: "1797C0",
3      "largeIconUrl": "/img/icon/profile64.png",
4      "mediumIconUrl": "/img/icon/profile32.png",
5      "smallIconUrl": "/img/icon/profile16.png"
6   },

Groups use the following icons:

1"motif": {
2      "color: "1797C0",
3      "largeIconUrl": "/img/icon/groups64.png",
4      "mediumIconUrl": "/img/icon/groups32.png",
5      "smallIconUrl": "/img/icon/groups16.png"
6   },

Files use the following icons:

1"motif": {
2      "color: "1797C0",
3      "largeIconUrl": "/img/content/content64.png",
4      "mediumIconUrl": "/img/content/content32.png",
5      "smallIconUrl": "/img/icon/files16.png"
6   },

To view the icons in the previous examples, preface the URL with https://instance_name. For example, https://instance_name/img/icon/profile64.png.

Note

Name	Type	Description	Available Version
`color`	String	A hex value representing the base color of the record type, or `null`.	29.0
`largeIconUrl`	String	A large icon indicating the record type.	28.0
`mediumIconUrl`	String	A medium icon indicating the record type.	28.0
`smallIconUrl`	String	A small icon indicating the record type.	28.0

ConnectApi.OrganizationSettings Class

Name	Type	Description	Available Version
`accessTimeout`	Integer	Amount of time after which the system prompts users who have been inactive to log out or continue working	28.0
`features`	`ConnectApi.Features Class`	Information about features available in the organization	28.0
`name`	String	Organization name	28.0
`orgId`	String	18-character ID for the organization	28.0
`userSettings`	`ConnectApi.UserSettings Class`	Information about the organization permissions for the user	28.0

ConnectApi.PercentRecordField Class

Subclass of ConnectApi.LabeledRecordField Class

A record field containing a percentage value.

Name	Type	Description	Available Version
`value`	Double	The value of the percentage.	29.0

ConnectApi.PhoneNumber Class

A phone number.

Name	Type	Description	Available Version
`label`	String	A localized string indicating the phone type	30.0
`phoneNumber`	String	Phone number	28.0
`phoneType`	String	Phone type. Values are: `Fax` `Mobile` `Work` These values are not localized.	30.0
`type`	String	This property is not available after version 29.0. Use the `phoneType` property instead. Note Values are: `Fax` `Mobile` `Work` These values are not localized.	28.0–29.0

ConnectApi.Photo Class

Name	Type	Description	Available Version
`fullEmailPhotoUrl`	String	A temporary URL to the large profile picture. The URL expires after 30 days and is available to unauthenticated users.	28.0
`largePhotoUrl`	String	URL to the large profile picture. The default width is 200 pixels, and the height is scaled so the original image proportions are maintained.	28.0
`photoVersionId`	String	18–character ID to that version of the photo	28.0
`smallPhotoUrl`	String	URL to the small profile picture. The default size is 64x64 pixels.	28.0
`standardEmailPhotoUrl`	String	A temporary URL to the small profile. The URL expires after 30 days and is available to unauthenticated users.	28.0
`url`	String	A resource that returns a Photo object: for example, `/services/data/v30.0/chatter/users/005D0000001LL8OIAW/photo`.	28.0

ConnectApi.PicklistRecordField Class

Subclass of ConnectApi.LabeledRecordField Class

A record field containing an enumerated value.

ConnectApi.RecordField Class

Subclass of ConnectApi.LabeledRecordField Class

A generic record field containing a label and text value.

ConnectApi.RecordSnapshotAttachment Class

Subclass of ConnectApi.FeedItemAttachment Class

The fields of a record at the point in time when the record was created.

Name	Type	Description	Available Version
`recordView`	ConnectApi.RecordView Class	The representation of the record.	29.0

ConnectApi.RecordSummary Class

Subclass of ConnectApi.AbstractRecordView Class.

No additional properties.

ConnectApi.RecordSummaryList Class

Summary information about a list of records in the organization including custom objects.

Name	Type	Description	Available Version
`records`	`List<ConnectApi.ActorWithId Class>`	A list of records.	30.0
`url`	String	The URL to this list of records.	30.0

ConnectApi.RecordView Class

Subclass of ConnectApi.AbstractRecordView Class

A view of any record in the organization, including a custom object record. This object is used if a specialized object, such as User or ChatterGroup, is not available for the record type. Contains data and metadata so you can render a record with one response.

Name	Type	Description	Available Version
`sections`	`List<ConnectApi.RecordViewSection Class>`	A list of record view sections.	29.0

ConnectApi.RecordViewSection Class

A section of record fields and values on a record detail.

Name	Type	Description	Available Version
`columnCount`	Integer	The number of columns to use to lay out the fields in a record section.	29.0
`columnOrder`	`ConnectApi.RecordColumnOrder`	The order of the fields to use in the `fields` property to lay out the fields in a record section. `LeftRight`—Fields are rendered from left to right. `TopDown`—Fields are rendered from the top down.	29.0
`fields`	`ConnectApi.AbstractRecordField Class`	The fields and values for the record contained in this section.	29.0
`heading`	String	A localized label to display when rendering this section of fields.	29.0
`isCollapsible`	Boolean	Indicates whether the section can be collapsed to hide all the fields (`true`) or not (`false`).	29.0

ConnectApi.Reference Class

Name	Type	Description	Available Version
`id`	String	18–character id of the object being referenced	28.0
`url`	String	URL to the resource	28.0

ConnectApi.ReferenceRecordField Class

Subclass of ConnectApi.LabeledRecordField Class

A record field containing a reference to another object.

Name	Type	Description	Available Version
`reference`	`ConnectApi.RecordSummary Class`	The object referenced by the record field.	29.0

ConnectApi.ReferenceWithDateRecordField Class

Subclass of ConnectApi.LabeledRecordField Class

A record field containing a referenced object that acted at a specific time, for example, “Created By...”.

Name	Type	Description	Available Version
`dateValue`	Date	A time at which the referenced object acted.	29.0
`reference`	`ConnectApi.RecordSummary Class`	The object referenced by the record field.	29.0

ConnectApi.ResourceLinkSegment Class

Name	Type	Description	Available Version
`url`	String	URL to a resource not otherwise identified by an ID field, for example, a link to a list of users.	28.0

ConnectApi.Subscription Class

Name	Type	Description	Available Version
`community`	`ConnectApi.Reference Class`	Information about the community in which the subscription exists	28.0
`id`	String	Subscription’s 18–character ID	28.0
`subject`	`ConnectApi.Actor Class`	Information about the parent, that is, the thing or person being followed	28.0
`subscriber`	`ConnectApi.Actor Class`	Information about the subscriber, that is, the person following this item	28.0
`url`	String	Chatter REST API URL to this specific subscription	28.0

ConnectApi.TextSegment Class

Subclass of ConnectApi.MessageSegment Class

No additional properties.

ConnectApi.TimeZone Class

The user's time zone as selected in My Settings in Salesforce. This value does not reflect a device's current location.

Name	Type	Description	Available Version
`gmtOffset`	Double	Signed offset, in hours, from GMT	30.0
`name`	String	Display name of this time zone	30.0

ConnectApi.Topic Class

Name	Type	Description	Available Version
`createdDate`	Datetime	ISO8601 date string, for example, 2011-02-25T18:24:31.000Z	29.0
`description`	String	Description of the topic	29.0
`id`	String	18-character ID	29.0
`name`	String	Name of the topic	29.0
`talkingAbout`	Integer	Number of people talking about this topic over the last two months, based on factors such as topic additions and comments on posts with the topic	29.0
`url`	String	URL to the topic detail page	29.0

ConnectApi.TopicEndorsement Class

Represents one user endorsing another user for a single topic.

Name	Type	Description	Available Version
`endorsee`	`ConnectApi.UserSummary Class`	User being endorsed	30.0
`endorsementId`	String	18-character ID of the endorsement record	30.0
`endorser`	`ConnectApi.UserSummary Class`	User performing the endorsement	30.0
`topic`	`ConnectApi.Topic Class`	Topic the user is being endorsed for	30.0
`url`	String	URL to the resource for the endorsement record	30.0

ConnectApi.TopicEndorsementCollection Class

A collection of topic endorsement response bodies.

Name	Type	Description	Available Version
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	30.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	30.0
`previousPageUrl`	String	Chatter REST API URL identifying the previous page or `null` if there isn’t a previous page.	30.0
`topicEndorsements`	`List<ConnectApi.Topic Class>`	List of topic endorsements	30.0

ConnectApi.TopicPage Class

Name	Type	Description	Available Version
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	29.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	29.0
`topics`	`List<ConnectApi.Topic Class>`	List of topics	29.0

ConnectApi.TopicSuggestion Class

Name	Type	Description	Available Version
`existingTopic`	ConnectApi.Topic Class	Topic that already exists or `null` for a new topic	29.0
`name`	String	Topic name	29.0

ConnectApi.TopicSuggestionPage Class

Name	Type	Description	Available Version
`TopicSuggestionPage`	`List<ConnectApi.TopicSuggestion Class>`	List of topic suggestions	29.0

ConnectApi.TrackedChangeAttachment Class

Name	Type	Description	Available Version
`changes`	`List<ConnectApi.TrackedChangeItem Class>`	A list of tracked changes.	28.0

ConnectApi.TrackedChangeItem Class

Name	Type	Description	Available Version
`fieldName`	String	The name of the field that was updated.	28.0
`newValue`	String	The new value of the field or `null` if the field length is long.	28.0
`oldValue`	String	The old value of the field or `null` if the field length is long.	28.0

ConnectApi.UnauthenticatedUser Class

Subclass of ConnectApi.Actor Class

No additional properties.

Instances of this class are used as the actor for feed items and comments posted by Chatter customers.

ConnectApi.UnreadConversationCount Class

Name	Type	Description	Available Version
`hasMore`	Boolean	Specifies if there are more unread messages (`true`) or not (`false`)	29.0
`unreadCount`	Integer	The number of unread messages	29.0

ConnectApi.User

Subclass of ConnectApi.ActorWithId Class

Superclass of:

ConnectApi.UserDetail Class
ConnectApi.UserSummary Class

Name	Type	Description	Available Version
`additionalLabel`	String	An additional label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.” If the user doesn’t have an additional label, the value is `null`.	30.0
`companyName`	String	Name of the company	28.0
`firstName`	String	User's first name	28.0
`isChatterGuest`	Boolean	`true` if user is a Chatter customer; `false` otherwise.	28.0
`isInThisCommunity`	Boolean	`true` if user is in the same community as the context user; `false` otherwise	28.0
`lastName`	String	User's last name	28.0
`photo`	`ConnectApi.Photo Class`	Information about the user's photos	28.0
`title`	String	User’s title	28.0
`userType`	`ConnectApi.UserType` Enum	Specifies the type of user. `ChatterGuest`—User is a Chatter customer in an external group `ChatterOnly`—User is a Chatter Free customer `Guest`—Unauthenticated users `Internal`—User is a standard organization member `Portal`—User is a Customer Portal User, a communities user, and so on. `System`—User is Chatter Expert or a system user `Undefined`—User is a user type that is a custom object.	28.0

ConnectApi.UserCapabilities

The capabilities associated with a user profile.

Name	Type	Description	Available Version
`canChat`	Boolean	Specifies if the context user can use Chatter Messenger with the subject user (`true`) or not (`false`)	29.0
`canDirectMessage`	Boolean	Specifies if the context user can direct message the subject user (`true`) or not (`false`)	29.0
`canEdit`	Boolean	Specifies if the context user can edit the subject user’s account (`true`) or not (`false`)	29.0
`canFollow`	Boolean	Specifies if the context user can follow the subject user’s feed (`true`) or not (`false`)	29.0
`canViewFeed`	Boolean	Specifies if the context user can view the feed of the subject user (`true`) or not (`false`)	29.0
`canViewFullProfile`	Boolean	Specifies if the context user can view the full profile of the subject user (`true`) or only the limited profile (`false`)	29.0
`isModerator`	Boolean	Specifies if the subject user is a Chatter moderator or admin (`true`) or not (`false`)	29.0

ConnectApi.UserChatterSettings Class

A user’s global Chatter settings.

Name	Type	Description	Available Version
`defaultGroupEmailFrequency`	`ConnectApi.GroupEmailFrequency` Enum	The default frequency with which a user receives email from a group when they join it.	28.0

ConnectApi.UserDetail Class

Subclass of ConnectApi.User

Details about a user in an organization.

If the context user doesn’t have permission to see a property, its value is set to null.

Name	Type	Description	Available Version
`aboutMe`	String	Text from user's profile	28.0
`address`	`ConnectApi.Address Class`	User’s address	28.0
`chatterActivity`	`ConnectApi.ChatterActivity Class`	Chatter activity statistics	28.0
`chatterInfluence`	`ConnectApi.GlobalInfluence Class`	User’s influence rank	28.0
`email`	String	User's email address	28.0
`followersCount`	Integer	Number of users following this user	28.0
`followingCounts`	`ConnectApi.FollowingCounts Class`	Information about items the user is following	28.0
`groupCount`	Integer	Number of groups user is following	28.0
`isActive`	Boolean	`true` if user is active; `false` otherwise	28.0
`managerId`	String	18–character ID of the user’s manager	28.0
`managerName`	String	Locale-based concatenation of manager's first and last names	28.0
`thanksReceived`	Integer	The number of times the user has been thanked.	29.0
`phoneNumbers`	`List<ConnectApi.PhoneNumber Class>`	Collection of user's phone numbers	28.0
`username`	String	Username of the user, such as `Admin@mycompany.com`.	28.0

ConnectApi.UserGroupPage Class

A paginated list of groups the context user is a member of.

Name	Type	Description	Available Version
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	28.0
`groups`	`List<ConnectApi.ChatterGroupSummary Class>`	List of groups	28.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	28.0
`previousPageUrl`	String	Chatter REST API URL identifying the previous page or `null` if there isn’t a previous page.	28.0
`total`	Integer	Total number of groups across all pages	28.0

ConnectApi.UserPage Class

Name	Type	Description	Available Version
`currentPageToken`	Integer	Token identifying the current page.	28.0
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	28.0
`nextPageToken`	Integer	Token identifying the next page or `null` if there isn’t a next page.	28.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	28.0
`previousPageToken`	Integer	Token identifying the previous page or `null` if there isn’t a previous page.	28.0
`previousPageUrl`	String	Chatter REST API URL identifying the previous page or `null` if there isn’t a previous page.	28.0
`users`	`List<ConnectApi.UserDetail Class>`	List of user detail information. If the context user doesn’t have permission to see a property, the property is set to `null`.	28.0

ConnectApi.UserProfile

Details necessary to render a view of a user profile.

Name	Type	Description	Available Version
`capabilities`	`ConnectApi.UserCapabilities`	The context user’s capabilities specific to the subject user’s profile	29.0
`id`	String	The ID of the user attached to the profile	29.0
`tabs`	`List<ConnectApi.UserProfileTab>`	The tabs visible to the context user specific to the subject user’s profile	29.0
`url`	String	The URL of the user’s profile	29.0
`userDetail`	`ConnectApi.UserDetail`	The details about the user attached to the profile	29.0

ConnectApi.UserProfileTab

Information about a profile tab.

Name	Type	Descriptio	Available Version
`id`	String	The tab’s unique identifier or 18–character ID	29.0
`isDefault`	Boolean	Specifies if the tab appears first when clicking the user profile (`true`) or not (`false`)	29.0
`tabType`	`ConnectApi.UserProfileTabType`	Specifies the type of tab	29.0
`tabUrl`	String	The current tab’s content URL (for non built-in tab types)	29.0

ConnectApi.UserSettings Class

Property	Type	Description	Available Version
`approvalPosts`	Boolean	User can approve workflows from Chatter posts.	28.0
`canFollow`	Boolean	User can follow users and records	28.0
`canModifyAllData`	Boolean	User has “Modify all Data” permission	28.0
`canOwnGroups`	Boolean	User can own groups	28.0
`canViewAllData`	Boolean	User has “View all Data” permission	28.0
`canViewAllGroups`	Boolean	User has “View all Groups” permission	28.0
`canViewAllUsers`	Boolean	User has “View all Users” permission	28.0
`canViewFullUserProfile`	Boolean	User can see other user’s Chatter profiles	28.0
`canViewPublicFiles`	Boolean	User can see all files marked as public	28.0
`currencySymbol`	String	Currency symbol to use for displaying currency values. Applicable only when the `ConnectApi.Features.multiCurrency` property is `false`.	28.0
`externalUser`	Boolean	User is a Chatter customer	28.0
`fileSyncStorageLimit`	Integer	Maximum storage for synced files, in megabytes (MB)	29.0
`hasAccessToInternalOrg`	Boolean	User is a member of the internal organization	28.0
`hasFileSync`	Boolean	User has “Sync Files” permission.	28.0
`hasRestDataApiAccess`	Boolean	User has access to REST API.	29.0
`timeZone`	ConnectApi.TimeZone Class	The user's time zone as selected in My Settings in Salesforce. This value does not reflect a device's current location.	30.0
`userDefaultCurrencyIsoCode`	String	The ISO code for the default currency. Applicable only when the `ConnectApi.Features.multiCurrency` property is `true`.	28.0
`userId`	String	18-character ID of the user	28.0
`userLocale`	String	Locale of user	28.0

ConnectApi.UserSummary Class

Subclass of ConnectApi.User

Name	Type	Description	Available Version
`isActive`	Boolean	`true` if user is active; `false` otherwise	28.0

ConnectApi.Zone

Information about a Chatter Answers zone.

Name	Type	Description	Available Version
`description`	String	The description of the zone	29.0
`id`	String	The zone ID	29.0
`isActive`	Boolean	Indicates whether or not the zone is active	29.0
`isChatterAnswers`	Boolean	Indicates whether or not the zone is available for Chatter Answers	29.0
`name`	String	Name of the zone	29.0
`url`	String	The URL of the zone	30.0
`visibility`	`ConnectApi.ZoneShowIn`	Zone visibility type `Community`—Available in a community. `Internal`—Available internally only. `Portal`—Available in a portal.	29.0
`visibilityId`	String	If the zone is available in a portal or a community, this property contains the ID of the portal or community. If the zone is available to all portals, this property contains the value `All`.	29.0

ConnectApi.ZonePage

Information about zone pages.

Name	Type	Description	Available Version
`zones`	`List<ConnectApi.Zone>`	A list of one or more zones	29.0
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	29.0
`nextPageUrl`	String	Token identifying the next page or `null` if there isn’t a next page.	29.0

ConnectApi.ZoneSearchPage

Information about the search results for zones.

Name	Type	Description	Available Version
`currentPageToken`	String	Token identifying the current page.	29.0
`currentPageUrl`	String	Chatter REST API URL identifying the current page.	29.0
`items`	`List<ConnectApi.ZoneSearchResult`>	List of search results	29.0
`nextPageToken`	String	Token identifying the next page or `null` if there isn’t a next page.	29.0
`nextPageUrl`	String	Chatter REST API URL identifying the next page or `null` if there isn’t a next page.	29.0

ConnectApi.ZoneSearchResult

Information about a specific zone search result.

Name	Type	Description	Available Version
`hasBestAnswer`	Boolean	Indicates if the search result has a best answer	29.0
`id`	String	ID of the search result. The search result can be a question or an article.	29.0
`title`	String	Title of the search result	29.0
`type`	`ConnectApi.ZoneSearchResultType`	Specifies the zone search result type `Article`—Search results contain only articles. `Question`—Search results contain only questions.	29.0
`voteCount`	String	Number of votes given to the search result	29.0

Force.com Apex Code Developer's Guide

No Results

ConnectApi.AbstractMessageBody Class

ConnectApi.​​Abstract​RecordField Class

ConnectApi.​AbstractRecordView Class

ConnectApi.Actor Class

ConnectApi.​ActorWithId Class

ConnectApi.​Address Class

ConnectApi.ApprovalAttachment Class

ConnectApi.​Approval​Post​Template​Field Class

ConnectApi.BasicTemplateAttachment Class

ConnectApi.BlankRecordField Class

ConnectApi.CanvasTemplateAttachment Class

ConnectApi.CaseComment Class

ConnectApi.​Chatter​Activity Class

ConnectApi.​Chatter​Conversation Class

ConnectApi.​Chatter​ConversationPage Class

ConnectApi.​Chatter​ConversationSummary Class

ConnectApi.ChatterGroup Class

ConnectApi.​Chatter​Group​Detail Class

ConnectApi.Chatter​​​GroupPage Class

ConnectApi.​Chatter​Group​Summary Class

ConnectApi.​Chatter​Group​SummaryPage Class

ConnectApi.​Chatter​Like Class

ConnectApi.​Chatter​Like​Page Class

ConnectApi.​Chatter​Message Class

ConnectApi.​Chatter​MessagePage Class

ConnectApi.​ClientInfo Class

ConnectApi.​Comment Class

ConnectApi.​Comment​​Page Class

ConnectApi.​Community Class

ConnectApi.CommunityPage Class

ConnectApi.ComplexSegment Class

ConnectApi.​Compound​RecordField Class

ConnectApi.ContentAttachment Class

ConnectApi.​CurrencyRecordField Class

ConnectApi.​Dashboard​ComponentAttachment Class

ConnectApi.DateRecordField Class

ConnectApi.EmailAddress Class

ConnectApi.EmailMessage Class

ConnectApi.​EntityLinkSegment Class

ConnectApi.Features Class

ConnectApi.Feed Class

ConnectApi.​FeedBody Class

ConnectApi.FeedDirectory Class

ConnectApi.FeedDirectoryItem Class

ConnectApi.​Feed​Favorite Class

ConnectApi.FeedFavorites Class

ConnectApi.FeedItem Class

ConnectApi.​FeedItem​Attachment Class

ConnectApi.FeedItem​Page Class

ConnectApi.FeedItemTopicPage Class

ConnectApi.Feed​ModifiedInfo Class

ConnectApi.FeedPoll Class

ConnectApi.​Feed​Poll​Choice Class

ConnectApi.​FieldChange​Segment Class

ConnectApi.​FieldChangeName​Segment Class

ConnectApi.​FieldChange​ValueSegment Class

ConnectApi.File Class

ConnectApi.FileSummary Class

ConnectApi.​FollowerPage Class

ConnectApi.​Following​Counts Class

ConnectApi.​FollowingPage Class

ConnectApi.​Global​Influence Class

ConnectApi.Group​​ChatterSettings Class

ConnectApi.​Group​Information Class

ConnectApi.​GroupMember Class

ConnectApi.Group​​MemberPage Class

ConnectApi.​Group​Membership​Request Class

ConnectApi.Group​​MembershipRequests Class

ConnectApi.HashtagSegment Class

ConnectApi.Icon Class

ConnectApi.​LabeledRecord​Field Class

ConnectApi.LinkAttachment Class

ConnectApi.LinkSegment Class

ConnectApi.​MentionCompletion Class

ConnectApi.​MentionCompletion​Page Class

ConnectApi.​MentionSegment Class

ConnectApi.​MentionValidation Class

ConnectApi.AbstractRecordField Class

ConnectApi.AbstractRecordView Class

ConnectApi.ActorWithId Class

ConnectApi.Address Class

ConnectApi.ApprovalPostTemplateField Class

ConnectApi.ChatterActivity Class

ConnectApi.ChatterConversation Class

ConnectApi.ChatterConversationPage Class

ConnectApi.ChatterConversationSummary Class

ConnectApi.ChatterGroupDetail Class

ConnectApi.ChatterGroupPage Class

ConnectApi.ChatterGroupSummary Class

ConnectApi.ChatterGroupSummaryPage Class

ConnectApi.ChatterLike Class

ConnectApi.ChatterLikePage Class

ConnectApi.ChatterMessage Class

ConnectApi.ChatterMessagePage Class

ConnectApi.ClientInfo Class

ConnectApi.Comment Class

ConnectApi.CommentPage Class

ConnectApi.Community Class

ConnectApi.CompoundRecordField Class

ConnectApi.CurrencyRecordField Class

ConnectApi.DashboardComponentAttachment Class

ConnectApi.EntityLinkSegment Class

ConnectApi.FeedBody Class

ConnectApi.FeedFavorite Class

ConnectApi.FeedItemAttachment Class

ConnectApi.FeedItemPage Class

ConnectApi.FeedModifiedInfo Class

ConnectApi.FeedPollChoice Class

ConnectApi.FieldChangeSegment Class

ConnectApi.FieldChangeNameSegment Class

ConnectApi.FieldChangeValueSegment Class

ConnectApi.FollowerPage Class

ConnectApi.FollowingCounts Class

ConnectApi.FollowingPage Class

ConnectApi.GlobalInfluence Class

ConnectApi.GroupChatterSettings Class

ConnectApi.GroupInformation Class

ConnectApi.GroupMember Class

ConnectApi.GroupMemberPage Class

ConnectApi.GroupMembershipRequest Class

ConnectApi.GroupMembershipRequests Class

ConnectApi.LabeledRecordField Class

ConnectApi.MentionCompletion Class

ConnectApi.MentionCompletionPage Class

ConnectApi.MentionSegment Class

ConnectApi.MentionValidation Class

ConnectApi.MentionValidations Class

ConnectApi.MessageBody Class

ConnectApi.MessageSegment Class

ConnectApi.ModerationFlags Class

ConnectApi.Motif

ConnectApi.PhoneNumber Class

ConnectApi.RecordField Class

ConnectApi.RecordSnapshotAttachment Class

ConnectApi.RecordSummary Class

ConnectApi.RecordSummaryList Class

ConnectApi.RecordView Class

ConnectApi.RecordViewSection Class

ConnectApi.Reference Class

ConnectApi.ReferenceRecordField Class

ConnectApi.ReferenceWithDateRecordField Class

ConnectApi.ResourceLinkSegment Class

ConnectApi.Subscription Class

ConnectApi.TimeZone Class

ConnectApi.Topic Class

ConnectApi.TopicEndorsement Class

ConnectApi.TopicEndorsementCollection Class

ConnectApi.TopicPage Class

ConnectApi.TopicSuggestion Class

ConnectApi.TopicSuggestionPage Class

ConnectApi.TrackedChangeAttachment Class

ConnectApi.TrackedChangeItem Class

ConnectApi.UnreadConversationCount Class

ConnectApi.UserCapabilities

ConnectApi.UserChatterSettings Class

ConnectApi.UserDetail Class

ConnectApi.UserGroupPage Class