FieloPLT.ChallengeService Class

FieloPLT.ChallengeService class includes one method.

Obtain Challenges (getChallengesMap)

static List<FieloPLT.ChallengeService.ChallengeWrapper> FieloPLT.ChallengeService.getChallengesMap (Set<String> fieldsChallenge, Set<String> fieldsMission, Set<String> fieldsChReward, Set<String> fieldsMissionMember, Set<String> fieldsChMember, Set<String> fieldsTransaction, Set<Id> challengeIds, Id memberId, String status, Boolean filterBySegments, String orderBy, Integer quantity, Integer offset, String dynamicFilter, String translate)

It allows you to retrieve information about a number of Challenges map from a particular Member. It can also provide details about the Missions, Challenge Rewards, Challenge Members, Mission Members and Transactions linked to a Challenge.

Members are considered subscribed to a Challenge when Members and Challenge share the same Segment and Subscription Mode is Global. When Subscription Mode is Closed, Members are considered subscribed by means of a Challenge Member record.

📘

Challenges Status

Challenges may have any of the following Status when linked to a specific member:

• Active: It returns all Active challenges which the member is participating in (challegeMember exists and challengeMember status is not accomplished) and also the ones which the member belong to the segmentation and the subscription is global.

• Completed: Returns all Challenges completed by the member, which has challengeMember status equals to ‘Accomplish’,or all finished challenges, which has Challenge status equals to ‘Completed.

• Open: Returns all Challenges which members can subscribe to, as they belong to its segmentation. Challenge returned are Active and its subscription is either private or open (Opt-In).

• Lost: Returns all Challenges which the member could have had enrolled, meaning that the member belongs to the segmentation but there is not challengeMember, but it is over, so Challenge Status is equals to completed

• Not Applicable: Returns all Active challenges that the member cannot participate, as they don’t share the member's segmentation. The challenges the member has participated in already but do not belong to the segment anymore will be excluded from the returned challenges.

Parameters

Return Value

Class FieloPLT.ChallengeWrapper{
	FieloPLT__Challenge__c challenge;
	String status;
  FieloPLT__ChallengeMember__c challengeMember;
	List<FieloPLT__Mission__c> missions;
  List<FieloPLT__ChallengeReward__c> challengeRewards;
  Map<Id,List<FieloPLT__ChallengeReward__c>> missionRewards;
  Map<Id,FieloPLT__MissionMember__c> missionsMember;
  List<FieloPLT__Transaction__c> transactions;
  }

Id memberId = [SELECT Id FROM FieloPLT__Member__c LIMIT 1].Id;

String dynamicFilter = '[{"field":"FieloPLT__Status__c","value":"Active","operator":"eq","andOrOperator":""}]';

List<FieloPLT.ChallengeService.ChallengeWrapper> result = FieloPLT.ChallengeService.getChallengesMap(
  new Set<String>{'Name'},
  new Set<String>{'Name'},
  new Set<String>{'Name'},
  null,
  null,
  null,
  null,
  memberId,
  null,
  true,
  'CreatedDate ASC',
  100,
  0,
  dynamicFilter);

Obtain Mission Leaderboard (getMissionLeaderboard)

static List<FieloPLT__MissionMember__c> getMissionLeaderboard (Set<String> fieldsMissionMember, Id missionId, Id memberId, String orderBy, Integer quantity, Integer offset, String dynamicFilter)

It enables you to retrieve information about Member rankings in a Leaderboard of a specific Mission, which is stored in Mission Member records. You can also obtain information about how a particular Member has performed on the Leaderboard.

Return Value

🚧

Challenge Leaderboard Batch

You must run Challenge Leaderboard batch job before calling Obtain Mission Leaderboard method.

Id memberId = [SELECT Id FROM FieloPLT__Member__c LIMIT 1].Id;
Id missionId = [SELECT Id FROM FieloPLT__Mission__c LIMIT 1].Id;

String dynamicFilter = '[{"field":"FieloPLT__Status__c","value":"Accomplished","operator":"eq","andOrOperator":""}]';

List<FieloPLT__MissionMember__c> FieloPLT.ChallengeService.getMissionLeaderboard(new Set<String>{'Name'}, 
                    missionId,
                    memberId,
                    'CreatedDate ASC',
                    100,
                    0,
                    dynamicFilter);