DeclineChallengeRequest

Declines a challenge that has been issued to the current player.

View interactive version here

Request Parameters

Response Parameters

A response containing the challenge instance id of the challenge that was declined

Nested types

ScriptData

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

Error Codes

Code Samples

C#

    using GameSparks.Api;
    using GameSparks.Api.Requests;
    using GameSparks.Api.Responses;
    ...
    new DeclineChallengeRequest()
        .SetChallengeInstanceId(challengeInstanceId)
        .SetMessage(message)
        .Send((response) => {
        string challengeInstanceId = response.ChallengeInstanceId;
        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()
        .createDeclineChallengeRequest()
        .setChallengeInstanceId(challengeInstanceId)
        .setMessage(message)
        .send(function(response:com.gamesparks.api.responses.DeclineChallengeResponse):void {
        var challengeInstanceId:String = response.getChallengeInstanceId(); 
        var scriptData:ScriptData = response.getScriptData(); 
        });

Objective-C

    #import "GS.h"
    #import "GSAPI.h"
    ...
    GSDeclineChallengeRequest* request = [[GSDeclineChallengeRequest alloc] init];
    [request setChallengeInstanceId:challengeInstanceId;
    [request setMessage:message;
    [request setCallback:^ (GSDeclineChallengeResponse* response) {
    NSString* challengeInstanceId = [response getChallengeInstanceId]; 
    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 DeclineChallengeRequest_Response(GS& gsInstance, const DeclineChallengeResponse& response) {
    gsstl::string challengeInstanceId = response.getChallengeInstanceId(); 
    GSData scriptData = response.getScriptData(); 
    }
    ......

    DeclineChallengeRequest request(gsInstance);
    request.SetChallengeInstanceId(challengeInstanceId)
    request.SetMessage(message)
    request.Send(DeclineChallengeRequest_Response);

Java

import com.gamesparks.sdk.api.autogen.GSRequestBuilder.DeclineChallengeRequest;
import com.gamesparks.sdk.api.autogen.GSResponseBuilder.DeclineChallengeResponse;
import com.gamesparks.sdk.api.autogen.GSTypes.*;
import com.gamesparks.sdk.api.GSEventListener;

...
gs.getRequestBuilder().createDeclineChallengeRequest()
    .setChallengeInstanceId(challengeInstanceId)
    .setMessage(message)
    .send(new GSEventListener<DeclineChallengeResponse>() {
        @Override
        public void onEvent(DeclineChallengeResponse response) {
            String challengeInstanceId = response.getChallengeInstanceId(); 
        }
    });

Cloud Code

    var request = new SparkRequests.DeclineChallengeRequest();
    request.challengeInstanceId = ...;
    request.message = ...;
    var response = request.Send();

var challengeInstanceId = response.challengeInstanceId; 
var scriptData = response.scriptData;