Socialid.login.logout
From Social ID Developers
(Difference between revisions)
Renato.neves (Talk | contribs) (Created page with "== Description == Chama a API para deslogar o usuário atualmente logado no Social Login. == Usage == socialid.login.logout(handler) == Parameters == {| ! align="left" ...") |
Ivan.filho (Talk | contribs) (→Description) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
| − | + | API to logout the user (destroy the current login session). | |
| + | |||
| + | In case of success this API will also trigger the removal from where the Connection ID value is stored. See [[socialid.connectionStorage]]. | ||
== Usage == | == Usage == | ||
| Line 11: | Line 13: | ||
{| | {| | ||
! align="left" width="200px" | handler | ! align="left" width="200px" | handler | ||
| − | | width="200px" | | + | | width="200px" | optional |
| − | | | + | | Callback function to handle the API response. |
|} | |} | ||
| Line 19: | Line 21: | ||
{| | {| | ||
! align="left" width="200px" | data | ! align="left" width="200px" | data | ||
| − | | | + | | Always "null". This API does not return data. |
|+ | |+ | ||
! align="left" width="200px" | status | ! align="left" width="200px" | status | ||
| − | | | + | | The API response status. Can be '''success''', if the user has been logged out successfully, or '''not_found''', if there is no user logged in the current login session. |
|} | |} | ||
== Example == | == Example == | ||
| − | + | Logout the user from the current login session: | |
socialid.login.init(1); | socialid.login.init(1); | ||
var handler = function(response) { | var handler = function(response) { | ||
if (response.status == "success") { | if (response.status == "success") { | ||
| − | alert(" | + | alert("You have been logged out successfully!"); |
} else { | } else { | ||
| − | alert(" | + | alert("Could not log out."); |
} | } | ||
} | } | ||
socialid.login.logout(handler); | socialid.login.logout(handler); | ||
| − | + | You can test this parameters in our playground: https://sid-examples.herokuapp.com/social_logins/playground | |
Latest revision as of 19:48, 11 November 2020
Contents |
Description
API to logout the user (destroy the current login session).
In case of success this API will also trigger the removal from where the Connection ID value is stored. See socialid.connectionStorage.
Usage
socialid.login.logout(handler)
Parameters
| handler | optional | Callback function to handle the API response. |
|---|
API Response
| data | Always "null". This API does not return data. | status | The API response status. Can be success, if the user has been logged out successfully, or not_found, if there is no user logged in the current login session. |
|---|
Example
Logout the user from the current login session:
socialid.login.init(1);
var handler = function(response) {
if (response.status == "success") {
alert("You have been logged out successfully!");
} else {
alert("Could not log out.");
}
}
socialid.login.logout(handler);
You can test this parameters in our playground: https://sid-examples.herokuapp.com/social_logins/playground
