Socialid.login.getUserInfo
(Difference between revisions)
Renato.neves (Talk | contribs) |
Renato.neves (Talk | contribs) (→API Response) |
||
Line 22: | Line 22: | ||
|+ | |+ | ||
! align="left" width="200px" | status | ! align="left" width="200px" | status | ||
− | | The API response status. | + | | The API response status. Can 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. |
|} | |} | ||
Revision as of 13:14, 4 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. Can 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