Reference Apex Classes
Name Type Description
users List<ConnectApi. List of user detail information. If the context user doesn’t have
UserDetail Class> permission to see a property, the property is set to null..
ConnectApi.UserSettings Class
Property Type Description
approvalPosts Boolean User can approve workflows from Chatter posts.
canFollow Boolean User can follow users and records
canModifyAllData Boolean User has “Modify all Data” permission
canOwnGroups Boolean User can own groups
canViewAllData Boolean User has “View all Data” permission
canViewAllGroups Boolean User has “View all Groups” permission
canViewAllUsers Boolean User has “View all Users” permission
canViewFullUserProfile Boolean User can see other user’s Chatter profiles
canViewPublicFiles Boolean User can see all files marked as public
currencySymbol String Currency symbol to use for displaying currency values. Applicable
only when the ConnectApi.Features.multiCurrency
property is false.
externalUser Boolean User is a Chatter customer
hasAccessToInternalOrg Boolean User is a member of the internal organization
hasFileSync Boolean Reserved for future use
userDefaultCurrencyIsoCode String The ISO code for the default currency. Applicable only when the
ConnectApi.Features.multiCurrency property is true.
userId String 18-character ID of the user
userLocale String Locale of user
ConnectApi.UserSummary Class
Child class of ConnectApi.User.
Name Type Description
isActive Boolean true if user is active; false otherwise
See Also:
Chatter in Apex Classes
607
Reference Apex Classes
ConnectApi Enums
An enum is a data type whose values are constants.
ConnectApi enums inherit all properties and methods of Apex enums.
ConnectApi provides these enums:
Enum Description
ConnectApi.CaseActorType 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
ConnectApi.CommentType Specifies the type of comment.
• ContentComment—the comment contains an attachment
• TextComment—the comment contains only text
ConnectApi.CommunityStatus Specifies the current status of the community.
• Live
• Inactive
• UnderConstruction
ConnectApi.FeedFavoriteType Specifies the origin of the feed favorite, such as whether it’s a
search term or a list view:
• ListView
• Search
• Topic
ConnectApi.FeedItemAttachmentType Specifies the attachment type for feed item output objects:
• Approval—A feed item requiring approval.
• BasicTemplate—A feed item with a generic rendering
of an image, link, and title.
• CaseComment—A feed item created from a comment to
a Case record.
• Content—A feed item with a file attached.
• DashboardComponent—A feed item with a dashboard
attached.
• Link—A feed item with a URL attached.
• Poll—A feed item with a poll attached.
ConnectApi.FeedItemAttachmentInputType Specifies the attachment type for feed item input objects:
• ExistingContent—A feed item with a previously
uploaded file attached.
• Link—A feed item with a URL attached.
• NewFile—A feed item with a file attachment that was
uploaded with the post.
• Poll—A feed item with a poll attached.
608
Reference Apex Classes
Enum Description
ConnectApi.FeedItemType Specifies the type of feed item, such as a content post, a text
post, and so on.
• ActivityEvent—Feed item generated when CaseFeed
is on and 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.
• 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 a
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—Feed item
generated when an archived group is unarchived.
• 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 the Case Feed.
• FacebookPost—Feed item generated when an Facebook
post is created from a case in the Case Feed.
• LinkPost—Feed item with a hyperlink attachment
• PollPost—Feed item with an actionable poll attachment.
Viewers of the feed item are allowed to vote on the options
in the poll.
• ReplyPost
• 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.
609
Reference Apex Classes
Enum Description
• TwitterPost—Feed item generated when a Twitter post
is created from a case in Case Feed.
• UserStatus—
Deprecated. A user's post to their own profile.
ConnectApi.FeedItemVisibilityType Specifies the type of users who can see a feed item.
• AllUsers
• InternalUsers
ConnectApi.FeedSortOrder Specifies the order returned by the sort, such as by date created
or last modified:
• CreatedDateDesc
• LastModifiedDateDesc
ConnectApi.FeedType Specifies the type of feed, such as a feed made up of
bookmarks, groups, or records:
• Bookmarks
• Company
• Files
• Groups
• News
• People
• Record
• To
• Topics
• UserProfile
ConnectApi.GroupEmailFrequency Specifies the frequency with which a user receives email from
a group.
• EachPost
• DailyDigest
• WeeklyDigest
• Never
• UseDefault
Do not use the value UseDefault in the
ChatterUsers.updateChatterSettings method
because this method sets the default value.
ConnectApi.GroupMembershipType Specifies the type of membership the user has with the group,
such as group owner, manager, or member.
• GroupOwner
• GroupManager
• NotAMember
• NotAMemberPrivateRequested
• StandardMember
610
Reference Apex Classes
Enum Description
ConnectApi.GroupMembershipRequestStatus The status of a request to join a private group.
• Accepted
• Declined
• Pending
ConnectApi.GroupVisibilityType Specifies whether a group is private or public.
• PrivateAccess
• PublicAccess
ConnectApi.MessageSegmentType Specifies the type of message segment, such as text, link, field
change name, or field change value.
• EntityLink
• FieldChange
• FieldChangeName
• FieldChangeValue
• Hashtag
• Link
• Mention
• MoreChanges
• ResourceLink
• Text
ConnectApi.UserType 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.
ConnectApi.WorkflowProcessStatus Specifies the status of a workflow process.
• Approved
• Fault
• Held
• NoResponse
• Pending
• Reassigned
• Rejected
• Removed
611