Socialid.login.getUserInfo
(Difference between revisions)
Renato.neves (Talk | contribs) |
Renato.neves (Talk | contribs) |
||
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
| − | + | API to get basic information about the user logged in the current login session. | |
== Usage == | == Usage == | ||
| Line 11: | Line 11: | ||
{| | {| | ||
! 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 19: | ||
{| | {| | ||
! align="left" width="200px" | data | ! align="left" width="200px" | data | ||
| − | | | + | | Javascript object containing data from the user logged in. The object properties are: name, email, location, facebook, twitter, linkedin and gplus. The properties facebook, twitter, linkedin and gplus will be available only for the providers connected by the user. |
|+ | |+ | ||
! align="left" width="200px" | status | ! align="left" width="200px" | status | ||
| − | | | + | | The API response status. It could be "success", if there is an user logged in the current login session and its data was successfully retrieved, or "not_found", if there is no user logged in the current login session. |
|} | |} | ||
== Example == | == Example == | ||
| − | + | Get basic information about the user logged in 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("Welcome " + data.name); |
} else { | } else { | ||
| − | alert(" | + | alert("Could not get info from the current logged in user."); |
} | } | ||
} | } | ||
socialid.login.getUserInfo(handler); | socialid.login.getUserInfo(handler); | ||
| − | + | Example of "data" object: | |
data = { | data = { | ||
| Line 63: | Line 63: | ||
} | } | ||
| − | + | You can test this parameters in our playground: https://sid-examples.herokuapp.com/social_logins/playground | |
Revision as of 18:19, 3 November 2014
Contents |
Description
API to get basic information about the user logged in the current login session.
Usage
socialid.login.getUserInfo(handler)
Parameters
| handler | optional | Callback function to handle the API response. |
|---|
API Response
| data | Javascript object containing data from the user logged in. The object properties are: name, email, location, facebook, twitter, linkedin and gplus. The properties facebook, twitter, linkedin and gplus will be available only for the providers connected by the user. | status | The API response status. It could be "success", if there is an user logged in the current login session and its data was successfully retrieved, or "not_found", if there is no user logged in the current login session. |
|---|
Example
Get basic information about the user logged in the current login session:
socialid.login.init(1);
var handler = function(response) {
if (response.status == "success") {
alert("Welcome " + data.name);
} else {
alert("Could not get info from the current logged in user.");
}
}
socialid.login.getUserInfo(handler);
Example of "data" object:
data = {
name: "John Doe",
email: "johndoe@example.com",
location: "New York",
facebook: {
picture_url: "http://www.facebook.com/johndoe.jpg",
profile_url: "http://www.facebook.com/johndoe"
},
twitter: {
picture_url: "http://www.twitter.com/johndoe.jpg",
profile_url: "http://www.twitter.com/johndoe"
},
linkedin: {
picture_url: "http://www.linkedin.com/johndoe.jpg",
profile_url: "http://www.linkedin.com/johndoe"
},
gplus: {
picture_url: "http://plus.google.com/johndoe.jpg",
profile_url: "http://plus.google.com/johndoe"
}
}
You can test this parameters in our playground: https://sid-examples.herokuapp.com/social_logins/playground
