Table of contents
Description
Disconnects the current user from one or all of the connected providers. Disconnection from a provider means that the session with the provider closes. Removing connection also disassociates (unlinks) the social identity from the user, unless this is the user's only login identity. For the following providers removeConnection will also logout the user from the social network: Facebook, Yahoo, Google+, and LinkedIn.
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.removeConnection.
Supporting Providers
This operation currently supported by the following providers: Facebook, Twitter, Yahoo, Microsoft Messenger, Google, Google+, LinkedIn, Myspace, AOL, FourSquare, Orkut, Renren, Tencent QQ, Sina Weibo, Kaixin, Vkontakte, WordPress, Blogger, Typepad, Paypal, liveJournal, Hyves, VeriSign, OpenID, Netlog, Signon, Orange France, mixi, Yahoo Japan, Spiceworks, Livedoor, Skyrock, VZnet.
Syntax
gigya.socialize.removeConnection(params)
Method Parameters
The following table lists the params object members:
| Required | Name | Type | Description |
| Optional | provider | string | The provider from which to disconnect. The optional values for this parameter are: 'facebook', 'twitter', 'yahoo', 'messenger', 'linkedin', 'myspace', 'orkut', 'googleplus', 'foursquare', 'renren', 'vkontakte', 'mixi'. If this parameter is not set, then the user will be disconnected from all the providers. |
| 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. This string is 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. Note: the value of this parameter overrides the value of the identical parameter in the global configuration object. | |
| forceProvidersLogout | Boolean | If this parameter is set to 'true' (default), Gigya logs out the user from all the providers to which he is connected and which support this feature. If this parameter is set to 'false', connected providers remain connected after logging out from the Gigya platform. In order to force logout from Facebook, you have to configure a Domain Alias (CNAME) for your site and enable automatic session renewal in our site's Settings page in the Facebook Configuration dialog. | |
| 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 |
| user | User object | A User object with updated information for the current user. |
Global Event Triggered
By using this method, the following global event is triggered: onConnectionRemoved . To register an event handler use the socialize.addEventHandlers API method. Please refer to the onConnectionRemoved event data. Refer to the Events page in the Developer Guide - to learn more about how to handle events generated by the Gigya service.
Code Sample
function printResponse(response) {
if ( response.errorCode == 0 ) {
var user = response.user;
var msg = 'User '+user.nickname + ' has been disconnected';
alert(msg);
}
else {
alert('Error :' + response.errorMessage);
}
}
// Remove Connection from one specific provider, for example Facebook:
gigya.socialize.removeConnection({callback:printResponse, provider:'facebook'});
// Disconnect from all providers:
gigya.socialize.removeConnection({callback:printResponse}); - 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.
Comments