CotcSdk.GameBatches Class Reference

Description

Allows to run batches authenticated as a game (that is, unauthenticated).

Public Member Functions
GameBatches	Domain (string domain)
	Changes the domain affected by the next operations. You should typically use it this way: gamer.Batches.Domain("private").Run(...); More...
Promise< Bundle >	Run (string batchName, Bundle batchParams=null)
	Runs a batch on the server, unauthenticated (game-scoped). More...

Member Function Documentation

Domain()

GameBatches CotcSdk.GameBatches.Domain

(

string

domain

)

Changes the domain affected by the next operations. You should typically use it this way: gamer.Batches.Domain("private").Run(...);

Parameters

domain

Domain on which to scope the next operations.

Returns

This object for operation chaining.

Run()

Promise<Bundle> CotcSdk.GameBatches.Run	(	string	batchName,
		Bundle	batchParams = null
	)

Runs a batch on the server, unauthenticated (game-scoped).

Returns

Promise resolved when the request has finished. The attached bundle is the JSON data returned by the match.

Parameters

batchName	Name of the batch to run, as configured on the server.
batchParams	Parameters to be passed to the batch.