ConnectApi Enums

Enums specific to the ConnectApi namespace.

ConnectApi enums inherit all properties and methods of Apex enums.

Enum Description
ConnectApi.​ActionLink​ExecutionsAllowed Specifies the number of times an action link can be executed.
  • Once—An action link can be executed only once across all users.
  • OncePerUser—An action link can be executed only once for each user.
  • Unlimited—An action link can be executed an unlimited number of times by each user. If the action link’s actionType is Api or ApiAsync, you can’t use this value.
ConnectApi.​ActionLinkType Specifies the type of action link.
  • Api—The action link calls a synchronous API at the action URL. Salesforce sets the status to SuccessfulStatus or FailedStatus based on the HTTP status code returned by your server.
  • ApiAsync—The action link calls an asynchronous API at the action URL. The action remains in a PendingStatus state until a third party makes a request to /connect/action-links/actionLinkId to set the status to SuccessfulStatus or FailedStatus when the asynchronous operation is complete.
  • Download—The action link downloads a file from the action URL.
  • Ui—The action link takes the user to a Web page at the action URL.
ConnectApi.​BannerStyle Decorates a feed item with a color and set of icons.
  • AnnouncementAn announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.
ConnectApi.​BundleType Specifies the type of bundle.
  • GenericBundle—A bundle that contains no additional information and is just a collection of feed elements.
  • TrackedChanges—A bundle that represents a collection of feed tracked changes. The bundle includes summary information about the feed tracked changes that make up the bundle.
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.​CaseComment​EventType 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.
  • PublishExisting—An existing case comment that was republished.
  • PublishExistingByCustomer—An existing case comment by a customer that was republished.
  • UnpublishExistingByCustomer—An existing case comment by a customer that was unpublished.
  • UnpublishExsiting—An existing case comment that was unpublished.
    Note

    Note

    Unfortunately, this typo is in the code, not the documentation. Use this spelling in your code.

ConnectApi.​CommentType Specifies the type of comment.
  • ContentComment—Comment holds a content capability.
  • TextComment—Comment contains only text.
ConnectApi.​CommunityFlag​Visibility 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 element or item.
  • SelfAndModerators—The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
ConnectApi.​CommunityStatus Specifies the status of the community.
  • Live
  • Inactive
  • UnderConstruction
ConnectApi.​DatacloudUserType Specifies the type of user.
  • Monthy—A user type that’s assigned monthly point limits for purchasing Data.com records. Only the assigned user can use monthly points. Points expire at the end of the month. Monthly is the default setting for DatacloudUserType.
  • Listpool— A user type that allows users to draw from a pool of points to purchase Data.com records.
ConnectApi.​EmailMessage​Direction 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 updates from people and records the user follows and groups the user is a member of.
  • FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of, but hides some system-generated updates from records.
ConnectApi.​FeedElementCapability​Type Specifies the capabilities of a feed element in API versions 31.0 and later. If a capability exists on a feed element, the capability is available, even if the value doesn’t exist or is null. If the capability doesn’t exist, it isn’t available.
  • AssociatedActions—The feed element includes information about actions associated with it.
  • Approval—The feed element includes information about an approval.
  • Banner—The body of the feed element has an icon and border.
  • Bookmarks—The context user can bookmark the feed element. Bookmarked feed elements are visible in the bookmarks feed.
  • Bundle—The feed element has a group of other feed elements that display as a bundle in the feed. The bundle type determines the additional data associated with the bundle.
  • Canvas—The feed element renders a canvas app.
  • CaseComment—The feed element has a case comment in the case feed.
  • ChatterLikes—The context user can like the feed element.
  • Comments—The context user can add comments to the feed element.
  • Content—The feed element has a file.
  • DashboardComponentSnapshot—The feed element has a dashboard component snapshot.
  • Edit—Users who have permission can edit the feed element.
  • EmailMessage—The feed element has an email message from a case.
  • Moderation—Users in a community can flag the feed element for moderation.
  • Mute—The context user can mute the feed element.
  • Origin—The feed element was created by a feed action.
  • Poll—The feed element has poll voting.
  • QuestionAndAnswers—The feed element has a question, and users can add answers to the feed element instead of comments. Users can also select the best answer.
  • Recommendations—The feed element has a recommendation.
  • RecordSnapshot—The feed element has all the snapshotted fields of a record for a single create record event.
  • Topics—The context user can add topics to the feed element.
  • TrackedChanges—The feed element has all changes to a record for a single tracked change event.
ConnectApi.​FeedElement​Type Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element.
  • Bundle—A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values.
  • FeedItem—A feed item has a single parent and is scoped to one community or across all communities. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values.
  • Recommendation—A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user.
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.​FeedFilter Specifies a filter value for a feed.
  • AllQuestions—Only feed elements that are questions.
  • CommunityScoped—Only feed elements that are scoped to communities. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to communities in the future. Feed elements that are always visible in all communities are filtered out. This value is valid only for the UserProfile feed.
  • SolvedQuestions—Only feed elements that are questions and that have a best answer.
  • UnansweredQuestions—Only feed elements that are questions and that don’t have any answers.
  • UnsolvedQuestions—Only feed elements that are questions and that don’t have a best answer.
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.
  • Question—A feed item with a question 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 or a text post.
  • 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.
  • AdvancedTextPost—A feed item with advanced text formatting, such as a group announcement post.
  • ApprovalPost—Feed item with an approval capability. 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 an enhanced link capability.
  • 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 public group is created. Contains a link to the new group.
  • CollaborationGroupUnarchived—Deprecated. Feed item generated when an archived group is activated.
  • ContentPost—Feed item with a content capability.
  • CreateRecordEvent—Feed item that describes a record created in the publisher.
  • DashboardComponentAlert—Feed item with a dashboard alert.
  • DashboardComponentSnapshot—Feed item with a dashboard component snapshot capability.
  • EmailMessageEvent—Feed item generated when an email is sent from a case in Case Feed.
  • FacebookPost—Deprecated. Feed item generated when a Facebook post is created from a case in Case Feed.
  • LinkPost—Feed item with a link capability.
  • 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 a poll capability. Viewers of the feed item are allowed to vote on the options in the poll.
  • ProfileSkillPost—Feed item generated when a skill is added to a user’s profile.
  • QuestionPost—Feed item generated when a question is asked.

    As of API version 33.0, a feed item of this type can have a content capability and a link capability.

  • ReplyPost—Feed item generated by a Chatter Answers reply.
  • RypplePost—Feed item generated when a user posts thanks.
  • SocialPost—Feed item generated when a social post is created from a case in Case Feed.
  • TextPost—Feed item containing text only.
  • TrackedChange—Feed item created when one or more fields on a record have been changed.
  • 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 by most recent creation date.
  • LastModifiedDateDesc—Sorts by most recent activity.
ConnectApi.​FeedType Specifies the type of feed:
  • BookmarksContains all feed items saved as bookmarks by the context user.
  • CompanyContains all feed items except feed items of type TrackedChange. To see the feed item, the user must have sharing access to its parent.
  • FilesContains all feed items that contain files posted by people or groups that the context user follows.
  • Filter—Contains the news feed filtered to contain feed items whose parent is a specified object type.
  • GroupsContains all feed items from all groups the context user either owns or is a member of.
  • Home—Contains all feed items associated with any managed topic in a community.
  • ModerationContains all feed items that have been flagged for moderation. The Communities Moderation feed is available only to users with “Moderate Community Feeds” permissions.
  • Mute—Contains all feed items that the context user muted.
  • NewsContains all updates for people the context user follows, groups the user is a member of, and files and records the user is following. Also contains all updates for records whose parent is the context user and every feed item and comment that mentions the context user or that mentions a group the context user is a member of.
  • PeopleContains all feed items posted by all people the context user follows.
  • RecordContains 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. When the record is a user, the feed contains only feed items on that user. You can get another user’s record feed.
  • ToContains all feed items with mentions of the context user, feed items the context user commented on, and feed items created by the context user that are commented on.
  • TopicsContains 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. You can get another user’s user profile feed.
ConnectApi.​FieldChange​ValueType Specifies the value type of a field change:
  • NewValue—A new value
  • OldValue—An old value
ConnectApi.​FilePreviewFormat Specifies the format of the file preview.
  • Pdf—Preview format is PDF.
  • Svg—Preview format is compressed SVG.
  • Thumbnail—Preview format is 240 x 180 PNG.
  • ThumbnailBig—Preview format is 720 x 480 PNG.
  • ThumbnailTiny—Preview format is 120 x 90 PNG.
ConnectApi.​FilePreviewStatus Specifies the availability status of the file preview.
  • Available—Preview is available.
  • InProgress—Preview is being processed.
  • NotAvailable—Preview is unavailable.
  • NotScheduled—Generation of the preview isn’t scheduled yet.
ConnectApi.​FilePublishStatus The publish status of the file:
  • PendingAccess—File is pending publishing.
  • PrivateAccess—File is private.
  • PublicAccess—File is public.
ConnectApi.​FileSharingOption Specifies the sharing option of the file:
  • Allowed—Resharing of the file is allowed.
  • Restricted—Resharing of the file is restricted.
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.​GroupArchive​Status 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 the group visibility type.
  • PrivateAccess—Only members of the group can see posts to this group.
  • PublicAccess—All users within the community can see posts to this group.
  • Unlisted—Reserved for future use.
ConnectApi.​HttpRequest​Method Specifies the HTTP method.
  • HttpDelete—Returns HTTP 204 on success. Response body or output class is empty.
  • HttpGet—Returns HTTP 200 on success.
  • HttpHead—Returns HTTP 200 on success. Response body or output class is empty.
  • HttpPatch—Returns HTTP 200 on success or HTTP 204 if the response body or output class is empty.
  • HttpPost—Returns HTTP 201 on success or HTTP 204 if the response body or output class is empty. Exceptions are the batch posting resources and methods, which return HTTP 200 on success.
  • HttpPut—Return HTTP 200 on success or HTTP 204 if the response body or output class is empty.
ConnectApi.​MaintenanceType Specifies the type of maintenance. One of the following:
  • Downtime—Downtime maintenance.
  • GenerallyAvailable—Maintenance with generally available mode.
  • MaintenanceWithDowntime—Scheduled maintenance with downtime.
  • ReadOnly—Maintenance with read-only mode.
ConnectApi.ManagedTopic​​​Type Specifies the type of managed topic.
  • Featured—Topics that are featured, for example, on the community home page, but don’t provide overall navigation.
  • Navigational—Topics that display in a navigational menu in the community.
ConnectApi.MarkupType Specifies the type of rich text markup.
  • Bold—Bold tag.
  • Italic—Italic tag.
  • ListItem—List item tag.
  • OrderedList—Ordered list tag.
  • Paragraph—Paragraph tag.
  • StrikeThrough—Strikethrough tag.
  • Underline—Underline tag.
  • UnorderedList—Unordered list tag.
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.​MentionValidation​Status Specifies the type of validation error for a proposed mention, if any.
  • Disallowed—The proposed mention is invalid and is 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 isn’t 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
  • InlineImage
  • Link
  • MarkupBegin
  • MarkupEnd
  • Mention
  • MoreChanges
  • ResourceLink
  • Text
ConnectApi.​PlatformAction​GroupCategory Specifies the location of an action link group on an associated feed element.
  • Primary—The action link group is displayed in the body of the feed element.
  • Overflow—The action link group is displayed in the overflow menu of the feed element.
ConnectApi.​PlatformActionStatus Specifies the status of the action.
  • FailedStatus—The action link execution failed.
  • NewStatus—The action link is ready to be executed. Available for Download and Ui action links only.
  • PendingStatus—The action link is executing. Choosing this value triggers the API call for Api and ApiAsync action links.
  • SuccessfulStatus—The action link executed successfully.
ConnectApi.​PlatformActionType Specifies the type of platform action.
  • ActionLink—An indicator on a feed element that targets an API, a web page, or a file and is represented by a button in the Salesforce Chatter feed UI.
  • CustomButton—When clicked, opens a URL or a Visualforce page in a window or executes JavaScript.
  • InvocableAction
  • ProductivityActionProductivity actions are predefined by Salesforce and are attached to a limited set of objects. You can’t edit or delete productivity actions..
  • QuickAction—A global or object-specific action.
  • StandardButton—A predefined Salesforce button such as New, Edit, and Delete.
ConnectApi.​RecommendationActionType Specifies the action to take on a recommendation.
  • follow—Follow a file, record, or user.
  • join—Join a group.
  • view—View a file, group, record, user, custom, or static recommendation.
ConnectApi.​RecommendationAudience​MemberOperationType Specifies the operation to carry out on the audience members.
  • Add—Adds specified members to the audience.
  • Remove—Removes specified members from the audience.
ConnectApi.​RecommendationExplanationType Indicates the reason for a recommendation.
  • Custom—Custom recommendations
  • FilePopular—Files with many followers or views
  • FileViewedTogether—Files often viewed at the same time as other files the context user views
  • FollowedTogetherWithFollowees—Users often followed with the same people the context user follows
  • GroupMembersFollowed—Groups with members the context user follows
  • GroupNew—Recently created groups
  • GroupPopular—Groups with many active members
  • ItemViewedTogether—Records often viewed at the same time as other records the context user views
  • PopularApp—Applications that are popular
  • RecordOwned—Records owned by the context user
  • RecordParentOfFollowed—Parent records of records the context user follows
  • RecordViewed—Records the context user recently viewed
  • UserDirectReport—Users who report to the context user
  • UserFollowedTogether—Users often followed at the same time as other users the context user follows
  • UserFollowsSameUsers—Users who follow the same users as the context user
  • UserManager—The context user’s manager
  • UserNew—Recently created users
  • UserPeer—Users who report to the same manager as the context user
  • UserPopular—Users with many followers
  • UserViewingSameRecords—Users who view the same records as the context user
ConnectApi.​RecommendationType Specifies the type of record being recommended.
  • apps
  • files
  • groups
  • records
  • users
ConnectApi.​RecommendedObjectType Specifies the type of object being recommended.
  • Today—Static recommendations that don’t have an ID, for example, the Today app recommendation.
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.​UserProfile​TabType 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.
  • Element—Tab that displays generic content inline.
  • Feed—Tab that displays the Chatter feed.
  • Overview—Tab that displays user details.
ConnectApi.​UserType Specifies the type of user.
  • ChatterGuest—User is an external user in a private group.
  • ChatterOnly—User is a Chatter Free customer.
  • Guest—User is unauthenticated.
  • Internal—User is a standard organization member.
  • Portal—User is an external user in a customer portal, partner portal, or community.
  • 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.​ZoneSearch​ResultType 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.
Previous
Next