Login & User Javascript APIs

From Social ID Developers
(Difference between revisions)
Jump to: navigation, search
(→Exemplos)
 
(41 intermediate revisions by 4 users not shown)
Line 6: Line 6:
 
|-
 
|-
 
| [[socialid.login.init]]
 
| [[socialid.login.init]]
−
| Inicializa a API para ser usada por uma aplicação do social login.
+
| Initializes the API to be used by a Social Login application.
−
|-
+
−
| [[socialid.login.renderLoginWidget]]
+
−
| Renderiza o widget do Social Login dentro de um elemento do DOM.
+
 
|-
 
|-
 
| [[socialid.login.startLogin]]
 
| [[socialid.login.startLogin]]
−
| Abre o diálogo (popup) de login para um determinado provedor de login.
+
| Starts the social login process for the given provider.
 +
|-
 +
| [[socialid.login.startConnect]]
 +
| Starts the social connect process for the given provider.
 +
|-
 +
| [[socialid.login.startSession]]
 +
| Starts the process to create the user's session in the browser.
 
|-
 
|-
 
| [[socialid.login.startLoginClick]]
 
| [[socialid.login.startLoginClick]]
−
| Abre o diálogo (popup) de login para um determinado provedor de login ao se clicar em um elemento do DOM.
+
| Starts the social login process for the given provider when the user clicks on a DOM element.
 
|-
 
|-
−
| [[socialid.login.isBrowserSupported]]
+
| [[socialid.login.startConnectClick]]
−
| Verifica se o browser é suportado pela API do Social Login.
+
| Starts the social connect process for the given provider when the user clicks on a DOM element.
 +
|-
 +
| [[socialid.login.renderLoginWidget]]
 +
| Renders the Social Login widget within a DOM element.
 +
|-
 +
| [[socialid.login.renderConnectWidget]]
 +
| Renders the Social Connect widget within a DOM element.
 +
|-
 +
| [[socialid.login.disconnect]]
 +
| API to disconnect a provider from the current login session.
 +
|-
 +
| [[socialid.login.logout]]
 +
| API to logout the user (destroy the current login session).
 +
|-
 +
| [[socialid.login.logoutWithFacebook]]
 +
| API to logout the user previously logged in by the Facebook Automatic Login.
 +
|-
 +
| [[socialid.login.getUserInfo]]
 +
| API to get basic information about the user logged into the current login session.
 +
|-
 +
| [[socialid.login.getUserData]]
 +
| API to get custom profile information about the user logged into the current login session.
 +
|-
 +
| [[socialid.login.updateUserData]]
 +
| API to update custom profile information about the user logged into the current login session.
 +
|-
 +
| [[socialid.login.loginConnection]]
 +
| API to automatically log in a user given its connection_id.
 +
|-
 +
| [[socialid.login.loginUserToken]]
 +
| API to automatically log in a user given its user_token.
 +
|-
 +
| [[socialid.login.loginCredentials]]
 +
| API to automatically log in a user given its social networks credentials.
 +
|-
 +
| [[socialid.login.moveTo]]
 +
| API to move data from the user logged into the current login session to another user and then removes it.
 +
|-
 +
| [[socialid.login.automaticFacebookLogin]]
 +
| Automatically logs a user in using the Facebook Javascript SDK.
 +
|-
 +
| [[socialid.login.clusteringFeatures]]
 +
| API to get user clustering features.
 +
|-
 +
| [[socialid.login.deleteMacAddress]]
 +
| API to delete a MAC Address from a user.
 +
|-
 +
| [[socialid.login.getConnectionStatus]]
 +
| API to get current connection_id.
 +
|-
 +
| [[socialid.login.extendCredentials]]
 +
| API to extend a short lived token for a long lived one.
 +
|-
 +
| [[socialid.login.extendFacebookToken]]
 +
| API to automatically get and extend a Facebook token using the Facebook Javascript SDK.
 
|}
 
|}
  
Line 28: Line 85:
 
|-
 
|-
 
| [[socialid.events.onLoginSuccess]]
 
| [[socialid.events.onLoginSuccess]]
−
| Executado quando o usuário finaliza o processo de login com sucesso.
+
| Triggered when the user completes the login process successfully.
 
|-
 
|-
 
| [[socialid.events.onLoginCancel]]
 
| [[socialid.events.onLoginCancel]]
−
| Executado quando o usuário cancela o processo de login (não autoriza o login social).
+
| Triggered when the user cancels the login process (does not authorizes the social login).
 
|-
 
|-
 
| [[socialid.events.onLoginError]]
 
| [[socialid.events.onLoginError]]
−
| Executado quando algum erro acontece durante o processo de login.
+
| Triggered when an error occurs during the login process.
 
|-
 
|-
 
| [[socialid.events.onLoginStart]]
 
| [[socialid.events.onLoginStart]]
−
| Executado quando o usuário inicia o processo de login.
+
| Triggered when the user starts the login process.
 +
|-
 +
| [[socialid.events.onConnectSuccess]]
 +
| Triggered when the user completes the connection of a new provider credential successfully.
 +
|-
 +
| [[socialid.events.onConnectCancel]]
 +
| Triggered when the user cancels the connection of a new provider credential (does not authorizes the social login).
 +
|-
 +
| [[socialid.events.onConnectError]]
 +
| Triggered when an error occurs during the connection of a new provider credential.
 +
|-
 +
| [[socialid.events.onConnectStart]]
 +
| Triggered when the user starts the connection of a new provider credential.
 +
|-
 +
| [[socialid.events.onDisconnectSuccess]]
 +
| Triggered when the user disconnects some provider successfully.
 +
|-
 +
| [[socialid.events.onDisconnectError]]
 +
| Triggered when an error occurs during the disconnection of some provider.
 +
|-
 +
| [[socialid.events.onLogout]]
 +
| Triggered when the user logs out.
 +
|-
 +
| [[socialid.events.onDialogOpen]]
 +
| Triggered when the login or connect pop up is opened.
 +
|-
 +
| [[socialid.events.onDialogClose]]
 +
| Triggered when the login or connect pop up is closed.
 +
|-
 +
| [[socialid.events.onSessionSuccess]]
 +
| Triggered when the user completes the session creation process successfully.
 +
|-
 +
| [[socialid.events.onSessionError]]
 +
| Triggered when an error occurs during the session creation process.
 
|}
 
|}
  
−
== Exemplos ==
+
== Examples ==
  
−
* [[Social Login Javascript API Complete Code|Exemplo de código completo]]
+
* [[Social Login Javascript API Complete Code]]
−
* Aplicação de exemplo: https://sid-examples.herokuapp.com/social_logins/new
+
* [[Social Connect Javascript API Complete Code]]
−
* Playground da API Javascript do Social Login: https://sid-examples.herokuapp.com/social_logins/playground
+
* Example Application: https://sid-examples.herokuapp.com/social_logins
 +
* Javascript API Playground: https://sid-examples.herokuapp.com/social_logins/playground

Latest revision as of 22:23, 2 June 2020

APIs

Resource Description
socialid.login.init Initializes the API to be used by a Social Login application.
socialid.login.startLogin Starts the social login process for the given provider.
socialid.login.startConnect Starts the social connect process for the given provider.
socialid.login.startSession Starts the process to create the user's session in the browser.
socialid.login.startLoginClick Starts the social login process for the given provider when the user clicks on a DOM element.
socialid.login.startConnectClick Starts the social connect process for the given provider when the user clicks on a DOM element.
socialid.login.renderLoginWidget Renders the Social Login widget within a DOM element.
socialid.login.renderConnectWidget Renders the Social Connect widget within a DOM element.
socialid.login.disconnect API to disconnect a provider from the current login session.
socialid.login.logout API to logout the user (destroy the current login session).
socialid.login.logoutWithFacebook API to logout the user previously logged in by the Facebook Automatic Login.
socialid.login.getUserInfo API to get basic information about the user logged into the current login session.
socialid.login.getUserData API to get custom profile information about the user logged into the current login session.
socialid.login.updateUserData API to update custom profile information about the user logged into the current login session.
socialid.login.loginConnection API to automatically log in a user given its connection_id.
socialid.login.loginUserToken API to automatically log in a user given its user_token.
socialid.login.loginCredentials API to automatically log in a user given its social networks credentials.
socialid.login.moveTo API to move data from the user logged into the current login session to another user and then removes it.
socialid.login.automaticFacebookLogin Automatically logs a user in using the Facebook Javascript SDK.
socialid.login.clusteringFeatures API to get user clustering features.
socialid.login.deleteMacAddress API to delete a MAC Address from a user.
socialid.login.getConnectionStatus API to get current connection_id.
socialid.login.extendCredentials API to extend a short lived token for a long lived one.
socialid.login.extendFacebookToken API to automatically get and extend a Facebook token using the Facebook Javascript SDK.

Events

Event Description
socialid.events.onLoginSuccess Triggered when the user completes the login process successfully.
socialid.events.onLoginCancel Triggered when the user cancels the login process (does not authorizes the social login).
socialid.events.onLoginError Triggered when an error occurs during the login process.
socialid.events.onLoginStart Triggered when the user starts the login process.
socialid.events.onConnectSuccess Triggered when the user completes the connection of a new provider credential successfully.
socialid.events.onConnectCancel Triggered when the user cancels the connection of a new provider credential (does not authorizes the social login).
socialid.events.onConnectError Triggered when an error occurs during the connection of a new provider credential.
socialid.events.onConnectStart Triggered when the user starts the connection of a new provider credential.
socialid.events.onDisconnectSuccess Triggered when the user disconnects some provider successfully.
socialid.events.onDisconnectError Triggered when an error occurs during the disconnection of some provider.
socialid.events.onLogout Triggered when the user logs out.
socialid.events.onDialogOpen Triggered when the login or connect pop up is opened.
socialid.events.onDialogClose Triggered when the login or connect pop up is closed.
socialid.events.onSessionSuccess Triggered when the user completes the session creation process successfully.
socialid.events.onSessionError Triggered when an error occurs during the session creation process.

Examples

Retrieved from "https://dev.socialidnow.com/index.php?title=Login_%26_User_Javascript_APIs&oldid=3048"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox