Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
BotVersionActivation Class
CdpActivation Class
CdpActivationTarget Class
CdpAudienceDMO Class
CdpCalculatedInsight Class
CdpConnection Class
CdpDataSpace Class
CdpDataStreams Class
CdpIdentityResolution Class
CdpMachineLearning Class
CdpQuery Class
CdpSegment Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Clm Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommerceCatalogManagement Class
CommercePromotions Class
CommerceSearch Class
CommerceSearchConnectFamily Class
CommerceSearchSettings Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
ConversationApplicationDefinition Class
Datacloud Class
EinsteinLLM Class
EmailMergeFieldService Class
EmployeeProfiles Class
Exchanges Class
ExtendedCommerceDelivery Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FulfillmentOrder Class
IBusinessObjectivesAndRecsFamily Class
Knowledge Class
LightningScheduler Class
ManagedContent Class
ManagedContentChannels Class
ManagedContentDelivery Class
ManagedContentSpaces Class
ManagedTopics Class
MarketingIntegration Class
Mentions Class
Missions Class
Missions Methods
NamedCredentials Class
NavigationMenu Class
NextBestAction Class
OmnichannelInventoryService Class
OMSAnalytics Class
Orchestration Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
PardotBusinessUnitContext Class
Payments Class
Personalization Class
PickTicket Class
QuestionAndAnswers Class
Recommendations Class
RecordFilterCriteriaFamily Class
Records Class
RegisterGuestBuyer Class
Repricing Class
ReturnOrder Class
Routing Class
SalesforceInbox Class
Search Class
Sites Class
SmartDataDiscovery Class
SocialEngagement Class
Surveys Class
TaxPlatform Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
ConnectApi Utilities
ConnectApi Release Notes
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
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

These methods are for Missions. All methods are static.

All methods in this class require Chatter and are subject to the per user, per namespace, per hour rate limit.

exportUserMissionsActivities(communityId, userId)

Export mission activity for a user.

API Version

45.0

Requires Chatter

Yes

Signature

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

Parameters

communityId
Type: String
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

Yes

Signature

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

Parameters

communityId
Type: String
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

Yes

Signature

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

Parameters

communityId
Type: String
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

Yes

Signature

public static ConnectApi.UserMissionActivitiesJob purgeUserMissionsActivities(String communityId)

Parameters

communityId
Type: String
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

Yes

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
ID for an Experience Cloud site, internal, or null.
userId
Type: String
ID of the user.

Return Value

Type: ConnectApi.UserMissionActivityStatus