Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
Datacloud Class
EmailMergeFieldService Class
EmployeeProfiles Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FulfillmentOrder Class
Knowledge Class
ManagedContent Class
ManagedTopics Class
Mentions Class
Missions Class
Missions Methods
NextBestAction Class
OmnichannelInventoryService Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
Payments Methods
Personalization Class
QuestionAndAnswers Class
Recommendations Class
Records Class
Routing Class
SalesforceInbox Class
SmartDataDiscovery Class
SocialEngagement Class
Survey Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
Functions Namespace (Beta)
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

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

Missions Class

Export and purge mission activity for users. Get a user’s mission progress. Update mission activity counts for users.

Namespace

ConnectApi

Missions Methods

The following are methods for Missions. All methods are static.

exportUserMissionsActivities(communityId, userId)

Export mission activity for a user.

API Version

45.0

Requires Chatter

No

Signature

public static ConnectApi.UserMissionActivitiesJob exportUserMissionsActivities(String communityId, String userId)

Parameters

communityId
Type: String
Use the ID for an Experience Cloud site, internal, or null.
userId
Type: String
ID of the user.

Return Value

Type: ConnectApi.UserMissionActivitiesJob

Usage

You can export these activities with this method.
  • FeedItemAnswerAQuestion—User answered a question.
  • FeedItemLikeSomething—User liked a post or comment.
  • FeedItemMarkAnswerAsBest—User marked an answer as the best answer.
  • FeedItemPostQuestion—User posted a question.
  • FeedItemReceiveAComment—User received a comment on a post.
  • FeedItemReceiveALike—User received a like on a post or comment.
  • FeedItemReceiveAnAnswer—User received an answer to a question.
  • FeedItemWriteAComment—User commented on a post.
  • FeedItemWriteAPost—User made a post.
  • FeedItemYourAnswerMarkedBest—​User’s answer was marked as the best answer.

getUserMissionsProgress(communityId, userId)

Get mission activity progress for a user.

API Version

46.0

Requires Chatter

No

Signature

public static ConnectApi.UserMissionActivityCollection getUserMissionsProgress(String communityId, String userId)

Parameters

communityId
Type: String
Use the ID for an Experience Cloud site, internal, or null.
userId
Type: String
ID of the user.

Return Value

Type: ConnectApi.UserMissionActivityCollection

purgeUserMissionsActivities(communityId, userId)

Start a job to purge mission activity for a user.

API Version

45.0

Requires Chatter

No

Signature

public static ConnectApi.UserMissionActivitiesJob purgeUserMissionsActivities(String communityId, String userId)

Parameters

communityId
Type: String
Use the ID for an Experience Cloud site, internal, or null.
userId
Type: String
ID of the user.

Return Value

Type: ConnectApi.UserMissionActivitiesJob

Usage

This method purges these activities.
  • FeedItemAnswerAQuestion—User answered a question.
  • FeedItemLikeSomething—User liked a post or comment.
  • FeedItemMarkAnswerAsBest—User marked an answer as the best answer.
  • FeedItemPostQuestion—User posted a question.
  • FeedItemReceiveAComment—User received a comment on a post.
  • FeedItemReceiveALike—User received a like on a post or comment.
  • FeedItemReceiveAnAnswer—User received an answer to a question.
  • FeedItemWriteAComment—User commented on a post.
  • FeedItemWriteAPost—User made a post.
  • FeedItemYourAnswerMarkedBest—​User’s answer was marked as the best answer.

purgeUserMissionsActivities(communityId)

Start a job to purge mission activity for all users.

API Version

49.0

Requires Chatter

No

Signature

public static ConnectApi.UserMissionActivitiesJob purgeUserMissionsActivities(String communityId)

Parameters

communityId
Type: String
Use the ID for an Experience Cloud site, internal, or null.

Return Value

Type: ConnectApi.UserMissionActivitiesJob

Usage

This method purges these activities.
  • FeedItemAnswerAQuestion—User answered a question.
  • FeedItemLikeSomething—User liked a post or comment.
  • FeedItemMarkAnswerAsBest—User marked an answer as the best answer.
  • FeedItemPostQuestion—User posted a question.
  • FeedItemReceiveAComment—User received a comment on a post.
  • FeedItemReceiveALike—User received a like on a post or comment.
  • FeedItemReceiveAnAnswer—User received an answer to a question.
  • FeedItemWriteAComment—User commented on a post.
  • FeedItemWriteAPost—User made a post.
  • FeedItemYourAnswerMarkedBest—​User’s answer was marked as the best answer.

updateUserMissionActivityCount(activityType, activityCount, communityId, userId)

Update the mission activity count for a user.

API Version

45.0

Requires Chatter

No

Signature

public static ConnectApi.UserMissionActivityStatus updateUserMissionActivityCount(ConnectApi.UserMissionActivityType activityType, Integer activityCount, String communityId, String userId)

Parameters

activityType
Type: ConnectApi.UserMissionActivityType
Type of mission activity for a user. Values are:
  • FeedItemAnswerAQuestion—User answered a question.
  • FeedItemLikeSomething—User liked a post or comment.
  • FeedItemMarkAnswerAsBest—User marked an answer as the best answer.
  • FeedItemPostQuestion—User posted a question.
  • FeedItemReceiveAComment—User received a comment on a post.
  • FeedItemReceiveALike—User received a like on a post or comment.
  • FeedItemReceiveAnAnswer—User received an answer to a question.
  • FeedItemWriteAComment—User commented on a post.
  • FeedItemWriteAPost—User made a post.
  • FeedItemYourAnswerMarkedBest—​User’s answer was marked as the best answer.
activityCount
Type: Integer
Number of mission activities of the specified type for the user.
communityId
Type: String
Use the ID for an Experience Cloud site, internal, or null.
userId
Type: String
ID of the user.

Return Value

Type: ConnectApi.UserMissionActivityStatus