ListChallengeRequest

Returns a list of challenges in the state defined in the 'state' field.

The response can be further filtered by passing a shortCode field which will limit the returned lists to challenges of that short code.

Valid states are:

WAITING : The challenge has been issued and accepted and is waiting for the start date.

RUNNING : The challenge is active.

ISSUED : The challenge has been issued by the current player and is waiting to be accepted.

RECEIVED : The challenge has been issued to the current player and is waiting to be accepted.

COMPLETE : The challenge has completed.

DECLINED : The challenge has been issued by the current player and has been declined.

View interactive version here

Request Parameters

Response Parameters

A response containing challenges that are in the state that was specified in the request

Nested types

PlayerDetail

An object representing a player's id and name

Challenge

A nested object that represents the challenge data.

ScriptData

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

PlayerTurnCount

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

Code Samples

C#

    using GameSparks.Api;
    using GameSparks.Api.Requests;
    using GameSparks.Api.Responses;
    ...
    new ListChallengeRequest()
        .SetEntryCount(entryCount)
        .SetOffset(offset)
        .SetShortCode(shortCode)
        .SetState(state)
        .SetStates(states)
        .Send((response) => {
        GSEnumerable<var> challengeInstances = response.ChallengeInstances; 
        GSData scriptData = response.ScriptData; 
        });

ActionScript 3

    import com.gamesparks.*;
    import com.gamesparks.api.requests.*;
    import com.gamesparks.api.responses.*;
    import com.gamesparks.api.types.*;
    ...

    gs.getRequestBuilder()
        .createListChallengeRequest()
        .setEntryCount(entryCount)
        .setOffset(offset)
        .setShortCode(shortCode)
        .setState(state)
        .setStates(states)
        .send(function(response:com.gamesparks.api.responses.ListChallengeResponse):void {
        var challengeInstances:Vector.<Challenge> = response.getChallengeInstances(); 
        var scriptData:ScriptData = response.getScriptData(); 
        });

Objective-C

    #import "GS.h"
    #import "GSAPI.h"
    ...
    GSListChallengeRequest* request = [[GSListChallengeRequest alloc] init];
    [request setEntryCount:entryCount;
    [request setOffset:offset;
    [request setShortCode:shortCode;
    [request setState:state;
    [request setStates:states;
    [request setCallback:^ (GSListChallengeResponse* response) {
    NSArray* challengeInstances = [response getChallengeInstances]; 
    NSDictionary* scriptData = [response getScriptData]; 
    }];
    [gs send:request];

C++

    #include <GameSparks/generated/GSRequests.h>
    using namespace GameSparks::Core;
    using namespace GameSparks::Api::Responses;
    using namespace GameSparks::Api::Requests;
    ...

    void ListChallengeRequest_Response(GS& gsInstance, const ListChallengeResponse& response) {
    gsstl:vector<Types::Challenge*> challengeInstances = response.getChallengeInstances(); 
    GSData scriptData = response.getScriptData(); 
    }
    ......

    ListChallengeRequest request(gsInstance);
    request.SetEntryCount(entryCount)
    request.SetOffset(offset)
    request.SetShortCode(shortCode)
    request.SetState(state)
    request.SetStates(states)
    request.Send(ListChallengeRequest_Response);

Java

import com.gamesparks.sdk.api.autogen.GSRequestBuilder.ListChallengeRequest;
import com.gamesparks.sdk.api.autogen.GSResponseBuilder.ListChallengeResponse;
import com.gamesparks.sdk.api.autogen.GSTypes.*;
import com.gamesparks.sdk.api.GSEventListener;

...
gs.getRequestBuilder().createListChallengeRequest()
    .setEntryCount(entryCount)
    .setOffset(offset)
    .setShortCode(shortCode)
    .setState(state)
    .setStates(states)
    .send(new GSEventListener<ListChallengeResponse>() {
        @Override
        public void onEvent(ListChallengeResponse response) {
            List<Challenge> challengeInstances = response.getChallengeInstances(); 
            GSData scriptData = response.getScriptData(); 
        }
    });

Cloud Code

    var request = new SparkRequests.ListChallengeRequest();
    request.entryCount = ...;
    request.offset = ...;
    request.shortCode = ...;
    request.state = ...;
    request.states = ...;
    var response = request.Send();

var challengeInstances = response.challengeInstances; 
var scriptData = response.scriptData;