Newer Version Available

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

ConnectApi Enums

Enums specific to ConnectApi.

ConnectApi enums inherit all properties and methods of Apex 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.​​​CaseCommentEventType Specifies the event type of a comment in Case Feed.
  • NewInternal—A case comment that has newly been marked Internal Only.
  • NewPublished—A newly published case comment.
  • NewPublishedByCustomer—A case comment by a customer that was newly published.
  • PublishExsiting—An existing case comment that was re-published.

    Although this value appears to be a typo, it’s not. Use this spelling in your code.

    Note

  • PublishExistingByCustomer—An existing case comment by a customer that was re-published.
  • UnpublishExisting—An existing case comment that was unpublished.
  • UnpublishExistingByCustomer—An existing case comment by a customer that was unpublished.
ConnectApi.​​​CommentType Specifies the type of comment.
  • ContentComment—Comment contains an attachment.
  • TextComment—Comment contains only text.
ConnectApi.CommunityFlagVisibility Specifies the visibility behavior of a flag for various user types.
  • ModeratorsOnly—The flag is visible only to users with moderation permissions on the flagged item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged item.
ConnectApi.​​​CommunityStatus Specifies the current status of the community.
  • Live
  • Inactive
  • UnderConstruction
ConnectApi.EmailMessageDirection Specifies the direction of an email message on a case.
  • Inbound—An inbound message (sent by a customer).
  • Outbound—An outbound message (sent to a customer by a support agent).
ConnectApi.FeedDensity Specifies the density of the feed.
  • AllUpdates—Displays all posts and comments from people and records the user follows and groups the user is a member of.
  • FewerUpdates—Displays all posts and comments from people and records the user follows and groups the user is a member of, but hides system-generated posts from records that nobody commented on.
ConnectApi.​​​FeedFavorite​​​Type Specifies the origin of the feed favorite, such as whether it’s a search term or a list view:
  • ListView
  • Search
  • Topic
ConnectApi.​​​FeedItem​​​Attachment​​​InputType Specifies the attachment type for feed item input objects:
  • Canvas—A feed item that contains the metadata to create a canvas app.
  • 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.
ConnectApi.​​​FeedItem​​​AttachmentType 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.
  • Canvas—A feed item that contains the metadata to render a link to a canvas app.
  • CaseComment—A feed item created from a comment to a case record.
  • 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.
  • EmailMessage—An email attached to a case record in Case Feed.
  • Link—A feed item with a URL attached.
  • Poll—A feed item with a poll attached.
  • RecordSnapshot—The feed item attachment contains a view of a record at a single ConnectApi.FeedItemType.CreateRecordEvent.
  • TrackedChange—All changes to a record for a single ConnectApi.FeedItemType.TrackedChange event.
ConnectApi.​​​FeedItemType 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.

ConnectApi.​​​FeedItem​​​VisibilityType 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.
ConnectApi.​​​FeedSortOrder Specifies the order returned by the sort, such as by date created or last modified:
  • CreatedDateDesc—Sorts the feed items by most recent post date.
  • LastModifiedDateDesc—Sorts the feed items by most recent activity, which includes new feed items and comments.
ConnectApi.​​​FeedType Specifies the type of feed:
  • 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.
  • ModerationContains 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.
ConnectApi.​​​FieldChangeValueType Specifies the value type of a field change:
  • NewValue—A new value
  • OldValue—An old value
ConnectApi.​​​FilePublishStatus The publish status of the file:
  • PendingAccess—File is pending publishing.
  • PrivateAccess—File is private.
  • PublicAccess—File is public.
ConnectApi.​​​FileSharingType Specifies the sharing role of the file:
  • Admin—Owner permission, but doesn’t own the file.
  • Collaborator—Viewer permission, and can edit, change permissions, and upload a new version of a file.
  • Owner—Collaborator permission, and can make a file private, and delete a file.
  • Viewer—Can view, download, and share a file.
  • WorkspaceManaged—Permission controlled by the library.
ConnectApi.GroupArchiveStatus Specifies a set of groups based on whether the groups are archived or not.
  • All—All groups, including groups that are archived and groups that are not archived.
  • Archived—Only groups that are archived.
  • NotArchived—Only groups that are not archived.
ConnectApi.​​​GroupEmail​​​Frequency Specifies the frequency with which a user receives email from a group.
  • EachPost
  • DailyDigest
  • WeeklyDigest
  • Never
  • UseDefault
ConnectApi.​​​GroupMembership​​​Type Specifies the type of membership the user has with the group, such as group owner, manager, or member.
  • GroupOwner
  • GroupManager
  • NotAMember
  • NotAMemberPrivateRequested
  • StandardMember
ConnectApi.​​​GroupMembership​​​RequestStatus The status of a request to join a private group.
  • Accepted
  • Declined
  • Pending
ConnectApi.​​​GroupVisibility​​​Type Specifies whether a group is private or public.
  • 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.
ConnectApi.MentionCompletionType Specifies the type of mention completion:
  • All—All mention completions, regardless of the type of record to which the mention refers.
  • Group—Mention completions for groups.
  • User—Mention completions for users.
ConnectApi.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.
ConnectApi.​​​MessageSegment​​​Type 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.​​​RecordColumnOrder The order in which fields are rendered in a grid.
  • LeftRight—Fields are rendered from left to right.
  • TopDown—Fields are rendered from the top down.
ConnectApi.​​​RecordFieldType The data type of a record field.
  • Address
  • Blank
  • Boolean
  • Compound
  • CreatedBy
  • Date
  • DateTime
  • Email
  • LastModifiedBy
  • Location
  • Name
  • Number
  • Percent
  • Phone
  • Picklist
  • Reference
  • Text
  • Time
ConnectApi.​​​SortOrder A generic sort order direction.
  • Ascending—Ascending order (A-Z).
  • Descending—Descending order (Z-A).
ConnectApi.​​​TopicSort Specifies the order returned by the sort:
  • popularDesc—Sorts topics by popularity with the most popular first. This value is the default.
  • alphaAsc—Sorts topics alphabetically.
ConnectApi.UserProfileTabType Specifies the type of user profile tab:
  • CustomVisualForce—Tab that displays data from a Visualforce page.
  • CustomWeb—Tab that displays data from any external Web-based application or Web page.
  • Feed—Tab that displays the Chatter feed.
  • Overview—Tab that displays user details.
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.​​​WorkflowProcess​​​Status Specifies the status of a workflow process.
  • Approved
  • Fault
  • Held
  • NoResponse
  • Pending
  • Reassigned
  • Rejected
  • Removed
  • Started
ConnectApi.ZoneSearchResultType Specifies the zone search result type.
  • Article—Search results contain only articles.
  • Question—Search results contain only questions.
ConnectApi.ZoneShowIn Specifies the zone search result type.
  • Community—Available in a community.
  • Internal—Available internally only.
  • Portal—Available in a portal.