Utility method for deleting a user's settings in 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 toREST API > socialize.delUserSettings.
The following table lists the available parameters:
|||group||string||The group identifier for which to delete the settings. If not specified the method will delete settings that were set without group specification.|
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'.
|||settings||string||A comma-separated list of settings to delete for the current user. If not specified the method will delete 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.
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