Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ILocalUser.Authenticate

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public function Authenticate(callback: Action<bool>): void;
public void Authenticate(Action<bool> callback);
public function Authenticate(callback: Action<bool,string>): void;
public void Authenticate(Action<bool,string> callback);

Parameters

callback Callback that is called whenever the authentication operation is finished. The first parameter is a Boolean identifying whether the authentication operation was successful. The optional second argument contains a string identifying any errors (if available) if the operation was unsuccessful.

Description

Authenticate the local user to the current active Social API implementation and fetch their profile data.

This should be done before any other calls into the API. Depending on the platform, this might trigger a potentially blocking dialog for providing login details.

On certain platforms (including but not limited to iOS and tvOS), the callback is only invoked on the first call to Authenticate(). Subsequent calls to Authenticate() on such platforms results in no callback being triggered. This can occur if, for example, the user or the OS cancels the authentication operation before it has completed. Please ensure you test for this situation.

#pragma strict
public class Example extends MonoBehaviour {
	function Start() {
		Social.localUser.Authenticate(function(success) {
			if (success) {
				Debug.Log("Authentication successful");
				var userInfo: String = "Username: " + Social.localUser.userName + "\nUser ID: " + Social.localUser.id + "\nIsUnderage: " + Social.localUser.underage;
				Debug.Log(userInfo);
			}
			else
				Debug.Log("Authentication failed");
		}
		);
	}
}
using UnityEngine;
using UnityEngine.SocialPlatforms;
using System.Collections;

public class Example : MonoBehaviour { void Start() { Social.localUser.Authenticate (success => { if (success) { Debug.Log ("Authentication successful"); string userInfo = "Username: " + Social.localUser.userName + "\nUser ID: " + Social.localUser.id + "\nIsUnderage: " + Social.localUser.underage; Debug.Log (userInfo); } else Debug.Log ("Authentication failed"); }); } }