Last modified 14:18, 7 Jan 2015


Utility method for storing the current user's settings in Gigya's database. User settings are also generated when using Automatic Sharing. 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.setUserSettings.





Method Parameters

The following table lists the params object members:

Required Name Type Description
Required settings JSON object

A JSON object containing share-settings for the current user.
Settings are stored as an object of key-value pairs, where the keys are autoShareActionIDs and the values are objects. for example:
{"Like": {"alwaysShare": true, "neverShare": false, "providers": "yahoo"}, "Comment":{"alwaysShare":false, "neverShare": true} }
autoShareActionID possible values are:

  • Like
  • Comment
  • Rate
  • Reply
  • Publish

Value objects accept parameters:

  • alwaysShare (boolean)
  • neverShare (boolean)
  • providers (string of provider names, separated by a ',')
Optional group string The group identifier for which to set the settings. If not specified the section is assumed to be empty.
User settings have group classification. The group ID identifies a set of settings as related to each other. By default the group identifier is empty. For the "always/never share" settings we have defined the following group identifier: 'gigyaShareSettings'.
  callback function 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.
  cid string 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.
  context object 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

Field Type Description
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 Error Codes table.
errorMessage string A short textual description of an error associated with the errorCode for logging purposes.
operation string The name of the API method that generated this response.
context object The context object passed by the application as parameter to the API method, or null if no context object has been passed.


Code Sample

var params = { 
    settings: {'rating': {actionID: 'rating', neverShare: true}, 
                   'commenting': {actionID: 'commenting', alwaysShare: true, providers:"facebook"} },
    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 socialize.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.

Page statistics
473 view(s) and 2 edit(s)
Social share
Share this page?


This page has no custom tags.
This page has no classifications.


You must to post a comment.