ChallengeWonMessage

A message indicating that the challenge has been won.

This message is only sent to the individual player who has won the challenge

View interactive version here

Request Parameters

Nested types

PlayerTurnCount

Represents the number of turns a player has taken in a turn based challenge.

ScriptData

A collection of arbitrary data that can be added to a message via a Cloud Code script.

Challenge

A nested object that represents the challenge data.

LeaderboardData

Leaderboard entry data

As well as the parameters below there may be others depending on your game's configuration.

PlayerDetail

An object representing a player's id and name

Code Samples

C#

    ChallengeWonMessage.Listener = (message) => {
    ChallengeWonMessage._Challenge challenge = message.Challenge;
    long? currency1Won = message.Currency1Won;
    long? currency2Won = message.Currency2Won;
    long? currency3Won = message.Currency3Won;
    long? currency4Won = message.Currency4Won;
    long? currency5Won = message.Currency5Won;
    long? currency6Won = message.Currency6Won;
    GSData currencyWinnings = message.CurrencyWinnings;
    ChallengeWonMessage._LeaderboardData leaderboardData = message.LeaderboardData;
    string messageId = message.MessageId;
    bool? notification = message.Notification;
    GSEnumerable<GSData> scriptData = message.ScriptData;
    string subTitle = message.SubTitle;
    string summary = message.Summary;
    string title = message.Title;
    string winnerName = message.WinnerName;
    };

ActionScript 3

    gs.getMessageHandler().setHandler(
        ".ChallengeWonMessage",
        function (message:ChallengeWonMessage):void {
        var challenge:Challenge = message.getChallenge(); 
        var currency1Won:Number = message.getCurrency1Won(); 
        var currency2Won:Number = message.getCurrency2Won(); 
        var currency3Won:Number = message.getCurrency3Won(); 
        var currency4Won:Number = message.getCurrency4Won(); 
        var currency5Won:Number = message.getCurrency5Won(); 
        var currency6Won:Number = message.getCurrency6Won(); 
        var currencyWinnings:Object = message.getCurrencyWinnings(); 
        var leaderboardData:LeaderboardData = message.getLeaderboardData(); 
        var messageId:String = message.getMessageId(); 
        var notification:Boolean = message.getNotification(); 
        var scriptData:Vector.<ScriptData> = message.getScriptData(); 
        var subTitle:String = message.getSubTitle(); 
        var summary:String = message.getSummary(); 
        var title:String = message.getTitle(); 
        var winnerName:String = message.getWinnerName(); 
        }
);

Objective-C

    [listener onGSChallengeWonMessage:^(GSChallengeWonMessage* message) {
    GSChallenge* challenge = [message getChallenge]; 
    NSNumber* currency1Won = [message getCurrency1Won]; 
    NSNumber* currency2Won = [message getCurrency2Won]; 
    NSNumber* currency3Won = [message getCurrency3Won]; 
    NSNumber* currency4Won = [message getCurrency4Won]; 
    NSNumber* currency5Won = [message getCurrency5Won]; 
    NSNumber* currency6Won = [message getCurrency6Won]; 
    NSDictionary* currencyWinnings = [message getCurrencyWinnings]; 
    GSLeaderboardData* leaderboardData = [message getLeaderboardData]; 
    NSString* messageId = [message getMessageId]; 
    BOOL notification = [message getNotification]; 
    NSArray* scriptData = [message getScriptData]; 
    NSString* subTitle = [message getSubTitle]; 
    NSString* summary = [message getSummary]; 
    NSString* title = [message getTitle]; 
    NSString* winnerName = [message getWinnerName]; 
    }];

Java

    gs.getMessageHandler().setChallengeWonMessageListener(
        new GSEventConsumer<ChallengeWonMessage>() {
            public void onEvent(ChallengeWonMessage message) {
        Challenge challenge = message.getChallenge(); 
        Long currency1Won = message.getCurrency1Won(); 
        Long currency2Won = message.getCurrency2Won(); 
        Long currency3Won = message.getCurrency3Won(); 
        Long currency4Won = message.getCurrency4Won(); 
        Long currency5Won = message.getCurrency5Won(); 
        Long currency6Won = message.getCurrency6Won(); 
        GSData currencyWinnings = message.getCurrencyWinnings(); 
        LeaderboardData leaderboardData = message.getLeaderboardData(); 
        String messageId = message.getMessageId(); 
        Boolean notification = message.getNotification(); 
        String subTitle = message.getSubTitle(); 
        String summary = message.getSummary(); 
        String title = message.getTitle(); 
        String winnerName = message.getWinnerName(); 
            }
        }
    );

C++

    using namespace GameSparks::Core;
    using namespace GameSparks::Api::Messages;
    ...
    void OnChallengeWonMessage(GS& gsInstance, const ChallengeWonMessage& message)
    {
    Types::Challenge* challenge = message.getChallenge(); 
    Optional::t_LongOptional currency1Won = message.getCurrency1Won(); 
    Optional::t_LongOptional currency2Won = message.getCurrency2Won(); 
    Optional::t_LongOptional currency3Won = message.getCurrency3Won(); 
    Optional::t_LongOptional currency4Won = message.getCurrency4Won(); 
    Optional::t_LongOptional currency5Won = message.getCurrency5Won(); 
    Optional::t_LongOptional currency6Won = message.getCurrency6Won(); 
    GSData currencyWinnings = message.getCurrencyWinnings(); 
    Types::LeaderboardData* leaderboardData = message.getLeaderboardData(); 
    gsstl::string messageId = message.getMessageId(); 
    Optional::t_BoolOptional notification = message.getNotification(); 
    gsstl:vector<GSData> scriptData = message.getScriptData(); 
    gsstl::string subTitle = message.getSubTitle(); 
    gsstl::string summary = message.getSummary(); 
    gsstl::string title = message.getTitle(); 
    gsstl::string winnerName = message.getWinnerName(); 
    }
    ...
    GS.SetMessageListener(OnChallengeWonMessage);