Description
This object represents a site's basic Gigya Socialize configuration.
This object is used for storing global configuration parameters, which are common to all the Gigya API calls and are expected to remain static for the lifetime of the application. The configuration object is passed as the first parameter of every API method.
Data Members
| Required | Field Name | Type | Description |
Required
| APIKey | string | The application key associated with the calling application. An API Key may be obtained from the Site Setup page on Gigya's web-site. |
| Optional | enabledProviders | string | A comma delimited list of provider names to include in Gigya Socialize. This parameter gives the possibility to apply this method to only a subset of providers of your choice. If you do not set this parameter, by default, all the providers are enabled (i.e. the method applies to all connected provides). Valid provider names include: facebook, myspace, twitter, yahoo, linkedin, google, aol, wordpress, bloggerid, typepad, livejournal, hyves, verisignid.
For example, if you would like the API methods to apply only to Facebook and Twitter, define: enabledProviders="facebook,twitter". |
| | disabledProviders | string | A comma delimited list of provider names to disable in Gigya Socialize. This parameter gives the possibility to specify provides that you don't want this method to apply to. If you do not set this parameter, by default, no provider is disabled (i.e. the method applies to all connected provides).Valid provider names include: facebook, myspace, twitter, yahoo, linkedin, google, aol, wordpress, bloggerid, typepad, livejournal, hyves, verisignid.
For example, if you would like the method to apply to all providers except Google and Twitter, define: disabledProviders="google,twitter". |
| | signIDs | boolean | The default value is "false". If setting this field to "true", all User object and Friend objects returned by the API methods will be signed by Gigya. To learn more about this subject, please refer to the Cryptographic Signatures section in the Security page of the Developer's Guide. |
| | UIConfig | string | An XML string defining changes to the default design of the Socialize widgets UI.
For example: UIConfig:"<config><body><texts color=\"#00006D\"></texts><background background-color=\"#CACACA\" frame-color=\"#2424FF\"></background></body></config>"; |
| | cid | string | A string of maximum 100 characters length. This string will be associated with each transaction and will later appear on 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. The "Context ID" combo box lets you filter the report data by site/application context. |
| | shortURLs | string | Using this parameter you may determine whether to use Gigya's URL shortening service for URLs, which you publish to social networks using Gigay's API. The optional values for this parameter are: - 'always' (default): always shorten URLs.
- 'whenRequired': shorten URLs when needed - when posting to Twitter, LinkedIn, MySpace and Yahoo where the status update is limited to 140 char.
- 'never' - never shorten URLs.
When Gigya's URL shortening service is active, Gigya tracks all the traffic coming from the distributed URLs. In such case, 'Referred Traffic' reports will be available to you. |
| | lang | string | Define the language of Gigya's user interface, error message and Social Network prompted UI. The supported languages are:
| Language | Parameter Value | | English | "en" (default) | | Chinese | "zh-cn" | | Chinese (Hong Kong) | "zh-hk" | | Chinese (Taiwan) | "zh-tw' | | Czech | "cs" | | Danish | "da" | | Dutch | "nl" | | Finnish | "fi" | | French | "fr" | | German | "de" | | Greek | "el" | | Hungarian | "hu" | | Italian | "it" | | Japanese | "ja" | | Korean | "ko" | | Norwegian | "no" | | Polish | "pl" | | Portuguese | "pt" | | Portuguese (Brazil) | "pt-br" | | Russian | "ru" | | Spanish | "es" | | Spanish (Mexican) | "es-mx" | | Swedish | "sv" | | Tagalog (Philippines) | "tl" |
For example: lang: "zh-hk"; |
The following member is required only in the ActionScript3 environment (in the JavaScript environment it is not defined):
| Required | mcRoot | DisplayObject | This parameter should refer to the root of your flash container. |
