Captainup  2.4
Instance Methods | List of all members
<CPTUserListener> Protocol Reference

#import <CPTUserListener.h>

Inheritance diagram for <CPTUserListener>:

Instance Methods

(void) - onUser:achievedBadges:
 
(void) - onUser:achievedLevels:
 
(void) - onUser:badgeProgress:
 
(void) - onUser:gotCurrency:ofAmount:
 
(void) - onUser:leaderboardPositionChanged:
 
(void) - onUser:acquiredAsset:
 
(void) - onUser:achievedTrophy:
 
(void) - onUser:acquiredShopItem:
 
(void) - onUser:newRewardAvailableForClaim:withBadge:
 
(void) - onUser:actionProcessed:
 
(void) - onUser:error:
 

Detailed Description

Use this protocol to listen to events that happen on an ActionableUser. This protocol shouold never be implemented on its own. Instead, implement its child protocols for each concrete event type you want to listen to.

Method Documentation

◆ onUser:achievedBadges:()

- (void) onUser: (nonnull id< CPTUser >)  user
achievedBadges: (nonnull NSArray< id< CPTBadge >> *)  badges 
optional

called when user archive badges

Parameters
userCPTUser object
badgesNSArray<id<CPTBadge>> badges array

◆ onUser:achievedLevels:()

- (void) onUser: (nonnull id< CPTUser >)  user
achievedLevels: (nonnull NSArray< id< CPTLevel >> *)  levels 
optional

called when user archive levels

Parameters
userCPTUser object
levelsNSArray<id<CPTLevel>> levels array

◆ onUser:achievedTrophy:()

- (void) onUser: (nonnull id< CPTUser >)  user
achievedTrophy: (nonnull id< CPTAcquiredAsset >)  asset 
optional

called when user acheive trophy

Parameters
userCPTUser object
assetCPTAcquiredAsset object

◆ onUser:acquiredAsset:()

- (void) onUser: (nonnull id< CPTUser >)  user
acquiredAsset: (nonnull id< CPTAcquiredAsset >)  asset 
optional

called when user acquire asset

Parameters
userCPTUser object
assetCPTAcquiredAsset object

◆ onUser:acquiredShopItem:()

- (void) onUser: (nonnull id< CPTUser >)  user
acquiredShopItem: (nonnull id< CPTAcquiredAsset >)  asset 
optional

called when user acquire shop item

Parameters
userCPTUser object
assetCPTAcquiredAsset object

◆ onUser:actionProcessed:()

- (void) onUser: (nonnull id< CPTUser >)  user
actionProcessed: (nonnull id< CPTAction >)  action 
optional

called when user action processed

Parameters
userCPTUser object
actionCPTAction object

◆ onUser:badgeProgress:()

- (void) onUser: (nonnull id< CPTUser >)  user
badgeProgress: (nonnull CPTBadgeProgressDictionary *)  map 
optional

called when user archive levels

Parameters
userCPTUser object
mapCPTBadgeProgressDictionary Dictionary

◆ onUser:error:()

- (void) onUser: (nonnull id< CPTUser >)  user
error: (nullable NSError *)  error 
optional

called when error occured in any operation

Parameters
userCPTUser object
errorNSError object

◆ onUser:gotCurrency:ofAmount:()

- (void) onUser: (nonnull id< CPTUser >)  user
gotCurrency: (nonnull id< CPTCurrency >)  currency
ofAmount: (NSInteger)  amount 
optional

called when user archive currency

Parameters
userCPTUser object
currencyCPTCurrency object
amountInteger of amount

◆ onUser:leaderboardPositionChanged:()

- (void) onUser: (nonnull id< CPTUser >)  user
leaderboardPositionChanged: (nonnull NSDictionary< NSString *, NSNumber * > *)  leaderboards 
optional

called when user leaderboard postiion changed

Parameters
userCPTUser user
leaderboardsNSDictionary<NSString*,NSNumber*> user leaderboard position

◆ onUser:newRewardAvailableForClaim:withBadge:()

- (void) onUser: (nonnull id< CPTUser >)  user
newRewardAvailableForClaim: (nonnull id< CPTReward >)  reward
withBadge: (nonnull id< CPTBadge >)  badge 
optional

called when new rewadr is available for claim

Parameters
userCPTUser object
rewardCPTReward object

The documentation for this protocol was generated from the following file: