Table of contents
Description
This method logs out the current user of the Gigya platform. We highly recommend calling this method when the user logs out of the hosting site.
Note that this method does not disassociate the user from the providers, it merely indicates that the user is logged out. Tthe user's site account remains associated with any connected social accounts, even when logged out. When the user logs in again, full access to all the previously connected providers is restored, i.e. the association remains.
Gigya's platform also logs the user out of Facebook, Yahoo, Google, and LinkedIn if the user was connected to these providers via Social Login.
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.logout.
Syntax
gigya.socialize.logout(params)
Method Parameters
The following table lists the params object members:
| Required | Name | Type | Description |
| Optional | 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 |
| 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. |
This method doesn't return any method specific values, only the basic response object is returned.
Triggered Global Event
By using this method the following global event is triggered: onLogout. To register an event handler use the socialize.addEventHandlers API method. Please refer to the onLogout 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 ) {
alert('User has logged out');
}
else {
alert('Error :' + response.errorMessage);
}
}
gigya.socialize.logout({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