Global Conf

Description

This object represents a site's basic Gigya configuration. This object is a JSON object that sets global Gigya variables before loading socialize.js. This allows the variables to be used when initializing socialize. The stored global configuration parameters that are set in this object are common to all the Gigya API calls on that page. If you define this object, it should be created once, using the following syntax:

<script type="text/javascript" src="http://cdn.gigya.com/js/socialize.js?apiKey=INSERT-YOUR-APIKEY-HERE">
{
  autoLogin: true,
  enabledProviders: 'facebook,twitter'
}
</script>

Note that autoLogin and enabledProviders are only examples of variables that can be set here.

Another option to set the global configuration object with a global variable, instead of the inner text of socialize.js script tag:

window.__gigyaConf = {enabledProviders:'facebook,twitter'};

Data Members

lang: "zh-hk";

Backwards Compatibility

The Global Conf described above substitutes an older form of a conf object that we still support for backward compatibility. The advantage of the new form is that the variables are set before loading socialize.js, while in the old form they are set after.
In the old form the conf object was created once as a global var and passed as the first parameter of all API calls, setting global configuration parameters. Originally all our API methods were called with two parameters, conf and params. For example:

var conf=
{
  enabledProviders:  'yahoo,google',
     connectWithoutLoginBehavior: 'alwaysLogin'
};
...

gigya.services.socialize.getUserInfo(conf, params);

If you are already using the old form of the conf object, you may keep on using it, although we encourage you to move to the new form. Please note that some parameters, such as autoLogin, cannot be set via the old form of the conf object, since they must be set before loading socialize.js.
Since we still support the conf object as a parameter in API calls, if you decide to pass the conf object to an API method, the variables set there will override any identical variables set in the global configuration object (the new form).
For example, if the new form global configuration object defines Facebook and Twitter as the enabled providers, and the conf object defines Yahoo and Google as the enabled providers, the enabled providers will be Yahoo and Google:

<script type="text/javascript" src="http://cdn.gigya.com/js/socialize.js?apiKey=INSERT-YOUR-APIKEY-HERE">
{
   enabledProviders: 'facebook,twitter'
}
</script>

<script>
var conf=
{
    enabledProviders:  'yahoo,google'
 };
</script>

The params object, that used to be the second parameter, is now passed as the only parameter (i.e. gigya.socialize.getUserInfo(params); ). The params object enfolds all the specific parameters of the API method. In the JavaScript API Reference you may find per API method the list of parameters (params object members) that the method accepts - some are required and some are optional. The variables set in the params object will override any identical variables set either in the global configuration object or the conf object if defined. 

This object represents a site's basic Gigya configuration. This object is a JSON object that sets global Gigya variables before loading socialize.js. This allows the variables to be used when initializing socialize. The stored global configuration parameters that are set in this object are common to all the Gigya API calls on that page. If you define this object, it should be created once, using the following syntax:

<script type="text/javascript" src="http://cdn.gigya.com/js/socialize.js?apiKey=INSERT-YOUR-APIKEY-HERE">
{
  autoLogin: true,
  enabledProviders: 'facebook,twitter'
}
</script>

Note that autoLogin and enabledProviders are only examples of variables that can be set here.

<script type="text/javascript" src="http://cdn.gigya.com/js/socialize.js?apiKey=INSERT-YOUR-APIKEY-HERE">
{
  autoLogin: true,
  enabledProviders: 'facebook,twitter'
}
</script>

Note that autoLogin and enabledProviders are only examples of variables that can be set here.