Gigya Job Openings

gm.resetLevelStatus JS

Skip to end of metadata
Go to start of metadata

Description

 

This method resets the isNewLevel field value to false. Gigya applies this method after informing the user of reaching a new level when using the Notifications plugin.
 

Note: If you plan on integrating the Game Mechanic platform, we highly recommend reading the Game Mechanics Guide. Game Mechanics is a premium platform that requires separate activation. If Game Mechanics is not part of your site package please contact your Gigya Customer Engagement Executive or contact us by filling in a support form on our site. You can also access the support page by clicking "Support" on the upper menu of Gigya's site.

 

Note: This method is also supported in our REST API. If you wish to execute this method from your server, please refer to

  REST API > gm.resetLevelStatus.

 

Syntax

 

 

Parameters

The following table lists the available parameters:

RequiredNameTypeDescription
challengesstringA comma-separated list of challenge IDs for which to reset the level status. By default, if this parameter is not provided, then this method will reset the default challenge (challenges:"_default"). Note: the challenge IDs should be the same as defined in the Challenges Setup page in Gigya's website. You may read about setting up challenges in the Game Mechanics guide.
callbackfunction
A reference to a callback function. Gigya calls the specified function along with the results of the API method when the API method completes.
The callback function should be defined with the following signature: functionName(Response).
The "Response Object Data Members" table below provides specification of the data that is passed to the callback function.
contextobject
A developer-created object that is passed back unchanged to the application as one of the fields in the response object.
actionAttributesJSON objectThis parameter is used to reset the isNewLevel field value according to a specific attribute, for example you can reset the isNewLevel field value only on the "Glee" page of a site, instead of the entire site. The action attribute is comprised of a single set of a key (category) and a value, e.g. {"tv-show":"glee"}. In order to use this option, you need to give action attributes to actions the user may perform on the site, such as sharing or commenting, and these action attributes will be used to filter. Read more here.

 

Response Object Data Members

FieldTypeDescription
errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Response Codes and Errors table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
callId string Unique identifier of the transaction, for debugging purposes.
context object The context object passed by the application as a parameter to the API method, or null if no context object has been passed.

 

Code Sample

var params = {
    challenges: "ChallengeA"
};

gigya.gm.resetLevelStatus(params); 

Notes:

  • This sample is not meant to be fully functional code. For brevity's sake, only the code required for demonstrating the API call itself is presented.
  • To run the code on your own domain, add your Gigya API key to the gigya.js URL. A Gigya API key can be obtained on the Site Dashboard page on Gigya's website. Please make sure that the domain from which you are loading the page is the same domain name that you used for generating the API key.
  • In some cases it is necessary to connect/login the user to a provider ? prior to calling the API method. You can learn more in the Social Login guide.