ConsumeVirtualGoodRequest

Consumes a given amount of the specified virtual good.

View interactive version here

Request Parameters

Response Parameters

A response to a consume virtual goods response

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 ConsumeVirtualGoodRequest()
        .SetQuantity(quantity)
        .SetShortCode(shortCode)
        .Send((response) => {
        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()
        .createConsumeVirtualGoodRequest()
        .setQuantity(quantity)
        .setShortCode(shortCode)
        .send(function(response:com.gamesparks.api.responses.ConsumeVirtualGoodResponse):void {
        var scriptData:ScriptData = response.getScriptData(); 
        });

Objective-C

    #import "GS.h"
    #import "GSAPI.h"
    ...
    GSConsumeVirtualGoodRequest* request = [[GSConsumeVirtualGoodRequest alloc] init];
    [request setQuantity:quantity;
    [request setShortCode:shortCode;
    [request setCallback:^ (GSConsumeVirtualGoodResponse* response) {
    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 ConsumeVirtualGoodRequest_Response(GS& gsInstance, const ConsumeVirtualGoodResponse& response) {
    GSData scriptData = response.getScriptData(); 
    }
    ......

    ConsumeVirtualGoodRequest request(gsInstance);
    request.SetQuantity(quantity)
    request.SetShortCode(shortCode)
    request.Send(ConsumeVirtualGoodRequest_Response);

Java

import com.gamesparks.sdk.api.autogen.GSRequestBuilder.ConsumeVirtualGoodRequest;
import com.gamesparks.sdk.api.autogen.GSResponseBuilder.ConsumeVirtualGoodResponse;
import com.gamesparks.sdk.api.autogen.GSTypes.*;
import com.gamesparks.sdk.api.GSEventListener;

...
gs.getRequestBuilder().createConsumeVirtualGoodRequest()
    .setQuantity(quantity)
    .setShortCode(shortCode)
    .send(new GSEventListener<ConsumeVirtualGoodResponse>() {
        @Override
        public void onEvent(ConsumeVirtualGoodResponse response) {
        }
    });

Cloud Code

    var request = new SparkRequests.ConsumeVirtualGoodRequest();
    request.quantity = ...;
    request.shortCode = ...;
    var response = request.Send();

var scriptData = response.scriptData;