Gigya Job Openings

socialize.getUserSettings JS

Skip to end of metadata
Go to start of metadata



A utility method for retrieving a user's settings from Gigya's database. User's settings are generated automatically by Gigya when using Automatic Sharing. In addition you may store settings in Gigya's database using the socialize.setUserSettings method. To learn more, please refer to the Accessing User Settings in Gigya's Database guide.

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 > socialize.getUserSettings.






The following table lists the available parameters:

groupstringThe section identifier for which to retrieve the settings. If not specified the method returns settings that were set without group specification.
settingsstringA comma-separated list of settings to fetch for the current user. If not specified the method returns all the user settings for the specified group. For example: "alwaysAllow, neverAsk"
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.
A string of maximum 100 characters length. The CID sets categories for transactions that can be used later for filtering reports generated by Gigya in the "Context ID" combo box. The CID allows you to associate the report information with your own internal data. For example, to identify a specific widget or page on your site/application. You should not define more than 100 different context IDs.

Note: This parameter overrides the value of the identical parameter in Global Conf (the global configuration object). If the parameter is not set for the method, the value from Global Conf is used.

A developer-created object that is passed back unchanged to the application as one of the fields in the response object.



Response Object Data Members

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.
settings JSON objectA JSON object containing [name: value] pairs of the settings retrieved for the current user. For example: { 'alwaysAllow':0, 'neverAsk':'yes' }

Code Sample

function printResponse(response) {  
    if ( response.errorCode == 0 ) { 
        alert("The current user's settings are: " + response.settings['rating'] + ";" + response.settings['commenting']); 
    else {
        alert('Error :' + response.errorMessage);

var params = { 
    callback: printResponse,
    settings: "rating, commenting",
    group: 'gigyaShareSettings'



  • 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.